Skip to content

Commit 69fe174

Browse files
author
hideya
committed
Minor updates to README.me
1 parent 60e8cc1 commit 69fe174

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

README.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,23 @@
1-
# Simple CLI MCP Client to Explore MCP Servers [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/hideya/mcp-langchain-client-ts/blob/main/LICENSE) [![npm version](https://img.shields.io/npm/v/@h1deya/mcp-try-cli.svg)](https://www.npmjs.com/package/@h1deya/mcp-try-cli)
1+
# Simple CLI MCP Client to Explore MCP Servers / TypeScript [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/hideya/mcp-langchain-client-ts/blob/main/LICENSE) [![npm version](https://img.shields.io/npm/v/@h1deya/mcp-try-cli.svg)](https://www.npmjs.com/package/@h1deya/mcp-try-cli)
22

33

44
**Quickly test and explore MCP servers from the command line!**
55

66
A simple, text-based CLI client for [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) servers built with LangChain and TypeScript.
77
Suitable for testing MCP servers, exploring their capabilities, and prototyping integrations.
88

9+
Internally it uses [LangChain ReAct Agent](https://github.com/langchain-ai/react-agent-js) and
10+
a utility function `convertMcpToLangchainTools()` from [`@h1deya/langchain-mcp-tools`](https://www.npmjs.com/package/@h1deya/langchain-mcp-tools).
11+
912
## Prerequisites
1013

1114
- Node.js 18+
1215
- [optional] [`uv` (`uvx`)](https://docs.astral.sh/uv/getting-started/installation/)
1316
installed to run Python-based local (stdio) MCP servers
14-
- API keys from [Anthropic](https://console.anthropic.com/settings/keys),
15-
[OpenAI](https://platform.openai.com/api-keys), and/or
17+
- LLM API keys from
18+
[OpenAI](https://platform.openai.com/api-keys),
19+
[Anthropic](https://console.anthropic.com/settings/keys),
20+
and/or
1621
[Google GenAI](https://aistudio.google.com/apikey)
1722
as needed
1823

@@ -74,17 +79,24 @@ Suitable for testing MCP servers, exploring their capabilities, and prototyping
7479

7580
## Building from Source
7681

77-
See [README_DEV.md](https://github.com/hideya/mcp-client-langchain-ts/blob/main/README_DEV.md)
82+
See [README_DEV.md](https://github.com/hideya/mcp-client-langchain-ts/blob/main/README_DEV.md) for details.
7883

7984
## Features
8085

8186
- **Easy setup**: Works out of the box with popular MCP servers
8287
- **Flexible configuration**: JSON5 config with environment variable support
83-
- **Multiple LLM providers**: OpenAI, Anthropic, Google Gemini
88+
- **Multiple LLM providers**: OpenAI, Anthropic, Google (GenAI)
8489
- **Command & URL servers**: Support for both local and remote MCP servers
8590
- **Real-time logging**: Live stdio MCP server logs with customizable log directory
8691
- **Interactive testing**: Example queries for the convenience of repeated testing
8792

93+
## Limitations
94+
95+
- **Tool Return Types**: Currently, only text results of tool calls are supported.
96+
It uses LangChain's `response_format: 'content'` (the default) internally, which only supports text strings.
97+
While MCP tools can return multiple content types (text, images, etc.), this library currently filters and uses only text content.
98+
- **MCP Features**: Only MCP [Tools](https://modelcontextprotocol.io/docs/concepts/tools) are supported. Other MCP features like Resources, Prompts, and Sampling are not implemented.
99+
88100
## Usage
89101

90102
### Basic Usage

0 commit comments

Comments
 (0)