Snaggle Ai Openapi MCP Server

🚀 OpenAPI MCP サーバー

Claude Desktop を通じて、OpenAPI（v3.1）に準拠した任意の API と簡単に会話できます！

このツールは、Model Context Protocol (MCP) サーバーを作成し、OpenAPI v3.1 仕様を持つ任意の API の代理として機能します。これにより、Claude Desktop を使用して、ローカルおよびリモートサーバー上の API と簡単にやり取りすることができます。

Claude がクラッシュする、または仕様が機能しない問題が発生した場合は、仕様クリーニングアプリケーション を使用して処理してください。このツールは、いくつかの OpenAPI スキーマを整理し、LLM が読み取り可能な形式に変換します。

🚀 クイックスタート

機能

この代理サーバーは、OpenAPI エンドポイントを自動的に Claude ツールに変換し、Claude が以下のことを行えるようにします。

1. 利用可能な API エンドポイントを検出し、その目的を理解する
2. 必要なパラメーターとその型を把握する
3. あなたの代わりに API 呼び出しを行う
4. 応答を適切に処理する

例えば、Petstore API と次のエンドポイントがある場合：

/pets/{petId}:
  get:
    operationId: getPetById
    summary: Returns a pet by ID
    parameters:
      - name: petId
        in: path
        required: true
        schema:
          type: integer
          format: int64

Claude は自然言語でこのエンドポイントを理解し、実行して、ペットに関する詳細情報を返すことができます。

文件上传支持

標準の API リクエストを処理するだけでなく、OpenAPI MCP サーバーはファイルアップロードもサポートしています。ファイルアップロードは以下の手順で設定できます。

1. OpenAPI 仕様で FormData パラメーターを定義します。

parameters:
  - name: file
    in: formData
    required: true
    schema:
      type: string
      format: binary

2. サーバー側でファイルアップロードを処理します。

const uploadedFile = await request.file('file');
// アップロードされたファイルを処理する

始め方

1. Claude Desktop を設定する claude_desktop_config.json ファイルに以下の内容を追加します。

   {
     "mcpServers": {
       "petstore-api": {
         "command": "npx",
         "args": ["openapi-mcp-server", "/絶対/パス/to/petstore-openapi.json"]
       }
     }
   }
   

2. Claude Desktop を再起動 して、API とのやり取りを開始しましょう！

サンプル

このリポジトリには、OpenAPI MCP サーバーをテストするための完全な Petstore API サーバーのサンプルが含まれています。このサンプルサーバーは、ペットを管理する基本的な CRUD API を実装しており、このツールの使用方法を学ぶのに最適です。

サンプルサーバーの実行方法については、examples/README.md を参照してください。

使用シーン

1. ローカル開発
   • 自然な会話で API をテストする
   • コードを書く前にエンドポイントをデバッグする
   • 対話的に API 機能を探索する
2. API 統合
   • サードパーティ API をすばやくテストする
   • コードを書く前にプロトタイピングする
   • 会話で新しい API を理解する
3. ドキュメント
   • API エンドポイントに関する質問をする
   • エンドポイントの使用例を取得する
   • エラー条件を理解する

制限事項

• 現在は OpenAPI v3.1 仕様のみをサポートしています
• 応答処理は JSON/テキストに最適化されています
• ファイルアップロードはローカルファイルのみサポートしています（リモート URL はサポートしていません）
• ストリーミング応答は未実装です

開発

未完成のタスクは TODO.md に記載されています。

基本的な操作は以下の通りです。

# 依存関係をインストールする
pnpm install

# テストを実行する
pnpm test

# プロジェクトをビルドする
pnpm build

# プロジェクトをグローバルな node_modules にリンクして、npx で使用できるようにする
npm link

# ここで Claude Desktop を起動して使用を開始する

# 変更を加えた後、Claude Desktop を更新するために再度ビルドを実行する
pnpm build

# 最新の変更を反映するために Claude Desktop を再起動する

📄 ライセンス

MIT

このツールは、自然言語を通じて API をより使いやすくすることを目的として、愛情を込めて作成されました。