Openapi MCP

🚀 OpenAPI からモデルコンテキストプロトコル (MCP) プロキシ

OpenAPI-MCP プロキシは、OpenAPI 仕様を MCP ツールに変換し、AI エージェントがカスタムラッパーなしで外部 API にアクセスできるようにします！

このプロジェクトは、AI エージェントと外部 API の間のギャップを埋めるためのものです。OpenAPI 仕様を動的に変換し、標準化された MCP ツール、リソース、およびプロンプトを生成します。

🚀 クイックスタート

依存関係のインストール

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 クライアント認証フローを統合し、認証ロジックを簡素化し、セキュリティを向上させます。

📦 インストール

環境変数の設定

以下は、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 で⭐を付けてください！