Openapi Proxy

🚀 OpenAPI MCP サーバー

任意の OpenAPI サービスを Model Context Protocol (MCP) サーバーに変換するコマンドラインツールです。これにより、AI エージェントや MCP 規格に対応したツールとのシームレスな統合が可能になります。

⚠️ 重要提示

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

🚀 クイックスタート

このツールを使用することで、OpenAPI サービスを MCP サーバーに簡単に変換できます。以下に、基本的な使い方を示します。

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

オプション

例

Petstore API の MCP サーバーを起動する例：

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

✨ 主な機能

このツールは、OpenAPI サービスと MCP クライアントの間の橋渡しとして機能します。具体的には以下のようなことができます。

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

これにより、OpenAPI 仕様を持つ既存の REST API を、元のサービスを変更することなく、MCP を理解する AI エージェントにすぐに利用可能にすることができます。

📦 インストール

npm install -g openapi-mcp-proxy

💻 使用例

基本的な使用法

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

高度な使用法

# 環境変数を使用して設定を行う例
export OMP_OPENAPI_SPEC_FILE=./path/to/openapi.yml
export OMP_TARGET_BASE_URL=http://your-api.com
export PORT=3000
npx openapi-mcp-proxy

📚 ドキュメント

什么是 Model Context Protocol (MCP)?

モデルコンテキストプロトコル（MCP）は、AI エージェントが外部のツールやサービスとやり取りするための標準プロトコルです。これにより、AI モデルはさまざまな機能を発見、理解、利用するための統一された方法を持つことができ、複数のサービスをサポートする AI 駆動のアプリケーションを構築するプロセスが簡素化されます。

什么是 OpenAPI?

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

テスト

MCP インスペクター

MCP サーバーをテストするには、Model Context Protocol Inspector を使用することができます。

1. MCP インスペクターをインストールします。

npx @modelcontextprotocol/inspector

2. MCP サーバーを起動します。
3. インスペクターのインターフェイスを開き、正しいサーバーパス（/mcp で終わる）を入力します。例えば、http://localhost:3000/mcp です。
4. これで、MCP インスペクターを介して MCP サーバーとやり取りすることができます。インスペクターはリクエストとレスポンスの詳細情報を表示します。

VS Code 使用方法

1. VS Code を開き、MCP プロキシ プラグインをインストールします。
2. MCP サーバーを起動した後、以下の手順でプロキシを設定します。
   • 右下のプロキシアイコンをクリックします。
   • "Add Proxy" を選択します。
   • プロキシ名とアドレス（例：http://localhost:3000）を入力します。
3. プロジェクトでプロキシ構成ファイル（例：.mcp-proxy.json）を設定します。

{
  "proxies": {
    "my-api": {
      "target": "https://petstore.swagger.io/v2",
      "proxyUrl": "http://localhost:3000"
    }
  }
}

📄 ライセンス

このプロジェクトは MIT ライセンスに従います。詳細については LICENSE ファイルを参照してください。