article
README
🚀 MCP 客户端
这是一个基于模型上下文协议(MCP)的客户端项目,它能助力用户与 AI 模型和服务开展高级交互,为相关操作提供便利。
🚀 快速开始
本项目是基于模型上下文协议(MCP)的客户端,可用于与 AI 模型和服务进行高级交互。下面为你介绍如何快速开启使用。
✨ 主要特性
- 基于模型上下文协议(MCP),实现与 AI 模型和服务的高级交互。
- 支持列出特定服务器的所有可用工具。
- 支持调用特定工具。
📦 安装指南
先决条件
- Node.js(版本 16 或更高)
- pnpm(包管理器)
安装步骤
- 克隆仓库
git clone https://github.com/your-username/mcp-client.git
cd mcp-client
- 安装依赖项
pnpm install
📚 详细文档
配置
- 复制
mcp_config.json.example到mcp_config.json - 使用您自己的服务器和工具设置修改配置文件
使用方法
- 运行客户端:
pnpm start
- 当您运行客户端时,所有您的服务器都会自动注册。
- 您可以使用
list-toolsAPI 列出特定服务器的所有可用工具。
curl --location 'http://localhost:3000/list-tools/{serverName}'
- 您可以使用
call-toolAPI 调用特定工具。
curl --location 'http://localhost:3000/call-tool' \
--header 'Content-Type: application/json' \
--data '{
"serverName": "server_name",
"toolName": "tool_name",
"args": {
// 参数必须匹配从 list-tools 响应中的 inputSchema
// 必填字段必须包含在内
// 可选字段可以省略
// 示例基于上述架构:
// "issue_key": "PROJ-123" // 必填
// "expand": "..." // 可选
}
}'
光标规则
所有工具调用都会记录在 .cursorrules 文件中。
⚠️ 重要提示
- 您必须将 CURSORRULES 复制到您自己的存储库并根据自身需求进行编辑。
- 您必须将 "mcp_config.json" 复制到您自己的存储库并根据自身需求进行编辑。
- 您必须使用具有代理的 COMPOSER。
🤝 贡献
- 叉取仓库
- 创建功能分支(
git checkout -b feature/AmazingFeature) - 提交更改(
git commit -m 'Add some AmazingFeature') - 推送到分支(
git push origin feature/AmazingFeature) - 打开拉取请求
📄 许可证
根据 MIT 许可证分发。有关详细信息,请参阅 LICENSE。
📞 联系方式
您的姓名 - 您的邮箱地址@example.com
Scan to join WeChat group