MCP OpenAPI Server

@reapi/mcp-openapi

複数のOpenAPI仕様を読み込み、LLMベースのIDE統合を可能にするモデルコンテキストプロトコル（MCP）サーバー。このサーバーは、OpenAPI仕様と、CursorなどのLLMベースの開発ツール（その他のコードエディタなど）間の橋渡しとして機能します。

特徴

• ディレクトリから複数の OpenAPI 仕様をロードします
• MCPプロトコルを通じてAPI操作とスキーマを公開します
• LLM が IDE 内で直接 API を理解し、操作できるようにします
• 完全な API コンテキストのための逆参照スキーマをサポート
• 利用可能なすべてのAPIのカタログを維持します

ReAPIを搭載

このオープンソースのMCPサーバーは、APIの設計とテストを簡素化する次世代APIプラットフォームであるReAPIによって提供されています。このサーバーは開発のためのローカルOpenAPI統合を提供するだけでなく、ReAPIは2つの強力なモジュールも提供しています。

🎨 API CMS

• 直感的なノーコードエディタを使用して API を設計する
• OpenAPI仕様を自動的に生成して公開する
• チームメンバーとリアルタイムで共同作業
• バージョン管理と変更管理

🧪 API テスト

• 開発者にとって最も使いやすいノーコードAPIテストソリューション
• 直感的なインターフェースでテストケースを作成および管理します
• 強力なアサーションおよび検証機能
• サーバーレスクラウドテストエグゼキューター
• QAチームと開発者の両方に最適
• CI/CD統合対応

reapi.comで ReAPI を無料で試して、API 開発の未来を体験してください。

カーソルの設定

MCP OpenAPI サーバーを Cursor IDE と統合するには、構成場所に 2 つのオプションがあります。

オプション 1: プロジェクト固有の構成 (推奨)

プロジェクトディレクトリに.cursor/mcp.jsonファイルを作成します。このオプションは、プロジェクトごとに異なる仕様セットを管理できるため、推奨されます。

ヒント: ./specsのような相対パスを使用すると、構成が移植可能になり、チーム メンバー間で共有しやすくなります。

注: 新しい機能や改善点が頻繁にサーバーに反映されるため、 @latestタグを使用することをお勧めします。

重要：プロジェクト固有の設定は、LLMのコンテキスト制限を管理するのに役立ちます。すべての仕様を単一のフォルダに配置すると、結合されたメタデータがLLMのコンテキストウィンドウを超え、エラーが発生する可能性があります。仕様をプロジェクトごとに整理することで、コンテキストのサイズを管理しやすくなります。

オプション2: グローバル構成

サーバーをすべてのプロジェクトで利用できるようにするには、ホーム ディレクトリに~/.cursor/mcp.jsonを作成または編集します。

カーソル設定で有効にする

設定を追加した後:

1. オープンカーソルIDE
2. 設定 > カーソル設定 > MCP に移動します
3. @reapi/mcp-openapi サーバーを有効にする
4. 変更を適用するには、サーバーの横にある更新アイコンをクリックします。

注：デフォルトでは、カーソルはMCPツールの実行ごとに確認を求めます。確認なしで自動実行を許可したい場合は、カーソル設定でYoloモードを有効にしてください。

サーバーは使用準備完了です。新しいOpenAPI仕様をディレクトリに追加したら、以下の手順でカタログを更新できます。

1. カーソルのチャットパネルを開く
2. 次のいずれかのプロンプトを入力します。
   "Please refresh the API catalog" "Reload the OpenAPI specifications"

OpenAPI仕様要件

1. OpenAPI 3.x 仕様をターゲット ディレクトリに配置します。
   • JSONとYAMLの両方の形式をサポート
   • ファイルの拡張子は.json 、 .yaml 、または.ymlである必要があります。
   • スキャナはすべての仕様ファイルを自動的に検出して処理します
2. 仕様ID構成:
   • デフォルトでは、ファイル名（拡張子なし）が仕様IDとして使用されます。
   • カスタム ID を指定するには、OpenAPI 情報オブジェクトにx-spec-idを追加します。
   openapi: 3.0.0 info: title: My API version: 1.0.0 x-spec-id: my-custom-api-id # Custom specification ID

   重要: 以下の複数の仕様を扱う場合には、カスタムx-spec-idを設定することが重要です。

   • 類似または同一のエンドポイントパス
   • 同じスキーマ名
   • 重複する操作ID

   スペックIDは、類似したリソースを区別し、名前の競合を防ぐのに役立ちます。例：

   # user-service.yaml info: x-spec-id: user-service paths: /users: get: ... # admin-service.yaml info: x-spec-id: admin-service paths: /users: get: ...

   これらのエンドポイントを具体的にはuser-service/usersとadmin-service/usersとして参照できるようになりました。

