Swagger MCP

🚀 SwaggerベースのMCPサーバー

このサーバーは、Model Context Protocol（MCP）を使用してSwagger/OpenAPI仕様を処理します。

✨ 主な機能

• Swagger/OpenAPI仕様の読み込み
• 複数の認証方法をサポート：
  • 基本認証
  • Bearer Token
  • API Key（ヘッダーまたはクエリ）
  • OAuth2
• APIエンドポイントからMCPツールを自動生成
• リアルタイム通信のためのServer-Sent Events (SSE) のサポート
• TypeScriptのサポート

⚠️ セキュリティ

これは個人用のサーバーです！公共のインターネットに公開しないでください。 基盤となるAPIに認証が必要な場合、MCPサーバーを公共のインターネットに公開しないでください。

📋 今後の予定

• シークレット - MCPサーバーはユーザーのシークレットを使用してリクエストを認証できるようにする
• 包括的なテストセット

📦 インストール

前提条件

• Node.js（v18以上）
• Yarnパッケージマネージャー
• TypeScript

インストール手順

1. リポジトリをクローンします：

git clone https://github.com/dcolley/swagger-mcp.git
cd swagger-mcp

2. 依存関係をインストールします：

yarn install

3. サンプルに基づいて.envファイルを作成します：

cp .env.example .env

4. Swagger/OpenAPI仕様を設定します：
   • Swaggerファイルをプロジェクト内に配置します（例：swagger.json）
   • または、Swagger仕様へのURLを指定します
5. config.jsonでサーバー設定を更新します：

{
  "server": {
    "host": "localhost",
    "port": 3000
  },
  "swagger": {
    "url": "url-or-path/to/your/swagger.json",
    "apiBaseUrl": "https://api.example.com",  // Swaggerで指定されていない場合の代替URL
    "defaultAuth": {  // Swaggerで認証スキームが指定されていない場合の代替設定
      "type": "apiKey",
      "apiKey": "your-api-key",
      "name": "Authorization",
      "value": "Bearer ${ apiKey }"
    }
  }
}

💻 使用例

開発サーバーの起動

yarn dev

本番環境のビルド

yarn build

📚 ドキュメント

APIエンドポイント

すべてのドキュメントを取得

GET /api-docs

名前でドキュメントを取得

GET /api-docs/{name}

ドキュメントを公開

POST /api-docs

ドキュメントを削除

DELETE /api-docs/{name}

テスト

テストを実行

yarn test

環境に応じてテストを実行

yarn test:dev

カバレッジに応じてテストを実行

yarn test:cov

認証方法

基本認証

設定例：

{
  "defaultAuth": {
    "type": "basic",
    "username": "your-username",
    "password": "your-password"
  }
}

Bearer Token

設定例：

{
  "defaultAuth": {
    "type": "bearer",
    "token": "your-bearer-token"
  }
}

API Key

設定例：

{
  "defaultAuth": {
    "type": "apiKey",
    "key": "your-api-key",
    "name": "X-API-Key",
    "value": "${ key }"
  }
}

OAuth2

設定例：

{
  "defaultAuth": {
    "type": "oauth2",
    "clientId": "your-client-id",
    "clientSecret": "your-client-secret",
    "accessTokenUrl": "https://example.com/oauth/token",
    "authorizationUrl": "https://example.com/oauth/authorize"
  }
}

環境変数

• NEXT_PUBLIC_API_BASE_URL - デフォルトのAPIベースURL
• NEXT_PUBLIC_SWAGGER_URL - デフォルトのSwagger仕様のURL