OpenAPIファイルのAI連携

Apidog MCPサーバーは Swagger または OpenAPI仕様書（OAS）を直接読み取り、AIアシスタントが Apidog のプロジェクトやオンライン文書に依存せずに API 仕様を単独で扱えるようにします。

前提条件

MCPクライアントを設定する前に、次を用意してください。

Node.js（バージョン 18 以上、可能であれば最新の LTS）

MCP 対応 IDE

Cursor

VS Code ＋ Cline プラグイン

その他の MCP 対応エディタ

Swagger／OpenAPI ファイル（URL またはローカルパス）

OpenAPI仕様書の準備

次のいずれかを用意してください。

リモート URL：公開アクセス可能な OpenAPI 仕様書（例：https://petstore.swagger.io/v2/swagger.json）

ローカルファイルパス：手元の OpenAPI 仕様書（例：~/data/petstore/swagger.json）

対応形式：JSON または YAML

設定概要

OpenAPI 仕様書向けの基本的な MCP 設定：

macOS / Linux

Windows

{
  "mcpServers": {
    "API specification": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--oas=<oas-url-or-path>"
      ]
    }
  }
}

〈oas-url-or-path〉には次のいずれかを指定します。

リモート URL（例：https://petstore.swagger.io/v2/swagger.json）

ローカルファイルパス（例：~/data/petstore/swagger.json）

Cursor における MCP 設定

MCP設定画面の起動

Cursor エディタを開く

右上の設定アイコンをクリック

左メニューから「MCP」を選択

「+ Add new global MCP server」をクリック

設定の追加

開いた mcp.json に以下の設定を追加します。https://petstore.swagger.io/v2/swagger.json は実際の OpenAPI 仕様書のパスまたは URL に置き換えてください。

macOS / Linux

Windows

{
  "mcpServers": {
    "API specification": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--oas=https://petstore.swagger.io/v2/swagger.json"
      ]
    }
  }
}

設定の検証

Agent モードで AI に問いかけ、接続を確認します。

MCP 経由で API ドキュメントを取得し、このプロジェクトに存在する API の数を教えてください。

AI が OpenAPI 仕様書から正しい API 情報を返せば、接続は成功です。

重要事項

複数のOpenAPI仕様書の利用

複数の OpenAPI 仕様書を使う場合、設定ファイルにMCPサーバーを複数追加し、それぞれ異なる --oas パラメータを指定します。

例：

{
  "mcpServers": {
    "Petstore API": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--oas=https://petstore.swagger.io/v2/swagger.json"
      ]
    },
    "Local API": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--oas=~/data/my-api/openapi.yaml"
      ]
    }
  }
}

ファイルパスおよびURLの要件

ローカルファイルパス：パスが正しく、ファイルが存在することを確認してください。

URL：公開アクセス可能で、有効な OpenAPI 仕様書を返すことを確認してください。

パフォーマンスに関する注意事項

OpenAPI 仕様書のサイズが大きい場合やデータ構造が複雑な場合は、MCPサーバーの処理に時間を要することがあります。

オンプレミス導入

オンプレミス環境では、IDE の MCP 設定にサーバーの API アドレスを含めてください。

{
  "mcpServers": {
    "API specification": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--oas=<oas-url-or-path>",
        "--apidog-api-base-url=<your-server-url>"
      ]
    }
  }
}

〈your-server-url〉はオンプレミスサーバーの API アドレス（http:// または https:// で始まる）に置き換えてください。www.npmjs.com へのネットワークアクセスを確保してください。

その他のデータソース

Apidogプロジェクト内API仕様のAI連携

Apidog公開オンラインAPIドキュメントのAI接続

よくある質問

Windowsにおける設定の問題

標準の設定で動作しない場合は、次の代替案を使用してください。

{
  "mcpServers": {
    "API specification": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "apidog-mcp-server@latest",
        "--oas=<oas-url-or-path>"
      ]
    }
  }
}

Node.jsのバージョンに関する問題

OpenAPIファイルのAI連携

前提条件#

OpenAPI仕様書の準備#

設定概要#

Cursor における MCP 設定#

重要事項#

複数のOpenAPI仕様書の利用#

ファイルパスおよびURLの要件#

パフォーマンスに関する注意事項#

オンプレミス導入#

その他のデータソース#

よくある質問#