MCP Openapi

🚀 MCP プロトコルの IDE への統合

このプロジェクトでは、MCP プロトコルを IDE に統合することで、API 開発の効率を向上させます。以下に、具体的な機能、使用するツール、サンプルのプロンプト、将来の計画、タスクの詳細、および追加情報を紹介します。

🚀 クイックスタート

MCP プロトコルを IDE に統合することで、以下の機能を実現できます。

1. API カタログの更新：定期的に利用可能な API の情報を更新します。
2. API カタログの取得：登録されているすべての API とその詳細情報を取得します。
3. API 操作の検索：名前または ID を指定して特定の操作を検索します。
4. API スキーマの検索：クエリ条件に基づいて関連するスキーマを検索します。
5. 操作詳細の読み込み：操作 ID またはパスとメソッドを使用して操作の詳細を取得します。
6. スキーマ詳細の読み込み：スキーマ名を利用してスキーマの情報を取得します。

✨ 主な機能

ツール

MCP プロトコルがサポートするツールは以下の通りです。

1. refresh-api-catalog：API カタログを更新し、成功メッセージを返します。
2. get-api-catalog：完全な API カタログ情報を取得します。
3. search-api-operations：操作を検索し、指定された仕様 ID でフィルタリングすることができます。
4. search-api-schemas：スキーマを検索し、仕様 ID を指定できます。
5. load-api-operation-by-operationId：仕様 ID と操作 ID を使用して操作の詳細を読み込みます。
6. load-api-operation-by-path-and-method：仕様 ID、パス、およびメソッドを使用して操作情報を読み込みます。
7. load-api-schema-by-schemaName：仕様 ID とスキーマ名に基づいてスキーマの詳細を取得します。

サンプルプロンプト

Cursor IDE では、以下のサンプルプロンプトを使用して API と対話できます。

利用可能な API の探索

"カタログ内のすべての利用可能な API とその操作を表示する"
"すべての API 仕様とそのエンドポイントをリストする"

API 操作の詳細

"ペット作成 API エンドポイントの詳細情報を表示する"
"新しいペットを作成するために必要なパラメータを説明する"
"ペット作成エンドポイントのレスポンススキーマを説明する"

スキーマとモックデータ

"Pet スキーマのモックデータを生成する"
"新しいペットを作成するための要求負荷を作成する"
"スキーマに基づく有効な Pet オブジェクトの例を表示する"

コード生成

"ペット作成 API の Axios クライアントを生成する"
"レスポンスオブジェクトの TypeScript インターフェースを生成する"
"ペット作成エンドポイントを呼び出す React フックを作成する"

API 統合支援

"ペット API のエラーハンドリングを実装するのを支援する"
"ペット API クライアントの単体テストを生成する"
"すべてのペット関連の API 呼び出しをカプセル化するサービスクラスを作成する"

ドキュメントと使用方法

"ペット API の使用例の curl コマンドを表示する"
"API クライアントメソッドの JSDoc コメントを生成する"
"ペット API の統合を説明する README のセクションを作成する"

検証と型

"Pet モデルの Zod 検証スキーマを生成する"
"すべてのレスポンスを処理する TypeScript 型を作成する"
"要求負荷の検証ロジックを実装するのを支援する"

API 検索と発見

"すべてのペット管理に関連するエンドポイントを検索する"
"すべてのファイルアップロードを受け付ける API を表示する"
"ページング結果を返すすべてのエンドポイントをリストする"

🔮 ロードマップ

将来的には、以下の改善が予定されています。

1. 意味検索：自然言語処理をサポートすることで、検索機能を強化します。
2. リモート仕様の同期：仕様の自動更新とバージョン管理を実現します。
3. クロスプラットフォーム統合：より多くの IDE と開発環境に対するサポートを拡張します。

📋 タスクの詳細

目標

MCP プロトコルを IDE に統合し、API 開発の効率を向上させること。

範囲

ツールの開発、ドキュメントの作成、およびコミュニティサポートを含みます。

成果物

完全に実装された MCP ツールセット、詳細な日本語ドキュメント、およびサンプルコード。

➕ 追加情報

技術要件

Node.js と TypeScript の開発に精通し、RESTful API の設計経験があることが必要です。

時間計画

開発、テスト、およびドキュメント作成は、指定された期間内に完了する必要があります。

以上の手順に従うことで、MCP プロトコルを IDE に効果的に統合し、API 開発の作業効率を大幅に向上させることができます。