使用说明

项目简介

'swagger-mcp' 是一个工具，它通过自动将 Swagger API 规范转换为 MCP（模型上下文协议）工具，简化了 REST API 与大型语言模型（LLM）的集成。这使得 LLM 能够无缝访问和利用 RESTful 服务公开的功能。

主要功能点

动态工具生成：从给定的 Swagger/OpenAPI 规范 URL 自动创建 MCP 工具。
REST API 到 MCP 的桥梁：使 LLM 能够与任何由 Swagger 文档描述的 REST API 进行交互。
与 MCP 客户端集成：设计用于与 'mcphost' 等 MCP 客户端配合使用，从而可以轻松部署和使用生成的工具。
支持 Stdio 和 SSE：为不同的部署场景提供通信协议的灵活性。

安装步骤

安装 'swagger-mcp'： 打开终端并运行以下命令来安装 'swagger-mcp' 工具：

go install github.com/danishjsheikh/swagger-mcp@latest

确保前提条件：
- 您需要访问 LLM 模型（例如 OpenAI、Claude 或 Ollama）和 MCP 客户端（例如 'mcphost'）。

服务器配置

要将 'swagger-mcp' 与 MCP 客户端一起使用，您需要配置客户端以连接到 'swagger-mcp' 服务器。以下是您可以与 'mcphost' 一起使用的 '.mcp.json' 的示例配置。将 '<swagger/doc.json_url>' 替换为您的 Swagger/OpenAPI JSON 文件的实际 URL。

{
    "mcpServers": {
        "swagger_api_tools": {  // 服务器名称（您可以选择任何名称）
            "command": "swagger-mcp", // 运行服务器的命令
            "args": ["<swagger/doc.json_url>"] // 命令的参数，需要 Swagger JSON URL
        }
    }
}

基本使用方法

启动 'swagger-mcp' 服务器： 在终端中运行 'swagger-mcp' 命令，并提供 Swagger JSON URL 作为参数。例如：

swagger-mcp <swagger/doc.json_url>

或者，如果您想使用 SSE 模式，请运行：

swagger-mcp --sse <swagger/doc.json_url>

配置并运行 MCP 客户端： 使用在“服务器配置”步骤中创建的 '.mcp.json' 文件配置您的 MCP 客户端（例如 'mcphost'）。然后，运行 MCP 客户端。例如，使用 'mcphost'：
```
mcphost --config <.mcp.json_file_path> -m <your_llm_model>
```
将 '<.mcp.json_file_path>' 替换为您的 '.mcp.json' 文件的路径，并将 '<your_llm_model>' 替换为您所需的 LLM 模型（例如，'ollama:llama3.2'）。
与 LLM 交互： 现在，您可以通过 MCP 客户端与您的 LLM 交互。当 LLM 需要访问 Swagger 文档描述的 REST API 中的功能时，它将能够使用 'swagger-mcp' 服务器提供的工具。

关键词