OpenAPI MCP Server

hybrid server

The server is able to function both locally and remotely, depending on the configuration or use case.

OpenAPI MCP サーバー

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

クイックスタート

このMCPサーバーを使用するためにリポジトリをクローンする必要はありません。Claude Desktopで設定するだけで済みます。

  1. Claude Desktop 構成ファイルを見つけるか作成します。
    • 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" } } } }
  1. 環境変数を実際の 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
  1. src/内の TypeScript ファイルに変更を加える
  2. サーバーは自動的に再構築され、再起動します
  3. MCP Inspector UI を使用して変更をテストします

デバッグ

サーバーはデバッグログをstderrに出力します。これらのログを確認するには、以下の手順を実行してください。

  1. 開発モードの場合:
    • ログはinspect-watchを実行するターミナルに表示されます。
  2. 直接実行する場合:
    npm run inspect 2>debug.log

貢献

  1. リポジトリをフォークする
  2. 機能ブランチを作成する
  3. 変更を加える
  4. テストとリンティングを実行します。
    npm run typecheck npm run lint
  5. プルリクエストを送信する

ライセンス

マサチューセッツ工科大学

-
security - not tested
F
license - not found
-
quality - not tested

大規模言語モデルがモデル コンテキスト プロトコルを通じて OpenAPI 仕様で定義された REST API を検出し、対話できるようにするサーバー。

  1. Quick Start
    1. Development Tools
      1. Building
      2. Development Mode
      3. Code Quality
    2. Configuration
      1. Environment Variables
      2. Command Line Arguments
    3. Development Workflow
      1. Debugging
        1. Contributing
          1. License
            ID: org9aj8cva