Apifox MCP Server

🚀 Apifox MCP 服務器

Apifox MCP 服務器能夠將 Apifox 項目裡的接口文檔當作數據源，提供給 Cursor 等支持 AI 編程的 IDE 工具，讓 AI 可以直接訪問項目對應的接口文檔數據。藉助該服務器，開發者可利用 AI 助手完成代碼生成與修改、接口文檔內容搜索等工作。至於基於此接口文檔數據，AI 還能發揮怎樣強大的作用，就等您和團隊發揮無限的想象力與創造力啦！

🚀 快速開始

使用 Apifox MCP 服務器時，在安裝並配置好 MCP 後，服務器會自動讀取 Apifox 整個項目中的所有接口文檔數據，並將其緩存到本地電腦。這樣一來，AI 就能通過 MCP 讀取項目內的所有接口文檔數據。

您只需告知 AI 想要藉助 API 文檔完成的任務即可，以下是一些示例：

1. “通過 MCP 獲取 API 文檔，然後生成 Product 及其相關模型的定義代碼”
2. “根據 API 文檔，在 Product DTO 裡添加新新增的幾個字段”
3. “根據 API 文檔為 Product 類的每個字段都添加註釋”
4. “根據 API 文檔，生成接口 /users 相關的所有 MVC 代碼”

⚠️ 重要提示

接口文檔數據默認會緩存到本地，如果 Apifox 內的數據有更新，請提醒 AI 刷新接口文檔數據，否則 AI 讀取的數據可能不是最新的。

📦 安裝指南

前置條件

• 已安裝 Node.js 環境（版本號 >= 18，推薦使用最新 LTS 版本）
• 至少一個支持 MCP 的 IDE：
  • Cursor
  • VSCode + Cline 插件

安裝步驟

1. 在 Apifox 中生成 Access Token a. 打開 Apifox，將鼠標懸停在頁面右上角的頭像上，點擊 “賬號設置 -> API 訪問令牌”。 b. 創建新的 API 訪問令牌，具體操作請參考幫助文檔。 c. 獲取到 API 訪問令牌後，替換下面配置文件中的 <access-token>。

2. 獲取 Apifox 項目 ID a. 打開 Apifox 中對應的項目。 b. 在左側邊欄點擊“項目設置”，在“基本設置”中查看項目 ID。 c. 將項目 ID 替換到下面配置文件中的 <project-id>。

3. 安裝與配置

   • 對於大多數情況，請運行以下命令：

     npm install -g apifox-mcp-server
     

     然後根據需要執行以下命令啟動服務器：

     apifox-mcp-server --project-id=<your-project-id>
     

   • 如果您需要使用私有化部署，請添加 --apifox-api-base-url 參數，指定 Apifox 服務的地址。

4. 直接讀取 Swagger/OAS 文件 如果不使用 Apifox 項目，可以直接指定 Swagger 或 OpenAPI 文檔文件：

   apifox-mcp-server --oas https://example.com/swagger.json
   

❓ 幫助與支持

Apifox MCP Server 目前還在內測階段，歡迎您提出寶貴的建議和想法。您可以通過掃描以下二維碼聯繫我們：