这是一个基于 Model Context Protocol (MCP) 的 ApiFox 接口服务器,用于获取和管理 ApiFox 的接口信息。通过在 Cursor 中配置 MCP 服务,获取对应接口模块信息返回给大模型,让 Cursor 通过接口信息帮助你实现业务逻辑。
- 支持通过 MCP 协议获取 ApiFox 接口信息
- 提供 HTTP 服务和 CLI 命令行两种使用方式
- 使用 TypeScript 开发,提供类型安全
- 支持环境变量配置
npx @wangmhaha/apifox-mcp-server@latest --apifox-api-key=<your-apifox-api-key> --project=<your-project-id>
服务器将在配置的端口上启动(默认 3000)。
"apifox-mcp-server": {
"url": "http://localhost:3000/sse",
}
可以通过在 cursor mcp 配置文件中添加以下内容来配置 apifox-mcp-server 服务器:
"apifox-mcp-server": {
"command": "npx",
"args": ["-y", "@wangmhaha/apifox-mcp-server@latest", "--local"],
"env": {
"APIFOX_API_KEY": "<your-apifox-api-key>",
"PROJECT_ID": "<your-project-id>"
}
}
拉取代码安装依赖
pnpm install
打包
pnpm build
运行
pnpm start:http
配置:
"apifox-mcp-server": {
"url": "http://localhost:3000/sse",
"env": {
"APIFOX_API_KEY": "<your-apifox-api-key>",
"PROJECT_ID": "<your-project-id>"
}
}
也可通过 command 模式运行
"apifox-mcp-server": {
"command": "node",
"args": [
"<you-local-path>/build/index.js",
"--local",
],
"env": {
"APIFOX_API_KEY": "<your-apifox-api-key>",
"PROJECT_ID": "<your-project-id>"
}
},
在项目根目录下修改.evn.example
文件为.env
文件,配置以下环境变量:
APIFOX_API_KEY=your_api_key_here
PROJECT_ID=your_project-ID
PORT=3000 # 可选,默认为 3000
- Node.js
- TypeScript
- Express.js
- Model Context Protocol SDK
- Zod(数据验证)
ISC License