MCP Openapi Schema Explorer

🚀 MCP リソーステンプレートを使用した OpenAPI 仕様の探索

MCP リソーステンプレートを使用することで、OpenAPI 仕様を簡単に探索し、理解することができます。このドキュメントでは、MCP リソーステンプレートの使用方法や各種機能について詳しく説明します。

🚀 クイックスタート

📦 インストール

まずは必要な依存関係をインストールします。

pip install -r requirements.txt

🚀 サービスの起動

依存関係のインストールが完了したら、サービスを起動します。

python server.py

✨ 主な機能

MCP リソーステンプレートの詳細

MCP は、OpenAPI 仕様を探索および理解するための複数のリソーステンプレートを提供しています。以下に各リソーステンプレートの詳細を示します。

openapi://{field}

• 説明：このテンプレートは、OpenAPI ドキュメントのトップレベルフィールド（info、servers、tags など）にアクセスするか、paths と components の内容をリストするために使用されます。具体的な利用可能なフィールドは、読み込まれた仕様によって異なります。
• 例：
  • リクエスト：openapi://info
  • レスポンス：info フィールドの内容を JSON/YAML/minified JSON 形式で返します。
  • 自動補完：実際のドキュメント内のトップレベルキーに基づいて、{field} の動的な提案を提供します。
• パラメータ：なし

openapi://paths/{path}

• 説明：特定の API パスがサポートするすべての HTTP メソッド（操作）をリストします。
• パラメータ：
  • {path}：API パス文字列。URL エンコードする必要があります（例：/users/{id} は users%2F%7Bid%7D とエンコードする必要があります）。
• 例：
  • リクエスト：openapi://paths/users%2F%7Bid%7D
  • レスポンス：このパスがサポートするすべての HTTP メソッドをテキスト形式でリストします。
  • 自動補完：ドキュメント内のすべてのパス（URL エンコード後）に基づいて、{path} の動的な提案を提供します。

openapi://paths/{path}/{method*}

• 説明：特定の API パス上の 1 つまたは複数の HTTP メソッドの詳細仕様を取得します。
• パラメータ：
  • {path}：API パス文字列。URL エンコードする必要があります。
  • {method*}：1 つまたは複数の HTTP メソッド（get、post など）。カンマ区切りで指定可能（例：get,post）。大文字と小文字は区別されません。
• 例：
  • 単一のメソッド：openapi://paths/users%2F%7Bid%7D/get
  • 複数のメソッド：openapi://paths/users%2F%7Bid%7D/get,post
• 出力形式：詳細仕様を JSON/YAML/minified JSON 形式で返します。
• 自動補完：{path} の動的な提案と、{method*} の静的な提案（GET、POST、PUT、DELETE などの一般的な HTTP 動詞）を提供します。

openapi://components/{type}

• 説明：特定のタイプのすべての定義コンポーネント（schemas、responses、parameters など）をリストし、簡単な説明を付けます。具体的な利用可能なタイプは、読み込まれた仕様によって異なります。
• 例：
  • リクエスト：openapi://components/schemas
  • レスポンス：すべての schemas タイプのコンポーネントとその説明をテキスト形式でリストします。
  • 自動補完：ドキュメント内のコンポーネントタイプに基づいて、{type} の動的な提案を提供します。

openapi://components/{type}/{name}

• 説明：特定のコンポーネントタイプの詳細情報を取得します。例えば、schema、response、または parameter の具体的な定義を取得できます。
• パラメータ：
  • {type}：コンポーネントのタイプ（schemas など）。
  • {name}：コンポーネントの具体的な名前または識別子。
• 例：
  • リクエスト：openapi://components/schemas/User
  • レスポンス：User コンポーネントの詳細定義を JSON/YAML 形式で返します。

🔧 コントリビューションガイド

コードの提出

まずはリポジトリをクローンします。

git clone https://github.com/yourusername/mcp.git
cd mcp

開発フロー

開発を始める前に、依存関係をインストールし、開発サーバーを起動します。

# 依存関係のインストール
pip install -r requirements.txt

# 開発サーバーの起動
python server.py

🚀 リリースフロー

パッケージング

python setup.py sdist bdist_wheel

PyPI へのリリース

twine upload dist/*

🌟 未来の計画

• より多くの OpenAPI バージョンをサポートする。
• 他の API 形式の解析機能を追加する。
• ユーザー体験を向上させるためのインタラクティブなインターフェースを提供する。

以上のドキュメントでは、MCP リソーステンプレートを使用して OpenAPI 仕様を探索および理解する方法を詳細に説明しました。これらのテンプレートを使用することで、API のさまざまな情報を簡単に取得し、詳細な分析を行うことができます。