Ivo Toby MCP Openapi Server

🚀 OpenAPI MCP サーバー

このサーバーは、OpenAPI エンドポイントを通じて MCP リソースを提供する Model Context Protocol (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"
      }
    }
  }
}

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 の型を検証します。

📦 インストール

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

環境変数

コマンドライン引数

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"

💻 使用例

基本的な使用法

開発環境を起動します。

npm run inspect-watch

src/ 内の TypeScript ファイルを変更します。サーバーは自動的に再構築および再起動します。MCP インスペクター UI を使用して変更をテストします。

高度な使用法

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

1. 開発モードの場合：
   • ログは inspect-watch を実行しているターミナルに表示されます。
2. 直接実行する場合：

npm run inspect 2>debug.log

📚 ドキュメント

貢献方法

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

npm run typecheck
npm run lint

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