MCP Confluent

🚀 MCP サーバー開発ガイド

MCPサーバーの開発に関する包括的なガイドです。このガイドでは、環境変数の設定、プロジェクト構造、構築と実行、テスト方法、および貢献方法について説明します。

🚀 クイックスタート

MCPサーバーを開発するには、まず環境変数を設定し、プロジェクトを構築して実行する必要があります。以下の手順に従って進めてください。

✨ 主な機能

• 環境変数を使用した認証とクラスター識別
• Confluent Cloudとの統合
• 開発モードでの自動再構築
• MCP Inspectorを使用したテスト

📦 インストール

環境変数の設定

MCPサーバーを実行するには、以下の環境変数を設定する必要があります。

プロジェクト構造

プロジェクトの構造は以下の通りです。

/
├── src/                 # ソースコードディレクトリ
│   ├── confluent/       # Confluent関連のコード（APIクライアントなど）
│   ├── tools/           # ツールの実装（各ツールは個別のファイル）
│   ├── index.ts         # サーバーのメインエントリポイント
│   └── ...              # その他のサーバーロジック、ユーティリティなど
├── dist/                # コンパイル出力ディレクトリ（TypeScriptをJavaScriptに変換）
├── openapi.json         # Confluent CloudのOpenAPI仕様
├── .env                 # 環境変数の設定ファイル（サンプル - コピーして記入する必要があります）
├── README.md            # このファイル
└── package.json         # Node.jsプロジェクトのメタデータと依存関係

依存関係のインストール

以下のコマンドを実行して、依存関係をインストールします。

npm install

開発モードでの実行

以下のコマンドを実行して、開発モードでサーバーを実行します。

npm run dev

このコマンドは、TypeScriptコードをJavaScriptにコンパイルし、src/ディレクトリ内の変更を検出すると自動的に再構築します。

本番用の構築

以下のコマンドを実行して、本番用にコードを構築します。

npm run build

サーバーの起動

以下のコマンドを実行して、サーバーを起動します。

npm run start

💻 使用例

MCP Inspectorを使用したテスト

MCPサーバーをテストするには、MCP Inspectorを使用できます。これは、MCPサーバーをテストおよびデバッグするための対話型開発ツールです。

# プロジェクトを開発または構築モードで実行していることを確認してください
npx @modelcontextprotocol/inspector node $PATH_TO_PROJECT/dist/index.js --env-file $PATH_TO_PROJECT/.env

新しいツールの追加

新しいツールを追加するには、以下の手順に従います。

1. 列挙型ToolNameに新しい列挙値を追加します。
2. 新しいツールをToolFactoryクラスのハンドラーマッピングに追加します。
3. BaseToolHandlerを継承する新しいクラスをエクスポートする新しいファイルを作成します。
   1. 基底クラスのhandleメソッドを実装します。
   2. 基底クラスのgetToolConfigメソッドを実装します。
4. 完了したら、index.tsファイルのenabledToolsセットに新しいツールを追加します。

型の生成

以下のコマンドを実行して、型を生成します。

# 注意：バージョン7.5.2にはallOfとrequiredに関連するバグがあるため、--empty-objects-unknownフラグを使用して回避する必要があります
npx openapi-typescript ./openapi.json -o ./src/confluent/openapi-schema.d.ts --empty-objects-unknown

📚 ドキュメント

貢献方法

問題報告や技術フィードバックは、GitHub Issuesの形式で歓迎します。貢献ガイドについては、CONTRIBUTING.mdを参照してください。