Apifox MCP Server

🚀 ApiFox MCP 服務器

這是一個基於 Model Context Protocol (MCP) 的 ApiFox 接口服務器，主要用於獲取和管理 ApiFox 的接口信息。只需在 Cursor 中配置 MCP 服務，就能獲取對應接口模塊信息並返回給大模型，進而讓 Cursor 藉助接口信息協助你實現業務邏輯。

✨ 主要特性

• 支持通過 MCP 協議獲取 ApiFox 接口信息。
• 提供 HTTP 服務和 CLI 命令行兩種使用方式。
• 使用 TypeScript 開發，具備類型安全的特性。
• 支持環境變量配置。

🚀 快速開始

📦 安裝指南

使用 npx 快速安裝

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

從本地源運行

1. 拉取代碼並安裝依賴

pnpm install

2. 打包

pnpm build

3. 運行

pnpm start:http

💻 使用示例

配置 cursor 通過 sse 連接到 MCP 服務器

服務器將在配置的端口上啟動（默認 3000）。

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

推薦通過使用配置文件 JSON 配置

可以通過在 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>"
    }
}

配置文件配置

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

環境變量配置

如不在 MCP 配置文件中配置 env 環境變量，請在本地環境變量配置。在項目根目錄下修改 .env.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