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で設定するだけで済みます。
- Claude Desktop 構成ファイルを見つけるか作成します。
- macOSの場合:
~/Library/Application Support/Claude/claude_desktop_config.json
- macOSの場合:
- OpenAPI MCP サーバーを有効にするには、次の構成を追加します。
Copy
- 環境変数を実際の API 構成に置き換えます。
API_BASE_URL
: APIのベースURLOPENAPI_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エンドポイントのベースURLOPENAPI_SPEC_PATH
- OpenAPI 仕様へのパスまたは URLAPI_HEADERS
- APIヘッダーのコンマ区切りのキーと値のペアSERVER_NAME
- MCP サーバーの名前 (デフォルト: "mcp-openapi-server")SERVER_VERSION
- サーバーのバージョン(デフォルト: "1.0.0")
コマンドライン引数
Copy
開発ワークフロー
- 開発環境を起動します。
Copy
src/
内の TypeScript ファイルに変更を加える- サーバーは自動的に再構築され、再起動します
- MCP Inspector UI を使用して変更をテストします
デバッグ
サーバーはデバッグログをstderrに出力します。これらのログを確認するには、以下の手順を実行してください。
- 開発モードの場合:
- ログは
inspect-watch
を実行するターミナルに表示されます。
- ログは
- 直接実行する場合:Copy
貢献
- リポジトリをフォークする
- 機能ブランチを作成する
- 変更を加える
- テストとリンティングを実行します。Copy
- プルリクエストを送信する
ライセンス
マサチューセッツ工科大学
This server cannot be installed
大規模言語モデルがモデル コンテキスト プロトコルを通じて OpenAPI 仕様で定義された REST API を検出し、対話できるようにするサーバー。