Apifox 服务 MCP 接入
Apifox MCP Server，可以将 Apifox 的接口文档提供给 Cursor 等支持 AI 编程的 IDE，或其他支持 MCP 的 AI 工具。
开发者可以通过 AI 助手完成以下工作：根据接口文档生成或修改代码、搜索接口文档内容等等，至于通过这个接口文档数据能让 AI 干什么更多更强大的活，请发挥你和你们团队的想象力
Apifox MCP Server 支持三种不同的使用场景，您可以根据实际需求选择对应的配置方法：
1. 使用 Apifox 项目内的 API 文档
如果您希望通过 MCP 来使用 Apifox 项目内的 API 文档，请参考我们的配置方法。具体操作请参考帮助文档
环境变量
- 需要将 APIFOX_ACCESS_TOKEN 配置为您在 Apifox 上创建的 API 访问令牌
- 需要将 PROJECTID 配置为您在 Apifox 中项目的项目ID
2. 使用公开发布的 API 文档
如果您希望通过 MCP 来使用公开发布的 API 文档，请查阅我们的详细配置指南。具体操作请参考帮助文档
环境变量
- 需要将 APIFOX_ACCESS_TOKEN 配置为您在 Apifox 上创建的 API 访问令牌
- 需要将 SITEID 配置为您在 Apifox 中已启用AI 功能的文档 site-id
3. 使用 OpenAPI/Swagger 文档
如果您希望通过 MCP 来使用 OpenAPI/Swagger 文档，我们同样提供了详细的配置说明，并能对文档进行美化。具体操作请参考帮助文档
- 需要将 APIFOX_ACCESS_TOKEN 配置为您在 Apifox 上创建的 API 访问令牌
- 需要将 OAS 配置为Swagger/OpenAPI 文件的 远程URL （例：https://petstore.swagger.io/v2/swagger.json）
使用说明
🗺️ 功能清单
| 工具标识 | 功能描述 | 核心参数 |
|---|---|---|
refresh_project_oas | 重新下载最新的指定项目的 OpenAPI Spec 文件内容 | - |
read_project_oas_ref_resources | 读取指定项目的 OpenAPI Spec 文件内 $ref 的文件内容 | path |
read_project_oas | 读取指定项目的 OpenAPI Spec 文件内容 | - |
仓库地址
https://github.com/apifox/apifox-mcp-server
🔌 使用方式
参数说明
refresh_project_oas_随机标识
从服务器重新下载最新的“指定项目”的 OpenAPI Spec 文件内容
返回: 文件内容
read_project_oas_ref_resources_随机标识
读取 “指定项目” 的 OpenAPI Spec 文件内 $ref 的文件内容, 可以同时获取多个文件内容
| 输入参数 | Type | 描述 |
|---|---|---|
| path | string[] | 接口文档地址path，例如 /paths/pet{petId}.json，可从 read_project_oas 接口返回中获取 $ref 字段内容 |
返回: 文件内容
read_project_oas_随机标识
读取“指定项目”的 OpenAPI Spec 文件内容
返回: 文件内容