Swagger MCP Server

🚀 Swagger/OpenAPI MCP Server

このサーバーは、大規模言語モデル（LLM）がSwagger/OpenAPI仕様を探索し、対話できるようにするModel Context Protocol（MCP）サーバーです。API仕様の読み込み、エンドポイントの閲覧、API操作の詳細情報の取得などのツールとリソースを提供します。

🚀 クイックスタート

このセクションでは、Swagger/OpenAPI MCP Serverのインストールと使用方法について説明します。

📦 インストール

以下の手順に従って、Swagger/OpenAPI MCP Serverをインストールします。

1. プロジェクトディレクトリをクローンまたは作成します。
2. 依存関係をインストールします：

npm install

3. TypeScriptコードをビルドします：

npm run build

💻 使用例

利用可能なツール

load_api

OpenAPI/Swagger仕様をサーバーに読み込みます。

パラメーター:

• apiId (string): このAPIの一意の識別子
• source (string): OpenAPI/Swagger仕様のURLまたはファイルパス

例:

{
  "name": "load_api",
  "arguments": {
    "apiId": "petstore",
    "source": "https://petstore.swagger.io/v2/swagger.json"
  }
}

get_endpoint_details

特定のAPIエンドポイントの詳細情報を取得します。

パラメーター:

• apiId (string): 読み込まれたAPIのID
• method (string): HTTPメソッド (GET、POSTなど)
• path (string): APIエンドポイントのパス
• natural (boolean, オプション): trueの場合、人間が読みやすい要約を返します

例:

{
  "name": "get_endpoint_details",
  "arguments": {
    "apiId": "petstore",
    "method": "GET",
    "path": "/pet/{petId}",
    "natural": true
  }
}

list_apis

現在読み込まれているすべてのAPI仕様をリストします。

パラメーター: なし

search_endpoints

特定のパターンに一致するエンドポイントを検索します。

パラメーター:

• apiId (string): 読み込まれたAPIのID
• pattern (string): エンドポイントのパスまたは説明の検索パターン

例:

{
  "name": "search_endpoints",
  "arguments": {
    "apiId": "petstore",
    "pattern": "pet"
  }
}

利用可能なリソース

swagger://{apiId}/load

読み込まれたAPI仕様の概要情報を取得します。

swagger://{apiId}/endpoints

APIの利用可能なすべてのエンドポイントのリストを取得します。

swagger://{apiId}/endpoint/{method}/{path}

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

📚 ドキュメント

Claude Desktopとの設定

Claude Desktopでこのサーバーを使用するには、claude_desktop_config.jsonに以下を追加します。

{
  "mcpServers": {
    "swagger-explorer": {
      "command": "node",
      "args": ["/path/to/your/swagger-mcp-server/build/index.js"]
    }
  }
}

/path/to/your/swagger-mcp-serverを実際のプロジェクトディレクトリのパスに置き換えてください。

📄 ライセンス

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