使用说明

项目简介

MCP API Connect 是一个 MCP 服务器,旨在桥接大型语言模型 (LLM) 和 RESTful API。它允许 LLM 通过标准化的 MCP 协议调用和利用外部 REST API 的功能,从而扩展 LLM 的能力,使其能够访问和操作外部数据和服务。

主要功能点

  • REST API 访问工具: 提供 'request' 工具,允许 LLM 客户端发送 HTTP 请求 (GET, POST, PUT, DELETE) 到指定的 REST API 端点。
  • 灵活的请求配置: 支持配置请求的 URL、Headers 和 Body,以满足各种 REST API 的调用需求。
  • 日志记录: 记录请求和响应日志,便于调试和监控 API 调用过程。
  • MCP 协议兼容: 完全兼容 Model Context Protocol,能够与任何支持 MCP 协议的 LLM 客户端协同工作。

安装步骤

  1. 安装 Node.js 和 npm: 确保你的系统已安装 Node.js 和 npm (Node 包管理器)。
  2. 全局安装 'mcp-api-connect': 打开终端或命令提示符,运行以下命令全局安装 'mcp-api-connect' 包:
    npm i -g mcp-api-connect
  3. 运行安装命令: 安装完成后,运行以下命令以配置 Claude Desktop (或其他 MCP 客户端) 的 MCP 服务器设置:
    mcpapiconnect install
    这个命令会自动检测你的操作系统,并更新 Claude Desktop 的配置文件,添加 'mcp-api-connect' 服务器的配置信息。
  4. 重启 Claude Desktop: 完成安装后,重启 Claude Desktop 应用程序,使配置生效。

服务器配置

  • 自动配置 (推荐): 'mcpapiconnect install' 命令会自动完成服务器配置,无需手动修改配置文件。
  • Claude Desktop 客户端配置信息 (供参考): 安装命令会在 Claude Desktop 的配置文件 'claude_desktop_config.json' 中添加如下服务器配置 (无需手动配置):
    {
      "mcpServers": {
        "mcpapiconnect": {
          "command": "mcpapiconnect",  // 启动服务器的命令,全局安装后可以直接使用 mcpapiconnect
          "args": ["serve"]          // 启动服务器的参数,使用 serve 命令启动服务器
        }
      }
    }
    • 'command': 指定启动 MCP 服务器的命令。全局安装后,可以直接使用 'mcpapiconnect' 命令。
    • 'args': 启动命令的参数。这里使用 'serve' 参数指示服务器以服务模式运行。

基本使用方法

  1. 启动 MCP API Connect 服务器: 如果使用 Claude Desktop,服务器会在 Claude 启动时自动加载,无需手动启动。对于其他 MCP 客户端,请参考其文档配置和启动 MCP 服务器。

  2. 在 LLM 客户端中使用 'request' 工具: 在支持 MCP 协议的 LLM 客户端 (如 Claude Desktop) 中,你可以通过 'request' 工具调用 REST API。工具名称为 'request',它接受包含 'type', 'url', 'headers', 'body' 字段的 JSON 对象作为参数。

  3. 调用示例 (Claude Desktop): 在 Claude 中,你可以使用类似以下的指令来调用 'request' 工具:

    tool_code:request({"type": "GET", "url": "https://api.example.com/data", "headers": {"Content-Type": "application/json"}, "body": {}})
    • 'type': HTTP 请求类型 (GET, POST, PUT, DELETE)。
    • 'url': 目标 REST API 的 URL 地址。
    • 'headers': 请求头信息,以 JSON 对象形式表示。
    • 'body': 请求体数据,以 JSON 对象形式表示 (GET 请求通常为空对象 '{}')。

    LLM 会根据你的指令调用 'request' 工具,并将 API 响应内容返回给你。

信息

分类

网页与API