Skip to content

Commit 91eb6a7

Browse files
authored
Merge pull request #17 from hideya/dev
Rename mcp-try-cli to mcp-client-cli
2 parents 5911408 + 377e8e3 commit 91eb6a7

File tree

4 files changed

+32
-36
lines changed

4 files changed

+32
-36
lines changed

README.md

Lines changed: 19 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
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)
1+
# Simple 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-client-cli.svg)](https://www.npmjs.com/package/@h1deya/mcp-client-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.
7-
This tool performs automatic schema adjustments for LLM compatibility.
7+
This tool automatically adjusts the schema for LLM compatibility, which can help some failing MCP servers run successfully.
88
Suitable for testing MCP servers, exploring their capabilities, and prototyping integrations.
99

1010
Internally it uses [LangChain ReAct Agent](https://github.com/langchain-ai/react-agent-js) and
1111
a utility function `convertMcpToLangchainTools()` from
12-
[`@h1deya/langchain-mcp-tools`](https://www.npmjs.com/package/@h1deya/langchain-mcp-tools).
12+
[`@h1deya/langchain-mcp-tools`](https://www.npmjs.com/package/@h1deya/langchain-mcp-tools).
1313
This function performs the aforementioned MCP tools schema transformations for LLM compatibility.
1414
See [this page](https://github.com/hideya/langchain-mcp-tools-ts/blob/main/README.md#llm-provider-schema-compatibility)
1515
for details.
@@ -30,10 +30,10 @@ A Python equivalent of this utility is available [here](https://pypi.org/project
3030

3131
## Quick Start
3232

33-
- Install `mcp-try-cli` tool.
33+
- Install `mcp-client-cli` tool.
3434
This can take up to a few minutes to complete:
3535
```bash
36-
npm install -g @h1deya/mcp-try-cli
36+
npm install -g @h1deya/mcp-client-cli
3737
```
3838

3939
- Configure LLM and MCP Servers settings via the configuration file, `llm_mcp_config.json5`
@@ -54,7 +54,7 @@ A Python equivalent of this utility is available [here](https://pypi.org/project
5454
},
5555

5656
"mcp_servers": {
57-
"weather": {
57+
"us-weather": { // US weather only
5858
"command": "npx",
5959
"args": ["-y", "@h1deya/mcp-server-weather"]
6060
},
@@ -78,7 +78,7 @@ A Python equivalent of this utility is available [here](https://pypi.org/project
7878

7979
- Run the tool
8080
```bash
81-
mcp-try-cli
81+
mcp-client-cli
8282
```
8383
By default, it reads the configuration file, `llm_mcp_config.json5`, from the current directory.
8484
Then, it applies the environment variables specified in the `.env` file,
@@ -93,6 +93,9 @@ See [README_DEV.md](https://github.com/hideya/mcp-client-langchain-ts/blob/main/
9393
- **Easy setup**: Works out of the box with popular MCP servers
9494
- **Flexible configuration**: JSON5 config with environment variable support
9595
- **Multiple LLM providers**: OpenAI, Anthropic, Google (GenAI)
96+
- **Schema Compatibility Support**: Automatically adjusts tools schema for LLM compatibility, which can help some failing MCP servers run successfully.
97+
See [this page](https://github.com/hideya/langchain-mcp-tools-ts/blob/main/README.md#llm-provider-schema-compatibility)
98+
for details.
9699
- **Command & URL servers**: Support for both local and remote MCP servers
97100
- **Real-time logging**: Live stdio MCP server logs with customizable log directory
98101
- **Interactive testing**: Example queries for the convenience of repeated testing
@@ -109,7 +112,7 @@ While MCP tools can return multiple content types (text, images, etc.), this lib
109112
### Basic Usage
110113

111114
```bash
112-
mcp-try-cli
115+
mcp-client-cli
113116
```
114117

115118
By default, it reads the configuration file, `llm_mcp_config.json5`, from the current directory.
@@ -121,16 +124,16 @@ It outputs local MCP server logs to the current directory.
121124

122125
```bash
123126
# Specify the config file to use
124-
mcp-try-cli --config my-config.json5
127+
mcp-client-cli --config my-config.json5
125128

126129
# Store local (stdio) MCP server logs in specific directory
127-
mcp-try-cli --log-dir ./logs
130+
mcp-client-cli --log-dir ./logs
128131

129132
# Enable verbose logging
130-
mcp-try-cli --verbose
133+
mcp-client-cli --verbose
131134

132135
# Show help
133-
mcp-try-cli --help
136+
mcp-client-cli --help
134137
```
135138

136139
## Supported LLM Providers
@@ -241,17 +244,10 @@ There are quite a few useful MCP servers already available:
241244

242245
## Troubleshooting
243246

244-
### Common Issues
245-
246-
1. **Missing API key**: Make sure your `.env` file contains the required API key
247-
2. **Server not found**: Ensure MCP server packages are available via npx
248-
3. **Permission errors**: Check file permissions for log directory
249-
250-
### Getting Help
251-
252-
- Check the logs in your specified log directory
253-
- Use `--verbose` flag for detailed output
254-
- Refer to [MCP documentation](https://modelcontextprotocol.io/)
247+
- Make sure your configuration and .env files are correct, especially the spelling of the API keys
248+
- Check the local MCP server logs
249+
- Use `--verbose` flag to view the detailed logs
250+
- Refer to [Debugging Section in MCP documentation](https://modelcontextprotocol.io/docs/tools/debugging)
255251

256252
## License
257253

llm_mcp_config.json5

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
},
6565

6666
// https://github.com/modelcontextprotocol/quickstart-resources/tree/main/weather-server-python
67-
"weather": {
67+
"us-weather": { // US weather only
6868
"command": "npx",
6969
"args": [
7070
"-y",
@@ -84,7 +84,7 @@
8484

8585
// // Test SSE connection with the auto fallback
8686
// // See the comments at the top of src/index.ts
87-
// weather: {
87+
// us-weather: {
8888
// "url": "http://localhost:${SSE_SERVER_PORT}/sse"
8989
// },
9090

package-lock.json

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
{
2-
"name": "@h1deya/mcp-try-cli",
2+
"name": "@h1deya/mcp-client-cli",
33
"version": "0.3.0",
4-
"description": "Simple CLI MCP Client to quickly test and explore MCP servers from the command line",
4+
"description": "Simple MCP Client to quickly test and explore MCP servers from the command line",
55
"license": "MIT",
66
"keywords": [
77
"mcp",
8-
"cli",
9-
"try",
10-
"test",
118
"model-context-protocol",
9+
"client",
10+
"cli",
1211
"langchain",
1312
"tools",
1413
"typescript",
15-
"client",
1614
"simple",
1715
"quick",
18-
"explore"
16+
"explore",
17+
"try",
18+
"test"
1919
],
2020
"author": "hideya kawahara",
2121
"repository": {
@@ -26,7 +26,7 @@
2626
"url": "https://github.com/hideya/mcp-client-langchain-ts/issues"
2727
},
2828
"bin": {
29-
"mcp-try-cli": "dist/index.js"
29+
"mcp-client-cli": "dist/index.js"
3030
},
3131
"main": "./dist/index.js",
3232
"files": [

0 commit comments

Comments
 (0)