返回 MCP 目录
public公开dns本地运行

MCP REST Client

MCP客户端项目,用于与AI模型和服务进行高级交互,支持工具调用和服务器管理。

article

README

🚀 MCP 客户端

这是一个基于模型上下文协议(MCP)的客户端项目,它能助力用户与 AI 模型和服务开展高级交互,为相关操作提供便利。

🚀 快速开始

本项目是基于模型上下文协议(MCP)的客户端,可用于与 AI 模型和服务进行高级交互。下面为你介绍如何快速开启使用。

✨ 主要特性

  • 基于模型上下文协议(MCP),实现与 AI 模型和服务的高级交互。
  • 支持列出特定服务器的所有可用工具。
  • 支持调用特定工具。

📦 安装指南

先决条件

  • Node.js(版本 16 或更高)
  • pnpm(包管理器)

安装步骤

  1. 克隆仓库
git clone https://github.com/your-username/mcp-client.git
cd mcp-client
  1. 安装依赖项
pnpm install

📚 详细文档

配置

  1. 复制 mcp_config.json.examplemcp_config.json
  2. 使用您自己的服务器和工具设置修改配置文件

使用方法

  1. 运行客户端:
pnpm start
  1. 当您运行客户端时,所有您的服务器都会自动注册。
  2. 您可以使用 list-tools API 列出特定服务器的所有可用工具。
curl --location 'http://localhost:3000/list-tools/{serverName}'
  1. 您可以使用 call-tool API 调用特定工具。
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。

🤝 贡献

  1. 叉取仓库
  2. 创建功能分支(git checkout -b feature/AmazingFeature
  3. 提交更改(git commit -m 'Add some AmazingFeature'
  4. 推送到分支(git push origin feature/AmazingFeature
  5. 打开拉取请求

📄 许可证

根据 MIT 许可证分发。有关详细信息,请参阅 LICENSE

📞 联系方式

您的姓名 - 您的邮箱地址@example.com

项目链接:https://github.com/your-username/mcp-client

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端