ApiFox MCP 服务器

这是一个基于模型上下文协议（MCP）的ApiFox接口服务器，用于获取和管理ApiFox的API信息。通过在光标中配置MCP服务，可以获取相应的接口模块信息并返回给大型模型，使光标能够通过接口信息帮助您实现业务逻辑。

特性

• 支持通过MCP协议获取ApiFox接口信息
• 提供两种使用方式：HTTP服务和CLI命令行
• 使用TypeScript开发，提供类型安全性
• 支持环境变量配置

快速安装和使用

npx @wangmhaha/apifox-mcp-server@latest --apifox-api-key=<your-apifox-api-key> --project=<your-project-id>

配置光标以通过sse连接到MCP服务器

服务器将在配置的端口上启动（默认为3000）。

"apifox-mcp-server": {
    "url": "http://localhost:3000/sse",
  }

推荐通过JSON配置文件进行配置

您可以通过在光标的MCP配置文件中添加以下内容来配置apifox mcp服务器：

 "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:3[0]00/sse",
    "env": {
      "APIFOX_API_KEY": "<your-apifox-api-key>",
      "PROJECT_ID": "<your-project-id>"
    }
  }

也可以在命令模式下运行

"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>"
    }
  },

如果未在MCP配置文件中配置env环境变量，请在本地环境变量中配置

在项目根目录中修改.evn.example文件为.env文件，并配置以下环境变量：

APIFOX_API_KEY=your_api_key_here
PROJECT_ID=your_project-ID
PORT=3000  # 可选，默认为 3000

技术栈

• Node.js
• TypeScript
• Express.js
• 模型上下文协议SDK
• Zod（数据验证）

许可证

ISC许可证