Swagger

🚀 swagger-mcp 中文文檔

swagger-mcp 是一款專門用於抓取 Swagger UI 的實用工具。它能夠提取 swagger.json 文件，並動態生成規範化的 mcp 工具，供 MCP 客戶端在運行時選擇和使用，大大提升了相關操作的便捷性。

🚀 快速開始

先決條件

在使用 swagger-mcp 之前，請確保已經安裝以下依賴：

1. LLM 模型 API 密鑰 / 本地 LLM：需要具備 OpenAI、Claude 或 Ollama 模型的訪問權限。
2. 任何 MCP 客戶端：示例使用 mark3labs - mcphost。

安裝與配置

按照以下步驟安裝並運行 swagger-mcp：

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

運行配置

直接運行 swagger-mcp 時可使用如下命令：

swagger-mcp --specUrl=https://your_swagger_api_docs.json

主要參數說明：

• --specUrl：Swagger/OpenAPI JSON URL（必需）
• --sseMode：以 SSE 模式運行（默認：false，若為 true 則作為 SSE 服務器運行，否則使用標準輸入輸出）
• --sseAddr：SSE 服務器監聽地址，格式為 IP:Port 或 :Port（若為空，則根據 --sseUrl 自動補全）
• --sseUrl：SSE 服務器基礎 URL（若為空，默認生成 http://IP:Port 或 http://localhost:Port）
• 若同時設置 --sseAddr 和 --sseUrl，請參考具體文檔
• 其他參數請查閱工具說明

MCP 配置

在 .mcp.json 文件中對 mcphost 進行如下配置：

{
  "swagger-mcp": {
    "url": "https://your_swagger_api_docs.json",
    "sseMode": false,
    "sseAddr": ":8080"
  }
}

演示流程

後端、Ollama 和 MCP 客戶端的運行命令如下：

# 後端服務
go run main.go

# Ollama 服務
ollama serve --model gpt-3

# MCP 客戶端
go run client.go

✨ 主要特性

• 能夠抓取 Swagger UI，提取 swagger.json 文件。
• 動態生成規範化的 mcp 工具，供 MCP 客戶端在運行時選擇和使用。

📽️ 演示視頻

你可以觀看演示視頻來了解項目的具體功能：

🙌 支持

如果你認為這個項目有價值，請在 LinkedIn 上給予支持：

• 👍 點贊並分享我的演示帖子
• 💬 在評論區留下你的想法和反饋
• 🔗 關注我以獲取未來的更新動態

你的支持將有助於我觸達更多用戶，並持續改進項目！

📚 詳細文檔

流程圖

若你想查看項目的流程圖，請參考此鏈接：流程圖鏈接

🔧 技術細節

用戶提到了以下有待完善的部分：

• 工具定義：需要採用更規範化的工具定義方式，以提升工具的可用性。
• LLM 行為控制：需增強對 LLM 模型的控制能力，確保其輸出符合預期。
• 上下文管理：優化上下文處理機制，提高對話的連貫性。
• 錯誤處理：加強異常檢測與恢復機制，提升工具的魯棒性。

這些改進將使 swagger-mcp 更加完善，歡迎你提供反饋和建議！