Openapi MCP Proxy

🚀 OpenAPI MCP サーバー

このコマンドラインツールは、任意の OpenAPI サービスを Model Context Protocol (MCP) サーバーに変換し、AI エージェントおよび MCP 規格に対応したツールとのシームレスな統合を実現します。

⚠️ 重要提示

このツールはまだ開発の初期段階にあります。 ロードマップはこちらにあります。

🚀 クイックスタート

🔍 何ができるの？

このツールは、OpenAPI サービスを MCP サーバーに変換することで、AI エージェントや MCP 規格に対応したツールとの連携を可能にします。

📦 インストール

npm install -g openapi-mcp-proxy

💻 使用例

基本的な使用法

npx openapi-mcp-proxy --spec ./path/to/openapi.yml --target http://your-api.com --port 3000

オプション

• -s, --spec <パス> (必須): OpenAPI 仕様ファイルのパス (環境変数: OMP_OPENAPI_SPEC_FILE)
• -t, --target <url> (オプション): ターゲット API サービスの URL (デフォルト: "http://localhost:8080", 環境変数:OMP_TARGET_BASE_URL)
• -p, --port <数字> (オプション): MCP サーバーが実行されるポート (デフォルト: "3000", 環境変数: PORT)
• -V, --version: バージョン番号を表示
• -h, --help: ヘルプ情報を表示

例

Petstore API の MCP サーバーを起動するには、次のコマンドを実行します。

npx openapi-mcp-proxy --spec resources/petstore.openapi.yml --target https://petstore.swagger.io/v2

テスト

MCP チェックツール

MCP サーバーをテストするには、次の手順を実行します。

1. チェックツールをインストールします。npm install -g @merossai/mcpx
2. チェックツールを起動します。mcpx <your_api_key> http://localhost:3000

VS Code での設定

VS Code では、Ctrl+Shift+P を押してコマンドパネルを開き、次の手順を実行します。

1. "Remote-Containers: Start Server" を入力して選択します。
2. プロキシ設定を構成します。
   • プロキシ URL: http://localhost:3000
   • ターゲットポートに直接接続する: true

✨ 主な機能

🔍 何が Model Context Protocol (MCP) ですか？

Model Context Protocol (MCP) は、AI エージェントと外部ツールやサービスとの間の相互作用を標準化するプロトコルです。これにより、様々な機能を発見、理解、利用するための統一的な方法が提供され、複数のサービスと相互作用できる AI 駆動のアプリケーションを構築することが容易になります。

🔍 何が OpenAPI ですか？

OpenAPI（以前は Swagger と呼ばれていました）は、RESTful Web サービスを定義、生成、消費、可視化するための機械可読なインターフェイスファイルを記述する標準です。これにより、人間とコンピュータがソースコードや追加のドキュメントにアクセスすることなく、サービスの機能を発見し、理解することができます。

🔍 このプロジェクトについて

このミドルウェアは、OpenAPI サービスと MCP クライアントの間の橋渡し役を果たします。

1. OpenAPI 仕様ファイルを入力として受け取ります。
2. MCP 標準に準拠したサーバーを自動生成します。
3. 実際の OpenAPI サービスへのリクエストを代理します。
4. MCP と REST の規約を変換します。

これにより、OpenAPI 仕様を持つ既存の REST API は、元のサービスを変更することなく、MCP を理解する AI エージェントからすぐにアクセスできるようになります。

📄 ライセンス

このプロジェクトは MIT ライセンスの下で保護されています。