🚀 ApiFox MCP 服务器

这是一个基于 Model Context Protocol (MCP) 的 ApiFox 接口服务器，主要用于获取和管理 ApiFox 的接口信息。只需在 Cursor 中配置 MCP 服务，就能获取对应接口模块信息并返回给大模型，进而让 Cursor 借助接口信息协助你实现业务逻辑。

✨ 主要特性

• 支持通过 MCP 协议获取 ApiFox 接口信息。
• 提供 HTTP 服务和 CLI 命令行两种使用方式。
• 使用 TypeScript 开发，具备类型安全的特性。
• 支持环境变量配置。

🚀 快速开始

📦 安装指南

使用 npx 快速安装

npx @wangmhaha/apifox-mcp-server@latest --apifox-api-key=<your-apifox-api-key> --project=<your-project-id>

从本地源运行

1. 拉取代码并安装依赖

pnpm install

2. 打包

pnpm build

3. 运行

pnpm start:http

💻 使用示例

配置 cursor 通过 sse 连接到 MCP 服务器

服务器将在配置的端口上启动（默认 3000）。

"apifox-mcp-server": {
    "url": "http://localhost:3000/sse",
}

推荐通过使用配置文件 JSON 配置

可以通过在 cursor mcp 配置文件中添加以下内容来配置 apifox-mcp-server 服务器：

"apifox-mcp-server": {
    "command": "npx",
    "args": ["-y", "@wangmhaha/apifox-mcp-server@latest", "--local"],
    "env": {
      "APIFOX_API_KEY": "<your-apifox-api-key>",
      "PROJECT_ID": "<your-project-id>"
    }
}

配置文件配置

"apifox-mcp-server": {
    "url": "http://localhost:3000/sse",
    "env": {
      "APIFOX_API_KEY": "<your-apifox-api-key>",
      "PROJECT_ID": "<your-project-id>"
    }
}

command 模式运行

"apifox-mcp-server": {
    "command": "node",
    "args": [
      "<you-local-path>/build/index.js",
      "--local",
    ],
    "env": {
      "APIFOX_API_KEY": "<your-apifox-api-key>",
      "PROJECT_ID": "<your-project-id>"
    }
},

环境变量配置

如不在 MCP 配置文件中配置 env 环境变量，请在本地环境变量配置。在项目根目录下修改 .env.example 文件为 .env 文件，配置以下内容：

APIFOX_API_KEY=your_api_key_here
PROJECT_ID=your_project-ID
PORT=3000  # 可选，默认为 3000

🔧 技术细节

技术栈

• Node.js
• TypeScript
• Express.js
• Model Context Protocol SDK
• Zod（数据验证）

📄 许可证

ISC License