將已發布的文件連接至 AI

Apidog MCP Server 讓 AI 能夠連接並使用由 Apidog 發布的線上 API 文件，使外部開發者和 AI 助理能夠順暢地存取公開 API 文件。

此設定方法僅支援公開發布的線上文件。不支援具有密碼或允許清單設定的文件。

對於非公開文件，請改用 Apidog Project 資料來源。

為線上文件啟用 MCP

需要 Apidog 2.7.2 或更新版本。

啟用 MCP 服務

前往你的 Apidog 專案

前往 Publish Docs → Publish Docs Sites → LLM-friendly Features

啟用 MCP 服務

取得設定檔

啟用 MCP 後，當你存取線上文件時，會顯示 MCP 按鈕。

點擊該按鈕以顯示設定指南和 MCP 設定檔，其中會自動包含你的文件 site-id。複製此設定以進行 IDE 整合。

設定 MCP Client

先決條件

在設定 MCP client 之前，請確保你具備：

Node.js（版本 18 或更新版本，建議使用最新 LTS 版本）

相容 MCP 的 IDE：

Cursor

VS Code + Cline plugin

其他支援 MCP 的編輯器

已從 Apidog 線上文件複製 MCP JSON 設定

在 Cursor 中設定 MCP

開啟 MCP 設定

開啟 Cursor 編輯器

點擊設定圖示（右上角）

從左側選單選擇 MCP

點擊 + Add new global MCP server

新增設定

將從線上文件複製的 MCP JSON 設定貼到開啟的 mcp.json 檔案中：

macOS / Linux

Windows

{
  "mcpServers": {
    "apidog-site-123456": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--site-id=123456"
      ]
    }
  }
}

驗證設定

透過向 AI 詢問（在 Agent mode 中）來測試連線：

Please fetch API documentation via MCP and tell me how many endpoints exist in the project.

如果 AI 回傳正確的 API 資訊，表示連線成功。

重要注意事項

使用多個文件網站

若要使用不同的 API 文件網站，請將多個 MCP Server 設定新增到設定檔中。每個文件網站都應該擁有其專屬且唯一的 <site-id>。

私有化部署

對於私有化部署，請在 IDE MCP 設定中包含你的伺服器 API 位址：

{
  "mcpServers": {
    "apidog-site-123456": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--site-id=123456",
        "--apidog-api-base-url=<your-server-url>"
      ]
    }
  }
}

將 <your-server-url> 替換為你的私有化部署伺服器 API 位址（以 http:// 或 https:// 開頭）。請確保能夠網路存取 www.npmjs.com。

其他資料來源

將 Apidog Project 中的 API 規格連接至 AI

將 OpenAPI 檔案連接至 AI

常見問題

Windows 設定問題

如果標準設定在 Windows 上失敗，請使用以下替代方案：

{
  "mcpServers": {
    "apidog-site-123456": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "apidog-mcp-server@latest",
        "--site-id=123456"
      ]
    }
  }
}

Node.js 版本問題

如何讓 AI 從更新後的 API 文件讀取最新資料？

將已發布的文件連接至 AI

為線上文件啟用 MCP#

設定 MCP Client#

先決條件#

在 Cursor 中設定 MCP#

重要注意事項#

使用多個文件網站#

私有化部署#

其他資料來源#

常見問題#

為線上文件啟用 MCP

設定 MCP Client

先決條件

在 Cursor 中設定 MCP

重要注意事項

使用多個文件網站

私有化部署

其他資料來源

常見問題