MCP Openapi Server

🚀 OpenAPI MCP サーバー

OpenAPI エンドポイントを通じて MCP リソースとして公開されるモデルコンテキストプロトコル (MCP) サーバーです。このサーバーにより、大規模言語モデルは MCP プロトコルを介して、OpenAPI 仕様で定義された REST API を検出し、相互作用することができます。

🚀 クイックスタート

この MCP サーバーを使用するには、このリポジトリをクローンする必要はありません。Claude デスクトップで設定するだけです。

1. Claude デスクトップの設定ファイルを見つけるか作成します。

   • macOS の場合：~/Library/Application Support/Claude/claude_desktop_config.json

2. 以下の設定を追加して、OpenAPI MCP サーバーを有効にします。

{
  "mcpServers": {
    "openapi": {
      "command": "npx",
      "args": ["-y", "@ivotoby/openapi-mcp-server"],
      "env": {
        "API_BASE_URL": "https://api.example.com",
        "OPENAPI_SPEC_PATH": "https://api.example.com/openapi.json",
        "API_HEADERS": "Authorization:Bearer token123,X-API-Key:your-api-key"
      }
    }
  }
}

3. 環境変数を実際の API 設定に置き換えます。
   • API_BASE_URL：API のベース URL
   • OPENAPI_SPEC_PATH：OpenAPI 仕様の URL またはパス
   • API_HEADERS：API 認証に使用するカンマ区切りのキーと値のペア

✨ 主な機能

このプロジェクトには、開発ワークフローを簡素化するためのいくつかの開発ツールが含まれています。

ビルド

• npm run build - TypeScript ソースコードをコンパイルします。
• npm run clean - ビルドアーティファクトを削除します。
• npm run typecheck - TypeScript の型チェックを実行します。

開発モード

• npm run dev - ソースファイルを監視し、変更があった場合に再構築します。
• npm run inspect-watch - インスペクターを実行し、変更があった場合に自動的に再読み込みします。

コード品質

• npm run lint - ESLint を実行します。
• npm run typecheck - TypeScript の型を検証します。

📦 インストール

サーバーは、環境変数またはコマンドライン引数で構成できます。

環境変数

• API_BASE_URL - API エンドポイントのベース URL
• OPENAPI_SPEC_PATH - OpenAPI 仕様のパスまたは URL
• API_HEADERS - API ヘッダーに使用するカンマ区切りのキーと値のペア
• SERVER_NAME - MCP サーバーの名前（デフォルト： "mcp-openapi-server"）
• SERVER_VERSION - サーバーのバージョン（デフォルト： "1.0.0"）

コマンドライン引数

npm run inspect -- \
  --api-base-url https://api.example.com \
  --openapi-spec https://api.example.com/openapi.json \
  --headers "Authorization:Bearer token123,X-API-Key:your-api-key" \
  --name "my-mcp-server" \
  --version "1.0.0"

📚 ドキュメント

開発ワークフロー

1. 開発環境を起動します。

npm run inspect-watch

2. src/ の TypeScript ファイルを変更します。
3. サーバーは自動的に再構築され、再起動します。
4. MCP インスペクター UI を使用して変更をテストします。

デバッグ

サーバーはデバッグログを標準エラー出力に出力します。これらのログを表示するには：

1. 開発モードの場合：

   • ログは inspect-watch を実行しているターミナルに表示されます。

2. 直接実行する場合：

npm run inspect 2>debug.log

貢献方法

1. リポジトリをフォークします。
2. 機能ブランチを作成します。
3. 変更を加えます。
4. テストと linting を実行します。

npm run typecheck
npm run lint

5. プルリクエストを送信します。

📄 ライセンス

MIT