使用说明

项目简介

MCP API工具套件（MCP-APIKit）是一个专门为Windsurf IDE设计的MCP服务器，它桥接了Eolink OpenAPI平台和Windsurf IDE。通过从Eolink OpenAPI获取API规范，MCP-APIKit将API信息以标准化的MCP资源形式暴露出来，并提供一系列工具，使得开发者可以在Windsurf IDE中无缝地浏览、测试和集成来自Eolink的API。

主要功能点

API信息资源化: 将Eolink OpenAPI中管理的API项目和API接口转换为MCP资源，方便客户端访问和使用。
API发现与探索工具: 提供工具用于搜索和浏览Eolink OpenAPI中的API，帮助开发者快速找到所需的API接口。
API测试工具: 集成API测试功能，允许在Windsurf IDE内直接测试Eolink API，验证API的功能和性能。
标准MCP协议通信: 完全实现了Model Context Protocol (MCP) 协议，确保与Windsurf IDE等MCP客户端的标准化通信。
支持多种传输协议: 支持 Stdio 和 SSE 两种传输协议，可以根据不同的环境和需求选择合适的连接方式。

安装步骤

克隆仓库到本地:

git clone https://github.com/scarqin/mcp-apikit.git
cd mcp-apikit

安装依赖: 确保已安装 pnpm，然后运行：
```
pnpm install
```
构建项目:
```
pnpm run build
```

服务器配置

MCP服务器需要连接到Eolink OpenAPI才能获取API信息，因此需要配置Eolink API相关的环境变量。在项目根目录下创建 '.env' 文件，并填入以下信息：

EOLINK_API_KEY=你的Eolink API密钥
EOLINK_BASE_URL=https://api.eolink.com  # Eolink OpenAPI 基础URL，通常无需修改
SPACE_ID=你的Eolink空间ID        # 可选，如果需要指定空间
PROJECT_ID=你的Eolink项目ID       # 必填，指定要访问的Eolink项目ID

Windsurf IDE 客户端配置

在 Windsurf IDE 中添加 MCP 服务器配置，以便连接到 MCP API工具套件。配置信息为 JSON 格式，示例如下：

{
  "mcpServers": {
    "apikit": {                  // 服务器名称，可以自定义
      "command": "node",        // 启动服务器的命令，这里使用 Node.js
      "args": [                 // 启动命令的参数
        "/Users/{userName}/Documents/mcp-apikit/dist/index.js" // MCP 服务器入口文件路径，需要替换为实际路径
      ],
      "env": {}                 // 环境变量，如果需要在 Windsurf IDE 中设置环境变量，可以在这里配置
    }
  }
}

注意: 请将 '"/Users/{userName}/Documents/mcp-apikit/dist/index.js"' 替换为实际的 'dist/index.js' 文件路径。

基本使用方法

启动 MCP 服务器: 在项目根目录下运行以下命令启动服务器：
```
pnpm start
```
服务器默认监听 3001 端口 (可以通过修改 '.env' 文件中的 'PORT' 变量更改端口)。启动成功后，控制台会输出服务器地址和Windsurf IDE连接配置信息。
在 Windsurf IDE 中连接: 打开 Windsurf IDE，根据上述 Windsurf IDE 客户端配置 将 MCP API工具套件添加到 MCP 服务器列表中。配置完成后，Windsurf IDE 即可通过 MCP 协议与 MCP API工具套件进行通信，获取API资源和使用API工具。
使用 API 资源和工具: 连接成功后，在 Windsurf IDE 中可以通过 MCP 协议访问以下资源和工具：

资源 (Resources):
- 'api://projects' - 列出所有 API 项目
- 'api://projects/{projectId}' - 获取指定项目详情
- 'api://projects/{projectId}/apis' - 列出指定项目下的所有 API
- 'api://projects/{projectId}/apis/{apiId}' - 获取指定 API 详情
- 'api-docs://{projectId}/{apiId}' - 获取指定 API 的文档 (Markdown 格式)
工具 (Tools):
- 'list_projects' - 列出所有项目
- 'get_project' - 获取项目详情 (参数: 'projectId')
- 'list_apis' - 列出项目下的 API (参数: 'projectId', 可选参数: 'spaceId')
- 'get_api' - 获取 API 详情 (参数: 'projectId', 'apiId')
- 'search_apis' - 搜索 API (参数: 'query')
- 'test_api' - 测试 API (参数: 'projectId', 'apiId', 'headers', 'queryParams', 'pathParams', 'body')
具体使用方法请参考 Windsurf IDE 的相关文档，在 IDE 中通过 MCP 客户端调用这些资源和工具，即可实现 API 的浏览、文档查看和测试等功能。

关键词