Openapi MCP Server

🚀 OpenAPI MCP 服務器

本項目提供 MCP - Model Context Protocol Server，該服務器配置了 REST API 作為大語言模型（LLM）的上下文，可讓 LLM 與 REST API 交互，並通過 LLM 提示執行 REST API 調用，當前支持 GET/PUT/POST/PATCH 這幾種 HTTP 請求方法。

🚀 快速開始

此項目將安裝 MCP - Model Context Protocol Server，藉助該服務器，我們能夠實現 LLM 與 REST API 的交互，通過 LLM 提示執行 REST API 調用。當前支持的 HTTP 請求方法為 GET/PUT/POST/PATCH。

✨ 主要特性

• 安裝 MCP - Model Context Protocol Server，為 LLM 提供配置好的 REST API 作為上下文。
• 支持 LLM 與 REST API 交互，可通過 LLM 提示執行 REST API 調用。
• 支持 GET/PUT/POST/PATCH 這幾種 HTTP 請求方法。

📦 安裝指南

安裝包

pip install openapi_mcp_server

配置環境變量

在文件夾中創建 .env 文件，設置必要的值以配置 OPENAPI_SPEC_PATH 和 API_BASE_URL。示例文件可在此處下載 這裡。

測試服務器

使用以下命令測試 openapi_mcp_server 服務器：

uv run openapi_mcp_server

💻 使用示例

Claud 桌面配置

{
    "mcpServers": {
        "openapi_mcp_server":{
            "command": "uv",
            "args": ["run","openapi_mcp_server"],
            "env": {
                "DEBUG":"1",
                "API_BASE_URL":"https://petstore.swagger.io/v2",
                "OPENAPI_SPEC_PATH":"https://petstore.swagger.io/v2/swagger.json",
                "API_HEADERS":"Accept:application/json",
                "API_WHITE_LIST":"addPet,updatePet,findPetsByStatus"
            }
        }
    }
}

配置說明

📚 詳細文檔

UV 命令使用

mkdir -m777 openapi_mcp_server
cd openapi_mcp_server
uv init
uv add mcp 協議 協議、協議、協議
uv sync
uv run
uv build

• uv init：初始化項目。
• uv add [依賴項...]：添加所需的依賴項。例如，運行 uv add openapi-spec 協議 可能會自動添加 OpenAPI 相關的依賴項。
• uv sync：同步代碼。
• uv run：運行服務器。
• uv build：構建項目。

這些命令幫助開發者快速初始化、配置和部署 MCP 服務器，確保所有依賴項已正確安裝，並且代碼處於最新狀態。通過這種方式，用戶可以輕鬆地將服務器集成到現有的開發環境中，並進行進一步的自定義和擴展。

📄 許可證

本項目根據 MIT 許可證的條款進行許可。

反饋與支持

如果在使用過程中遇到任何問題或需要進一步的支持，請隨時查閱項目文檔或聯繫維護人員。您的反饋對我們改進項目非常寶貴！