功能简介
Apifox MCP Server 解决了让 AI 能够直接访问项目对应的接口文档数据的问题,方便开发者通过 AI 助手根据接口文档完成生成或修改代码、搜索接口文档内容等工作。
主要功能特性
- ? 自动读取 Apifox 整个项目里的所有接口文档的数据并缓存在本地电脑,供 AI 通过 MCP 读取。? 支持多种支持 MCP 的 IDE 工具,如 Cursor、VSCode + Cline 插件。? 支持使用多个项目的 API 文档,可在配置文件里添加多个 MCP Server 配置。? 除了 Apifox 项目,还支持直接读取 Swagger/OAS 文件。
快速开始指引
1.前置条件:安装 Node.js 环境(版本号 >= 18,推荐最新的 LTS 版本),准备任意一个支持 MCP 的 IDE(如 Cursor、VSCode + Cline 插件)。
2.安装:? 在 Apifox 生成 Access Token,替换配置文件中的 。? 获取 Apifox 项目 ID,替换配置文件中的 。
3.?配置 IDE:将 JSON 配置添加到 IDE 对应的 MCP 配置文件里,不同系统和 IDE 有不同的配置方式。
4.?使用:告诉 AI 想要通过 API 文档做的事情,若 Apifox 内数据更新,需告诉 AI 刷新接口文档数据。
MCP配置
{
??"mcpServers":{
? ??"API 文档":{
? ? ??"command":"npx",
? ? ??"args":[
? ? ? ??"-y",
? ? ? ??"apifox-mcp-server@latest",
? ? ? ??"--project-id=<project-id>"
? ? ??],
? ? ??"env":{
? ? ? ??"APIFOX_ACCESS_TOKEN":"<access-token>"
? ? ??}
? ??}
}
}
操作实践
https://qianniucity.feishu.cn/wiki/Mdl5wCNN4irNUAkOFetcUY6inod
阅读全文
1278