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

Apifox MCP Server 可以将项目内的 API 文档提供给 AI 使用。

配置 MCP 客户端

前置条件

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

任意一个支持 MCP 的 IDE：

Cursor

VSCode + Cline 插件

其它

获取个人访问令牌和项目 ID

在 Apifox 生成 API 个人访问令牌

打开 Apifox，将鼠标悬停在页面右上角的头像上，点击 “账号设置 -> API 访问令牌”

创建新的 API 访问令牌，替换下面配置文件中的 <access-token>

获取 Apifox 项目 ID

打开 Apifox 里对应的项目

在左侧边栏点击 “项目设置”，在 “基本设置” 页面即可复制项目 ID

拿到项目 ID，替换下面配置文件中的 <project-id>

在 Cursor 中配置 MCP

编辑 MCP 配置文件

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

添加配置内容

在打开的 mcp.json 文件中添加以下配置，注意替换 <access-token> 和 <project-id> 为你自己的值：

macOS / Linux

Windows

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

验证配置

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

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

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

在 Cline 中配置 MCP

安装 Cline 插件

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

配置 MCP 服务器

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

在打开的 .json 文件中添加以下配置，注意替换 <access-token> 和 <project-id> 为你自己的值：

macOS / Linux

Windows

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

验证配置

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

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

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

注意事项

请将上面的 <access-token> 和 <project-id> 替换为你个人的 Apifox API 访问令牌和 Apifox 项目 ID。

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

如果团队习惯将 MCP 配置文件同步到代码仓库里，建议删除配置里的"APIFOX_ACCESS_TOKEN": "<access-token>"，改成每个成员在自己电脑里配置名为 APIFOX_ACCESS_TOKEN 的环境变量，以避免 APIFOX_ACCESS_TOKEN 泄漏问题。

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

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

其他使用方法

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

通过 MCP 使用 OpenAPI/Swagger 文档

常见问题

Windows 系统配置问题

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

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

Node.js 版本问题

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

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

配置 MCP 客户端#

前置条件#

获取个人访问令牌和项目 ID#

在 Cursor 中配置 MCP#

在 Cline 中配置 MCP#

注意事项#

其他使用方法#

常见问题#