MCP Chat

🚀 mcp-chat

mcp-chat 是一款开源通用的 MCP 客户端，主要用于对 MCP 服务器与代理开展测试及评估工作，为相关开发和测试人员提供了便捷且高效的工具。

🚀 快速开始

请确保已将ANTHROPIC_API_KEY环境变量导出到系统环境中，或者在项目根目录下的.env文件里进行设置。您可以前往Anthropic 控制台密钥页面注册并获取 API 密钥。

下面是一个简单的使用示例，从命令行启动一个带有文件系统 MCP 服务器的交互式聊天提示：

npx mcp-chat --server "npx -y @modelcontextprotocol/server-filesystem /Users/$USER/Desktop"

执行上述命令后，会打开一个聊天提示界面，您可以借助它与服务器进行交互，还能使用大语言模型（LLM）开展对话。

✨ 主要特性

• 交互式聊天：支持直接从命令行发起对话，操作便捷。
• 连接任何 MCP 服务器：能够与任意 MCP 服务器建立连接，具备广泛的适用性。
• 支持多种模型：兼容不同的大语言模型（LLM），满足多样化的使用需求。
• 上下文感知：具备上下文理解能力，可使对话更加连贯自然。

📦 安装指南

本项目使用时需确保环境变量ANTHROPIC_API_KEY已正确设置，获取方式可参考快速开始部分。

💻 使用示例

基础用法

从命令行发起对话

npx mcp-chat --server http://localhost:8080 -p "列出桌面目录下的文件"

启动网页模式

npx mcp-chat --web

请确保在使用网页模式时，已设置ANTHROPIC_API_KEY环境变量。

高级用法

配置文件指定

您还可以通过指定claude_desktop_config.json文件来进行配置，不同系统的配置命令如下：

• Mac 系统：

npx mcp-chat --config "/Users/你的用户名/.config/autocad/acad2018/chloroform/chain"

• Windows 系统：

npx mcp-chat --config "C:\Users\你的用户名\AppData\Roaming\AutoCAD\\2018\ChloroForm\Chain"

📚 详细文档

命令行选项

npx mcp-chat [选项]

可用选项如下：

• --server, -s：指定 MCP 服务器地址，默认值为http://localhost:8080。
• --web, -w：启动网页模式，可在浏览器中使用。
• --config, -c：指定配置文件路径。
• --version, -v：显示当前版本号。
• --help, -h：显示帮助信息。

🔧 技术细节

开发者指南

连接 MCP 服务器进行测试

在开发 MCP 服务器时，可通过以下不同环境的命令来测试mcp-chat：

• Node.js 环境

npm install @modelcontextprotocol/server-file-system
node -e "require('@modelcontextprotocol/server-file-system').start(8080)"

然后使用mcp-chat发起对话：

npx mcp-chat --server http://localhost:8080 -p "列出桌面目录下的文件"

• Python 环境 安装 Python 依赖：

pip install modelcontextprotocol-server-file-system
python3 -m modelcontextprotocol.server_file_system.start 8080

接着使用mcp-chat发起对话：

npx mcp-chat --server http://localhost:8080 -p "列出桌面目录下的文件"

项目架构

├── src/
│   ├── index.ts            # 主客户端实现与 CLI 参数处理
│   ├── constants.ts        # 默认常量定义
│   └── interactive.ts      # 交互式聊天提示逻辑
└── test/                   # 测试文件夹
    ├── cli.test.ts         # CLI 参数测试
    └── config.test.ts      # 配置文件解析测试

发布新版本

访问Github 发布页面，点击“新建发布”按钮，选择“添加标签”，创建新的语义化版本号v{主版本}.{次版本}.{修订版本}。填写发布标题“发布 v{主版本}.{次版本}.{修订版本}”及变更日志，最后点击“发布”。无需手动更新package.json中的版本号，因为 GitHub 工作流会自动处理并推送到主线分支。

📄 许可证

本项目采用MIT 许可证。