Swagger MCP Server

🚀 Swagger/OpenAPI MCP 服务器

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

🚀 快速开始

本服务器支持大语言模型探索和与 Swagger/OpenAPI 规范交互，下面为您介绍安装和使用方法。

📦 安装指南

1. 克隆项目或创建项目目录。
2. 安装依赖：

npm install

3. 构建 TypeScript 代码：

npm run build

💻 使用示例

基础用法

本服务器提供了一系列工具和资源，用于与 Swagger/OpenAPI 规范进行交互。以下是可用工具和资源的详细介绍。

可用工具

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