Swagger/OpenAPI MCP Server

一个模型上下文协议（MCP）服务器，允许大型语言模型（LLMs）探索和与Swagger/OpenAPI规范进行交互。此服务器提供了加载API规范、浏览端点以及获取API操作详细信息的工具和资源。

安装

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许可证