仕組み

1. サーバーは指定されたディレクトリをスキャンしてOpenAPI仕様ファイルを探します
2. 完全なコンテキストを得るために仕様を処理して逆参照する
3. すべての API 操作とスキーマのカタログを作成して管理します
4. この情報をMCPプロトコルを通じて公開します
5. IDE 統合ではこの情報を使用して次のことが可能になります。
   • LLMにAPIコンテキストを提供する
   • インテリジェントなコード補完を有効にする
   • API統合の支援
   • API対応のコードスニペットを生成する

ツール

1. refresh-api-catalog
   • APIカタログを更新する
   • 戻り値: カタログが更新されたときの成功メッセージ
2. get-api-catalog
   • APIカタログを取得します。カタログには、すべてのOpenAPI仕様、その操作、スキーマに関するメタデータが含まれています。
   • 戻り値: すべての仕様、操作、スキーマを含む完全な API カタログ
3. search-api-operations
   • 仕様間の操作の検索
   • 入力:
     • query (文字列): 検索クエリ
     • specId (オプションの文字列): 検索対象となる特定のAPI仕様ID
   • 戻り値: APIカタログからの一致する操作
4. search-api-schemas
   • 仕様全体にわたってスキーマを検索する
   • 入力:
     • query (文字列): 検索クエリ
     • specId (オプションの文字列): 検索する特定のAPI仕様ID
   • 戻り値: APIカタログからの一致するスキーマ
5. load-api-operation-by-operationId
   • 操作IDで操作をロードする
   • 入力:
     • specId (文字列): API仕様ID
     • operationId (文字列): ロードする操作ID
   • 戻り値: 完全な操作の詳細
6. load-api-operation-by-path-and-method
   • パスとメソッドで操作をロードする
   • 入力:
     • specId (文字列): API仕様ID
     • path (文字列): APIエンドポイントパス
     • method （文字列）：HTTPメソッド
   • 戻り値: 完全な操作の詳細
7. load-api-schema-by-schemaName
   • schemaName でスキーマをロードする
   • 入力:
     • specId (文字列): API仕様ID
     • schemaName (文字列): ロードするスキーマの名前
   • 戻り値: 完全なスキーマの詳細

ロードマップ

1. セマンティック検索
   • API 操作とスキーマの自然言語クエリを有効にする
   • 意味理解による検索精度の向上
2. リモート仕様同期
   • リモートソースからの OpenAPI 仕様の同期をサポート
3. コードテンプレート
   • MCPプロトコルを通じてコードテンプレートを公開する
   • LLM コード生成用の参照パターンを提供する
4. コミュニティへの貢献
   • 機能リクエストやバグレポートを送信する
   • サーバーの改善に貢献する

カーソル内のプロンプトの例

以下は、Cursor IDE で API を操作するために使用できるプロンプトの例です。

1. 利用可能なAPIを調べる
   "Show me all available APIs in the catalog with their operations" "List all API specifications and their endpoints"
2. API操作の詳細
   "Show me the details of the create pet API endpoint" "What are the required parameters for creating a new pet?" "Explain the response schema for the pet creation endpoint"
3. スキーマとモックデータ
   "Generate mock data for the Pet schema" "Create a valid request payload for the create pet endpoint" "Show me examples of valid pet objects based on the schema"
4. コード生成
   "Generate an Axios client for the create pet API" "Create a TypeScript interface for the Pet schema" "Write a React hook that calls the create pet endpoint"
5. API統合支援
   "Help me implement error handling for the pet API endpoints" "Generate unit tests for the pet API client" "Create a service class that encapsulates all pet-related API calls"
6. ドキュメントと使用方法
   "Show me example usage of the pet API with curl" "Generate JSDoc comments for the pet API client methods" "Create a README section explaining the pet API integration"
7. 検証と型
   "Generate Zod validation schema for the Pet model" "Create TypeScript types for all pet-related API responses" "Help me implement request payload validation for the pet endpoints"
8. API検索と検出
   "Find all endpoints related to pet management" "Show me all APIs that accept file uploads" "List all endpoints that return paginated responses"

これらのプロンプトは、MCPサーバーの機能をAPI開発に活用する方法を示しています。ご自身のニーズに合わせて自由にカスタマイズしたり、より複雑なタスクのために組み合わせたりしてください。

貢献

貢献を歓迎します！お気軽にプルリクエストを送信してください。