Swagger MCP Server

🚀 Swagger/OpenAPI MCP Server

Swagger/OpenAPI MCP Server 是一個模型上下文協議（MCP）服務器，它允許大語言模型（LLMs）探索 Swagger/OpenAPI 規範並與之交互。該服務器提供了用於加載 API 規範、瀏覽端點以及獲取 API 操作詳細信息的工具和資源。

🚀 快速開始

本部分將引導你完成 Swagger/OpenAPI MCP Server 的安裝與使用。

📦 安裝指南

按照以下步驟安裝 Swagger/OpenAPI MCP Server：

1. 克隆或創建項目目錄。
2. 安裝依賴項：

npm install

3. 構建 TypeScript 代碼：

npm run build

💻 使用示例

可用工具

load_api

將 OpenAPI/Swagger 規範加載到服務器中。 參數：

• apiId（字符串）：此 API 的唯一標識符。
• source（字符串）：OpenAPI/Swagger 規範的 URL 或文件路徑。 示例：

{
  "name": "load_api",
  "arguments": {
    "apiId": "petstore",
    "source": "https://petstore.swagger.io/v2/swagger.json"
  }
}

get_endpoint_details

獲取特定 API 端點的詳細信息。 參數：

• apiId（字符串）：已加載 API 的 ID。
• method（字符串）：HTTP 方法（GET、POST 等）。
• path（字符串）：API 端點路徑。
• natural（布爾值，可選）：如果為 true，則返回人類可讀的摘要。 示例：

{
  "name": "get_endpoint_details",
  "arguments": {
    "apiId": "petstore",
    "method": "GET",
    "path": "/pet/{petId}",
    "natural": true
  }
}

list_apis

列出所有當前已加載的 API 規範。 參數： 無

search_endpoints

搜索匹配特定模式的端點。 參數：

• apiId（字符串）：已加載 API 的 ID。
• pattern（字符串）：端點路徑或描述的搜索模式。 示例：

{
  "name": "search_endpoints",
  "arguments": {
    "apiId": "petstore",
    "pattern": "pet"
  }
}

可用資源

swagger://{apiId}/load

獲取已加載 API 規範的概述信息。

swagger://{apiId}/endpoints

獲取 API 的所有可用端點列表。

swagger://{apiId}/endpoint/{method}/{path}

獲取特定端點的詳細信息。

📚 詳細文檔

與 Claude Desktop 進行配置

要將此服務器與 Claude Desktop 一起使用，請在 claude_desktop_config.json 中添加以下內容：

{
  "mcpServers": {
    "swagger-explorer": {
      "command": "node",
      "args": ["/path/to/your/swagger-mcp-server/build/index.js"]
    }
  }
}

請將 /path/to/your/swagger-mcp-server 替換為你項目目錄的實際路徑。

📄 許可證

本項目採用 MIT 許可證。