Apifox MCP Server

基本能力

产品定位

Apifox MCP Server 旨在通过将 Apifox 项目内的接口文档数据提供给 AI 编程工具，帮助开发者更高效地完成代码生成、修改和接口文档搜索等任务。

核心功能

1. 接口文档数据源：将 Apifox 项目内的接口文档数据提供给 AI 编程工具。
2. 代码生成与修改：AI 可以根据接口文档生成或修改代码。
3. 接口文档搜索：AI 可以搜索接口文档内容。
4. 本地缓存：接口文档数据默认缓存在本地，支持手动刷新以获取最新数据。
5. 多项目支持：支持配置多个 MCP Server 以使用不同项目的 API 文档。
6. Swagger/OAS 支持：支持直接读取 Swagger/OAS 文件。

适用场景

1. 代码生成：根据接口文档生成模型定义代码或 MVC 代码。
2. 代码修改：根据接口文档更新 DTO 字段或添加注释。
3. 接口文档搜索：快速查找接口文档中的特定内容。
4. 团队协作：团队成员共享接口文档数据，提高开发效率。

工具列表

1. Apifox MCP Server：核心服务，提供接口文档数据源功能。
2. Cursor：支持 AI 编程的 IDE 工具。
3. VSCode + Cline 插件：支持 MCP 的 IDE 工具。

常见问题解答

1. 数据更新问题：接口文档数据默认缓存在本地，需手动刷新以获取最新数据。
2. 多项目支持：通过配置多个 MCP Server 实现。
3. 私有化部署：需添加 --apifox-api-base-url 参数并确保网络可访问 www.npm.com。
4. Swagger/OAS 支持：通过 --oas 参数直接读取 Swagger/OAS 文件。

使用教程

使用依赖

• Node.js：版本号 >= 18（推荐最新的 LTS 版本）。
• 支持 MCP 的 IDE：如 Cursor 或 VSCode + Cline 插件。

安装教程

1. 生成 Access Token
2. 打开 Apifox，进入“账号设置 -> API 访问令牌”创建新的令牌。
3. 替换配置文件中的 <access-token>。
4. 获取项目 ID
5. 打开 Apifox 项目，进入“项目设置 -> 基本设置”复制项目 ID。
6. 替换配置文件中的 <project-id>。
7. 配置 IDE
8. 将以下 JSON 配置添加到 IDE 的 MCP 配置文件中： json { "mcpServers": { "API 文档": { "command": "npx", "args": [ "-y", "apifox-mcp-server@latest", "--project-id=<project-id>" ], "env": { "APIFOX_ACCESS_TOKEN": "<access-token>" } } } }
9. Windows 用户需使用以下配置： json { "mcpServers": { "API 文档": { "command": "cmd", "args": [ "/c", "npx", "-y", "apifox-mcp-server@latest", "--project-id=<project-id>" ], "env": { "APIFOX_ACCESS_TOKEN": "<access-token>" } } } }
10. 配置文件路径：
    • Cursor：~/.cursor/mcp.json 或 .cursor/mcp.json。
    • Cline：打开 Cline 面板 > MCP Server > Configure MCP Server。

调试方式

1. 验证配置：确保 access-token 和 project-id 已正确替换。
2. 启动服务：在 IDE 中启动 MCP Server。
3. 测试功能：通过 AI 助手尝试生成代码或搜索接口文档。
4. 刷新数据：若接口文档有更新，通知 AI 刷新数据。

许可证

None