Yapi MCP Server

🚀 YAPI MCP 服務器

YAPI MCP 服務器是一個與 YAPI 實例交互的 Model Context Protocol (MCP) 服務器。它能讓大型語言模型 (LLMs) 從您的 YAPI 項目中檢索 API 文檔詳細信息，為開發工作提供便利。

✨ 主要特性

• 可列出特定項目中的接口類別及其基本接口信息。
• 能按接口 ID 獲取特定接口的詳細信息。

📦 安裝指南

⚙️ 前提條件

1. 需有一個正在運行的 YAPI 實例。
2. 要獲取您要交互的 YAPI 項目的項目令牌，可在 YAPI 項目“設置” -> “令牌”部分找到。
3. 在運行服務器或構建 Docker 鏡像的機器上安裝 Node.js 和 npm。

🛠️ 配置

該服務器需要通過 YAPI_URL 環境變量設置 YAPI 實例的基礎 URL。

📝 使用 Claude Desktop

將以下內容添加到您的 claude_desktop_config.json 中：

NPX

{
  "mcpServers": {
    "yapi": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-yapi"
      ],
      "env": {
        "YAPI_URL": "http://your-yapi-instance.com"
        // 如果您想硬編碼默認令牌（不安全，建議通過工具傳遞）：
        // "YAPI_PROJECT_TOKEN": "YOUR_DEFAULT_PROJECT_TOKEN"
      }
    }
  }
}

💻 使用示例

工具介紹

1. yapi_list_interfaces

• 功能：列出特定 YAPI 項目的所有接口類別及其包含的接口。
• 輸入：
  • project_token (字符串)：YAPI 項目的令牌（在 YAPI 項目設置 -> 令牌中找到）。
• 返回：一個 JSON 字符串，包含按類別的數組，每個類別有一個簡化的接口對象列表（id、標題、路徑、方法、狀態）。

2. yapi_get_interface_details

• 功能：根據其 ID 獲取特定 YAPI 接口的詳細信息。
• 輸入：
  • project_token (字符串)：YAPI 項目的令牌。
  • interface_id (數字)：特定 YAPI 接口的 ID（您可以在 YAPI 中查看接口時在其 URL 中找到該 ID）。
• 返回：一個 JSON 字符串，包含詳細的接口信息（請求/響應參數、頭、正文模式等）。