Openapi MCP

🚀 OpenAPI 到模型上下文協議 (MCP) 代理

OpenAPI 到模型上下文協議 (MCP) 代理可將 OpenAPI 規範轉換為 MCP 工具，讓 AI 代理無需自定義包裝器就能訪問外部 API，有效解決了 AI 代理與外部 API 交互的難題。

🚀 快速開始

安裝依賴

pip install openapi-mcp-proxy

初始化代理

from openapi_mcp_proxy import MCPProxy

proxy = MCPProxy(openapi_spec_path="path/to/spec.yaml")

獲取工具信息

tools_info = proxy.list_tools()
print(tools_info)

✨ 主要特性

• OpenAPI 到 MCP 轉換：把 OpenAPI 規範轉換為模型上下文協議 (MCP)，供 AI 工具鏈（如 Claude、GPT）使用。
• 工具支持：自動生成的工具具備 API 請求、響應處理和參數解析功能，簡化與外部系統的交互。
• 資源管理：從 OpenAPI 組件模式生成資源對象，註冊為 URI（如 /resource/{name}），方便進行結構化數據處理。
• 提示語集成：自動生成上下文提示語，幫助 AI 理解 API 功能和使用方法，提升交互體驗。
• OAuth2 支持：集成 OAuth2 客戶端憑證流程，簡化身份驗證邏輯，增強安全性。

📦 安裝指南

安裝依賴

pip install openapi-mcp-proxy

初始化代理

from openapi_mcp_proxy import MCPProxy

proxy = MCPProxy(openapi_spec_path="path/to/spec.yaml")

💻 使用示例

基礎用法

from openapi_mcp_proxy import MCPProxy

# 初始化代理
proxy = MCPProxy(openapi_spec_path="path/to/spec.yaml")

# 獲取工具信息
tools_info = proxy.list_tools()
print(tools_info)

📚 詳細文檔

環境變量配置

以下是運行 OpenAPI-MCP 代理所需的環境變量：

工作原理

sequenceDiagram
    參與者 LLM 作為 LLM (Claude/GPT)
    參與者 MCP 作為 OpenAPI-MCP 代理
    參與者 API 作為 外部 API

    註釋 在 LLM 和 API 之間：通信流程

    LLM->>MCP: 1. 初始化 (initialize)
    MCP-->>LLM: 元數據、工具、資源和提示語

    LLM->>MCP: 2. 請求工具列表 (tools_list)
    MCP-->>LLM: 工具的詳細列表，包括資源和提示語

    LLM->>MCP: 3. 調用工具 (tools_call)

    alt 使用 OAuth2
        MCP->>API: 請求 OAuth2 令牌
        API-->>MCP: 訪問令牌
    end

    MCP->>API: 4. 執行 API 調用，格式正確
    API-->>MCP: 5. API 響應（JSON 格式）

    alt 類型轉換
        MCP->>MCP: 6. 將參數轉換為正確的數據類型
    end

    MCP-->>LLM: 7. 格式化的響應結果

    alt 幹運行模式
        LLM->>MCP: 調用 dry_run=true
        MCP-->>LLM: 顯示請求信息，不執行調用
    end

資源與提示語

除了工具之外，代理服務器還自動註冊了以下內容：

• 資源：從 OpenAPI 組件模式生成的資源對象，註冊為定義的 URI（如 /resource/{name}），便於結構化數據處理。
• 提示語：根據 API 操作自動生成上下文提示語，幫助 LLM 理解 API 的功能和使用方法。

這種擴展的元數據提升了集成體驗，提供了全面的 API 上下文信息。

貢獻指南

1. ** Fork 該倉庫。
2. 在你的分支中創建新的功能或修復問題。
3. 提交 Pull Request，附上清晰的更改說明。

📄 許可證

MIT License

如果你覺得這個項目對你有幫助，請在 GitHub 上給我一個 ⭐！