Openapi Schema

🚀 OpenAPI モデルコンテキストプロトコルサーバ

このサーバは、モデルコンテキストプロトコル（MCP）を使用して、Claudeなどの大規模言語モデル（LLMs）にOpenAPIスキーマ情報を公開します。LLMがOpenAPI仕様を探索し理解できるように、一連の専用ツールを通じて情報を提供します。

✨ 主な機能

• コマンドライン引数で指定することで、任意のOpenAPIスキーマファイル（JSONまたはYAML）を読み込むことができます。
• APIのパス、操作、パラメータ、およびスキーマを探索できます。
• リクエストとレスポンスの詳細なスキーマを確認できます。
• コンポーネント定義とサンプルを検索できます。
• 全体のAPI仕様内で検索を行うことができます。
• LLMがより理解しやすいように、YAML形式でレスポンスを取得できます。

📦 インストール

コマンドライン

MCPサーバを実行し、特定のスキーマファイルを指定する方法は次の通りです。

# 現在のディレクトリ内のデフォルトのopenapi.yamlファイルを使用
npx -y mcp-openapi-schema

# 相対パスで特定のスキーマファイルを使用
npx -y mcp-openapi-schema ../petstore.json

# 絶対パスで特定のスキーマファイルを使用
npx -y mcp-openapi-schema /absolute/path/to/api-spec.yaml

# ヘルプ情報を表示
npx -y mcp-openapi-schema --help

Claudeデスクトップ統合

このMCPサーバをClaude Desktopと一緒に使用するには、claude_desktop_config.json設定ファイルを編集します。

{
  "mcpServers": {
    "OpenAPI Schema": {
      "command": "npx",
      "args": ["-y", "mcp-openapi-schema", "/ABSOLUTE/PATH/TO/openapi.yaml"]
    }
  }
}

設定ファイルの場所は次の通りです。

• macOS/Linux: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: $env:AppData\Claude\claude_desktop_config.json

Claude Code統合

このMCPサーバをClaude Code CLIと一緒に使用するには、以下の手順に従います。

1. Claude CodeにOpenAPI Schema MCPサーバを追加する

# 基本構文
claude mcp add openapi-schema npx -y mcp-openapi-schema

# 特定のスキーマファイルを指定する例
claude mcp add petstore-api npx -y mcp-openapi-schema ~/Projects/petstore.yaml

2. 登録されたサーバを検証する

# すべての設定されたサーバをリストする
claude mcp list

# OpenAPIスキーマサーバの詳細情報を取得する
claude mcp get openapi-schema

3. 必要に応じてサーバを削除する

claude mcp remove openapi-schema

4. Claude Codeでツールを使用する 設定が完了したら、Claude Codeセッション内でOpenAPIスキーマに関する質問をすることで、このツールを呼び出すことができます。

ヒント：

• -sまたは--scopeフラグを使用して、project（デフォルト）またはglobalで設定の保存場所を指定します。
• 異なるAPIに対して複数のMCPサーバを追加し、異なる名前を使用します。

💻 使用例

基本的な使用法

このサーバはLLMにOpenAPIスキーマと対話するための以下のツールを提供します。

• list-endpoints: すべてのAPIパスとそのHTTPメソッドおよび概要を、ネストされたオブジェクト構造でリストします。
• get-endpoint: 特定のエンドポイントの詳細情報を取得します。これにはパラメータとレスポンスが含まれます。
• get-request-body: 特定のエンドポイントとメソッドのリクエストボディスキーマを取得します。
• get-response-schema: 特定のエンドポイント、メソッド、およびステータスコードのレスポンススキーマを取得します。
• get-path-parameters: 特定のパスのパラメータを取得します。
• list-components: すべてのコンポーネント（schemas、parametersなど）をリストします。
• get-component: 特定のコンポーネントの詳細情報を取得します。
• list-tags: すべてのタグをリストします。
• get-tag: 特定のタグの詳細情報を取得します。

高度な使用法

すべてのエンドポイントを列挙する

operation:
  name: list-endpoints
  parameters:
    - name: filter
      type: string
      description: フィルタ条件（オプション）

特定のエンドポイントの詳細情報を取得する

operation:
  name: get-endpoint
  parameters:
    - name: endpointId
      type: string
      required: true
      description: エンドポイントID

リクエストボディスキーマを取得する

operation:
  name: get-request-body
  parameters:
    - name: requestId
      type: string
      required: true
      description: リクエストID

レスポンススキーマを取得する

operation:
  name: get-response-schema
  parameters:
    - name: responseId
      type: string
      required: true
      description: レスポンスID

サンプルクエリ

curl -X GET "http://localhost:8080/api-docs"