Openapi To Mcpserver

🚀 OpenAPI から MCP への変換ツール

このツールは、OpenAPI 仕様ファイルを MCP サーバーに変換します。このサーバーを使用することで、既存の OpenAPI 仕様で記述された Web API とのやり取りが可能になります。

これにより、AI エージェントやその他の MCP に対応したクライアントが、既存の OpenAPI 仕様で記述された Web API とやり取りできるようになります。

✨ 主な機能

• OpenAPI 操作を自動的に MCP ツールに変換します。
• 最新のストリーミング HTTP と従来の SSE トランスポートをサポートします。
• OpenAPI 仕様から API のベース URL を自動的に検出します。
• OpenAPI/Swagger 2.0 と OpenAPI 3.x をサポートします。
• バイナリ応答を処理します。
• サーバーの正常なシャットダウンを処理します。
• デバッグ用の詳細なログ記録を行います。

📦 インストール

前提条件

• Node.js（推奨 v16 以上）

インストール手順

1. リポジトリをクローンする（または openapi-to-mcp ディレクトリがあることを確認する）。
2. openapi-to-mcp ディレクトリに移動する：

   cd openapi-to-mcp
   

3. 依存関係をインストールする：

   npm install
   

📚 ドキュメント

ビルド

TypeScript コードを JavaScript にコンパイルする：

npm run build

これにより、プロジェクト内に dist ディレクトリが作成され、コンパイルされた JavaScript ファイルが含まれます。

使用方法

start スクリプトを使用してサーバーを起動し、OpenAPI 仕様ファイルのパスを -f または --file オプションで指定する：

# 例：ローカルの petstore.yaml ファイルを使用する
npm start -- serve -f ./path/to/your/openapi.json

# 例：異なるポートとホストを指定する
npm start -- serve --file ./specs/petstore.json --port 9090 --host 0.0.0.0

• ./path/to/your/openapi.json を実際の OpenAPI ファイルのパスに置き換えてください。
• サーバーはファイルを解析し、API 操作を MCP 関数に適合させ、リッスンを開始します。
• 最新および従来の MCP 接続に使用できるエンドポイントが表示されます。

MCP クライアントとして接続する

最新の接続（推奨）

サーバーは MCP SDK で管理される最新のストリーミング HTTP トランスポートを提供します。これが推奨される接続方法です。

従来の SSE 接続

旧バージョンとの互換性のため、サーバーは SSE 接続もサポートしています：

1. SSE エンドポイント（例：http://localhost:8080/sse）に接続します。
2. 接続時に mcp-hello イベントを受け取ります。
3. 関数を呼び出すには、/messages エンドポイントに POST リクエストを送信し、sessionId クエリパラメータを SSE 接続 ID と一致させます。 例：/messages?sessionId=<your_session_id> に POST リクエストを送信する ヘッダー：

   Content-Type: application/json
   

   本文：

   {
     "type": "function_call",
     "id": "call-123",
     "function_name": "get_pets_by_status",
     "parameters": {
       "status": "available"
     }
   }
   

4. サーバーは対応する API 呼び出しを実行し、確立された SSE 接続を介して function_return または error イベントを送信します。

開発

自動再コンパイルを伴う開発モードで実行する：

# OpenAPI ファイルのパスを必ず指定する
npm run dev -- -f ./path/to/your/openapi.yaml

現在の制限事項

• 認証：未実装です。
• スキーマ検証：基本的なスキーマ検証は実装されていますが、一部の複雑な OpenAPI スキーマ機能（区分器、複雑な組み合わせなど）は完全にサポートされていない場合があります。
• テスト：現在、自動化されたテストは含まれていません。
• ドキュメント：単一のツールドキュメントは、より多くの例やパラメータの説明で改善することができます。