apifox

Apifox MCP Server 会读取你在 Apifox 项目中的所有接口文档数据，并将它们缓存在本地，以供支持 AI 编程的 IDE（如 Cursor、Cline/VSCode 插件）使用。你可以像对待任意 API 文档数据一样向 AI 提出需求，例如让 AI 根据接口文档生成 Product 及相关模型的代码、在 Product DTO 中添加新的字段注释，或生成 /users 等接口的完整 MVC 代码。使用时只需要告诉 AI 你想基于 API 文档完成什么任务，工具会从本地缓存中检索相应的接口文档来生成或更新代码。需要注意的是，缓存并非永久同步，若 Apifox 内的数据有更新，请指示 AI 刷新缓存以确保数据最新。

前提条件:

• 已安装 Node.js (版本 >= 18，推荐最新的 LTS 版本)
• 具备一个可运行 MCP 的 IDE（如 Cursor、VSCode 配合 Cline 插件）

安装步骤:

1. 安装并准备 API 令牌与项目 ID：在 Apifox 生成 API 访问令牌，并取得目标项目的项目 ID。记录下 <access-token> 与 <project-id>。
2. 安装 MCP 服务器并配置：在你的 IDE 的 MCP 配置文件中添加以下配置，将 <project-id> 和 <access-token> 替换为实际值。

{
  "mcpServers": {
    "API 文档": {
      "command": "npx",
      "args": [
        "-y",
        "apifox-mcp-server@latest",
        "--project-id=<project-id>"
      ],
      "env": {
        "APIFOX_ACCESS_TOKEN": "<access-token>"
      }
    }
  }
}

如果你在 Windows 上遇到兼容问题，可以使用如下替代配置：

{
  "mcpServers": {
    "API 文档": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "apifox-mcp-server@latest",
        "--project-id=<project-id>"
      ],
      "env": {
        "APIFOX_ACCESS_TOKEN": "<access-token>"
      }
    }
  }
}

3. 启动 MCP 服务器：保存配置后，按 IDE 指示启动 MCP 服务，确保网络可访问 Apifox。 4)（可选）若需要读取 Swagger/OAS 文件：将参数替换为 --oas 指定的 URL 或本地路径，如 --oas https://petstore.swagger.io/v2/swagger.json。

完成上述步骤后，你即可在 IDE 中通过 AI 助手基于 Apifox 的接口文档进行代码生成、字段修改、注释添加等操作。

要点与故障排除:

• 需将 APIFOX_ACCESS_TOKEN 与 <access-token>、<project-id> 替换为实际值，以便正确读取接口数据。
• 若数据更新，请指示 AI 刷新缓存，以确保使用最新接口文档。
• 如需在私有化部署读取 API，请在 IDE 的 MCP 配置中添加相关 --apifox-api-base-url 参数，并确保能访问 npm 仓库。
• 若配置包含多个项目，请为每个项目创建单独的 MCP Server，且命名应包含“API 文档”以便 AI 正确识别用途。
• 对于私有化部署或需要直接使用 Swagger/OAS 的场景，请使用相应的 --oas 参数替换 --project-id。
• 安装环境与网络要求：Node.js 版本需符合要求，且网络需可访问 http(s)://www.npmjs.com 及 Apifox 的相关端点。—— 这些设置有助于避免发行版本与依赖拉取时的常见问题。