Apifox MCP Server

🚀 Apifox MCP 服务器

Apifox MCP 服务器能够将 Apifox 项目里的接口文档当作数据源，提供给 Cursor 等支持 AI 编程的 IDE 工具，让 AI 可以直接访问项目对应的接口文档数据。借助该服务器，开发者可利用 AI 助手完成代码生成与修改、接口文档内容搜索等工作。至于基于此接口文档数据，AI 还能发挥怎样强大的作用，就等您和团队发挥无限的想象力与创造力啦！

🚀 快速开始

使用 Apifox MCP 服务器时，在安装并配置好 MCP 后，服务器会自动读取 Apifox 整个项目中的所有接口文档数据，并将其缓存到本地电脑。这样一来，AI 就能通过 MCP 读取项目内的所有接口文档数据。

您只需告知 AI 想要借助 API 文档完成的任务即可，以下是一些示例：

1. “通过 MCP 获取 API 文档，然后生成 Product 及其相关模型的定义代码”
2. “根据 API 文档，在 Product DTO 里添加新新增的几个字段”
3. “根据 API 文档为 Product 类的每个字段都添加注释”
4. “根据 API 文档，生成接口 /users 相关的所有 MVC 代码”

⚠️ 重要提示

接口文档数据默认会缓存到本地，如果 Apifox 内的数据有更新，请提醒 AI 刷新接口文档数据，否则 AI 读取的数据可能不是最新的。

📦 安装指南

前置条件

• 已安装 Node.js 环境（版本号 >= 18，推荐使用最新 LTS 版本）
• 至少一个支持 MCP 的 IDE：
  • Cursor
  • VSCode + Cline 插件

安装步骤

1. 在 Apifox 中生成 Access Token a. 打开 Apifox，将鼠标悬停在页面右上角的头像上，点击 “账号设置 -> API 访问令牌”。 b. 创建新的 API 访问令牌，具体操作请参考帮助文档。 c. 获取到 API 访问令牌后，替换下面配置文件中的 <access-token>。

2. 获取 Apifox 项目 ID a. 打开 Apifox 中对应的项目。 b. 在左侧边栏点击“项目设置”，在“基本设置”中查看项目 ID。 c. 将项目 ID 替换到下面配置文件中的 <project-id>。

3. 安装与配置

   • 对于大多数情况，请运行以下命令：

     npm install -g apifox-mcp-server
     

     然后根据需要执行以下命令启动服务器：

     apifox-mcp-server --project-id=<your-project-id>
     

   • 如果您需要使用私有化部署，请添加 --apifox-api-base-url 参数，指定 Apifox 服务的地址。

4. 直接读取 Swagger/OAS 文件 如果不使用 Apifox 项目，可以直接指定 Swagger 或 OpenAPI 文档文件：

   apifox-mcp-server --oas https://example.com/swagger.json
   

❓ 帮助与支持

Apifox MCP Server 目前还在内测阶段，欢迎您提出宝贵的建议和想法。您可以通过扫描以下二维码联系我们：