Apifox MCP Server

通过使用Apifox MCP Server，可以将Apifox项目中的接口文档提供给支持AI编程的IDE工具（如Cursor），使AI可以直接访问项目对应的接口文档数据。

开发者可以使用AI助手根据接口文档完成生成或修改代码、搜索接口文档内容等任务。至于AI还能用这些接口文档数据完成哪些更强大的任务，请尽情发挥你和团队的想象力 😜

🎯 使用方法

在安装并配置好MCP后，Apifox MCP Server会自动读取整个Apifox项目中所有接口文档的数据，并将其缓存在本地计算机上。AI可以通过MCP读取项目中所有接口的接口文档数据。

您只需要通过API文档告诉AI您想做什么，例如：

1. 通过MCP获取API文档，并生成Product及其相关模型的定义代码。
2. 根据API文档，在Product DTO中添加几个新添加到API文档中的字段。
3. 根据API文档，为Product类中的每个字段添加注释。
4. 根据API文档，生成与接口/用户相关的所有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. 配置IDE

向IDE对应的MCP配置文件中添加以下JSON配置：

{
  "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>"
      }
    }
  }
}

• Cursor: 添加到全局 ~/.cursor/mcp.json 或项目内的 .cursor/mcp.json
• Cline： 打开Cline面板 > MCP Server > 配置MCP Server

注意：

1. 请提供上述 <access-token> 和 <project-id> 并替换为您个人的Apifox API访问令牌和Apifox项目ID。
2. 建议在配置文件中填写MCP Server名称时使用包含“API文档”字样的名称，如“API文档”或“xxx API文档”，以便AI更容易正确识别此MCP Server的目的。不建议填写“Apifox”或“Apifox MCP”，因为这种写法不易于AI识别目的。
3. 如果需要使用多个项目的API文档，只需在配置文件中添加多个MCP服务器的配置（不同项目有不同的配置）<project-id>。将MCP Server名称填写为'xxx API文档'。
4. 如果团队习惯将MCP配置文件同步到代码仓库，建议删除配置中的“APIFOX-ACCESS-TOKEN”：“<access-token>改为每位成员在自己的电脑上配置名为APIFOX-ACCESS-TOKEN的环境变量，以避免APIFOX-ACCESS-TOKEN泄露问题。
5. 对于使用私有部署版本的用户，请在IDE的MCP配置文件中添加参数“--apifox apibase url”=<私有化部署服务器的API地址，以http://或https://开头>。同时，请确保网络正常访问 www.npm.com。
6. 除了Apifox项目外，还支持直接读取Swagger/OAS文件。请移除 "--project-id=<project-id>" 参数，添加 "--oas=<oas-url-or-path>" 参数。例如：npx apifox-mcp-server --oas https://petstore.swagger.io/v2/swagger.json 或 npx apifox-mcp-server --oas ~/data/petstore/swagger.json

❓ 帮助和支持

Apifox MCP Server仍处于内部测试阶段。我们欢迎您的建议和想法。请加入内部测试群组：