通过 MCP 使用公开发布的 API 文档

Apifox MCP Server 可以将公开发布的在线文档提供给 AI 使用。

仅支持公开发布、任何人都可以直接访问的在线文档，不支持设置了密码、邮箱白名单、IP 白名单的在线文档。如果不希望公开接口文档，仅仅是内部人员可以访问，建议使用项目 ID 和个人访问令牌读取 Apifox 项目数据，详见：通过 MCP 使用项目内文档。

为在线文档开启 MCP 功能

Apifox 版本 ≥ 2.7.2

开启 MCP 服务

进入 Apifox 项目，依次点击「分享文档 -> 发布文档站 -> AI 功能」，开启 MCP 服务。

获取配置文件

开启后，访问在线文档的接口时，页面将显示「AI 编程（使用 MCP）」按钮。

点击后，将弹出详细的使用说明和 MCP 配置文件，文件内已自动填充当前文档的 site-id。只需复制该配置，便可用于 IDE 中接入 MCP 服务。

配置 MCP 客户端

前置条件

已安装 Node.js 环境（版本号 >= 18，推荐最新的 LTS 版本）

任意一个支持 MCP 的 IDE：

Cursor

VSCode + Cline 插件

其它

已从 Apifox 在线文档复制了 MCP 的 JSON 配置

在 Cursor 中配置 MCP

编辑 MCP 配置文件

打开 Cursor 编辑器，点击右上角「设置」图标，选择左侧「MCP」选项，点击「+ Add new global MCP server」按钮。

添加配置内容

在打开的 mcp.json 文件中，添加从 “在线文档” 中复制的的 MCP 配置，例如：

macOS / Linux

Windows

{
  "mcpServers": {
    "API 文档": {
      "command": "npx",
      "args": [
        "-y",
        "apifox-mcp-server@latest",
        "--site-id=123456"
      ]
    }
  }
}

验证配置

配置完成后，你可以通过向 AI 询问以验证连接是否正常工作（Agent 模式），例如：

请通过 MCP 获取 API 文档，并告诉我项目中有几个接口

如果 AI 能够返回你 Apifox 项目中的 API 信息，说明连接成功。

在 Cline 中配置 MCP

安装 Cline 插件

在 VSCode 扩展市场搜索并安装 “Cline” 插件

配置 MCP 服务器

打开 Cline 面板，点击「MCP Servers > Configure MCP Servers」。

在打开的.json文件中添加 “在线文档” 中的 MCP 配置，例如：

macOS / Linux

Windows

{
  "mcpServers": {
    "API 文档": {
      "command": "npx",
      "args": [
        "-y",
        "apifox-mcp-server@latest",
        "--site-id=123456"
      ]
    }
  }
}

验证配置

配置完成后，你可以通过向 AI 询问以验证连接是否正常工作，例如：

请通过 MCP 获取 API 文档，并告诉我项目中有几个接口

如果 AI 能够返回你 Apifox 项目中的 API 信息，说明连接成功。

在 Trae 中配置 MCP

编辑 MCP 配置文件

打开最新版 Trae 编辑器，点击右上角「AI 侧栏 -> 设置」图标，选择「MCP」选项，点击「+ 添加 MCP Servers」按钮。

然后在 MCP 市场中选择 “手动配置”。

添加配置内容

在打开的 mcp.json 文件中，添加从 “在线文档” 中复制的的 MCP 配置，例如：

macOS / Linux

Windows

{
  "mcpServers": {
    "API 文档": {
      "command": "npx",
      "args": [
        "-y",
        "apifox-mcp-server@latest",
        "--site-id=123456"
      ]
    }
  }
}

验证配置

配置完成后，你可以通过向 AI 询问以验证连接是否正常工作（智能体模式），例如：

请通过 MCP 获取 API 文档，并告诉我项目中有几个接口

如果 AI 能够返回你 Apifox 项目中的 API 信息，说明连接成功。

注意事项

如果需要使用到多个 API 文档，在配置文件里添加配置多个 MCP Server 即可（不同文档有不同的<site-id>）。

使用私有化部署版本的用户，请在 IDE 的 MCP 的配置文件添加参数："--apifox-api-base-url=<私有化部署服务器的 API 地址，以 http:// 或 https:// 开头>"。另外，请确保网络可以正常访问 www.npm.com。

 {
  "mcpServers": {
    "API 文档": {
      "command": "npx",
      "args": [
        "-y",
        "apifox-mcp-server@latest",
        "--site-id=123456",
        // 私有化部署必须添加以下参数
        "--apifox-api-base-url=<私有化部署服务器的API地址>"
      ]
    }
  }
}

其他使用方法

通过 MCP 使用 Apifox 项目内的 API 文档

通过 MCP 使用 OpenAPI/Swagger 文档

常见问题

Windows 系统配置问题

如果在 Windows 操作系统上，前述配置无法正常工作，请使用以下配置：

{
  "mcpServers": {
    "API 文档": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "apifox-mcp-server@latest",
        "--site-id=123456"  // 替换为你的 Site ID
      ]
    }
  }
}

Node.js 版本问题

API 文档更新后，如何让 AI 读取最新数据？

通过 MCP 使用公开发布的 API 文档

为在线文档开启 MCP 功能#

配置 MCP 客户端#

前置条件#

在 Cursor 中配置 MCP#

在 Cline 中配置 MCP#

在 Trae 中配置 MCP#

注意事项#

其他使用方法#

常见问题#

为在线文档开启 MCP 功能

配置 MCP 客户端

前置条件

在 Cursor 中配置 MCP

在 Cline 中配置 MCP

在 Trae 中配置 MCP

注意事项

其他使用方法

常见问题