mcp-confluent

mcp-合流

AIアシスタントがConfluent Cloud REST APIと連携できるようにするMCPサーバー実装。このサーバーにより、Claude DesktopやGoose CLIなどのAIツールが、自然言語によるインタラクションを通じてKafkaトピック、コネクタ、Flink SQLステートメントを管理できるようになります。

デモ

グースCLI

クロードデスクトップ

目次

• mcp-合流
  • デモ
    • グースCLI
    • クロードデスクトップ
  • 目次
  • ユーザーガイド
    • はじめる
    • 構成
    • 環境変数リファレンス
    • 使用法
    • Claudeデスクトップの設定
    • Goose CLIの設定
  • 開発者ガイド
    • プロジェクト構造
    • 構築と実行
    • テスト
      • MCP検査官
    • 新しいツールの追加
    • 型の生成
    • 貢献

ユーザーガイド

はじめる

1. **.envファイルを作成する:**サンプルの.envファイル構造 (以下に表示) を、プロジェクトのルートにある.envという名前の新しいファイルにコピーします。
2. .envファイルへの入力： Confluent Cloud 環境に必要な値を入力します。各変数の詳細については、設定セクションをご覧ください。
3. Node.js をインストールします(まだインストールされていない場合)
   • Node.jsのバージョン管理にはNVM （Node Version Manager）の使用をお勧めします。
   • Node.js をインストールして使用します。
   nvm install 22 nvm use 22

構成

次の構成で、プロジェクトのルート ディレクトリに.envファイルを作成します。

環境変数リファレンス

使用法

このMCPサーバーは、Claude DesktopやGoose CLI/Desktopなど、様々なMCPクライアントで使用できるように設計されています。具体的な設定と操作は、使用するクライアントによって異なります。ただし、一般的な手順は以下のとおりです。

1. ビルド：開発者ガイドの指示に従って、ソースからサーバーをビルドして実行します。通常、以下の手順が必要です。
   • 依存関係のインストール（ npm install ）
   • プロジェクトのビルド（ npm run buildまたはnpm run dev ）
2. **MCPクライアントの設定：**各クライアントは、MCPサーバーのアドレスと必要な認証情報を指定する方法が異なります。クライアント（例：Claude、Goose）を、このサーバーが稼働しているアドレス（通常は特定のポートを持つlocalhost ）に接続するように設定する必要があります。サーバーが稼働するポートは、環境変数で設定できます。
3. **MCPクライアントを起動します。**クライアントがMCPサーバーに接続できるように設定したら、MCPクライアントを起動できます。起動時に、MCPサーバーのインスタンスがローカルに作成されます。このインスタンスは、データスキーマの管理とConfluent Cloudとのやり取りをユーザーに代わって行います。
4. **クライアント経由でConfluentとやり取りする：**クライアントが接続されると、クライアントのインターフェースを使用してConfluent Cloudのリソースとやり取りできるようになります。クライアントはMCPサーバーにリクエストを送信し、MCPサーバーがユーザーに代わってConfluent Cloudとやり取りします。

Claudeデスクトップの設定

Claude Desktop および MCP サーバーのインストールの詳細については、ここを参照してください。

この MCP サーバーを使用するように Claude Desktop を構成するには:

1. オープンクロードデスクトップ構成
   • Macの場合: ~/Library/Application Support/Claude/claude_desktop_config.json
   • Windows の場合: %APPDATA%\Claude\claude_desktop_config.json
2. 設定ファイルの編集
   • 好みのテキストエディタで設定ファイルを開きます
   • 次のいずれかの方法を使用して、構成を追加または変更します。
   { "mcpServers": { "confluent": { "command": "node", "args": [ "/path/to/confluent-mcp-server/dist/index.js", "--env-file", "/path/to/confluent-mcp-server/.env", ] } } }
   { "mcpServers": { "confluent": { "command": "npx", "args": [ "-y" "@confluentinc/mcp-confluent", "-e", "/path/to/confluent-mcp-server/.env" ] } } }

   /path/to/confluent-mcp-server/この MCP サーバーをインストールした実際のパスに置き換えます。

3. Claudeデスクトップを再起動します
   • 変更を有効にするには、Claude Desktop を閉じて再度開きます。
   • Claude Desktopを起動するとMCPサーバーが自動的に起動します。

これで、Claude Desktop は Confluent とのやり取りにローカル MCP サーバーを使用するように構成されます。

Goose CLIの設定

Goose CLI のインストール方法の詳細については、ここを参照してください。

インストールしたら、次の手順に従います。

1. 構成コマンドを実行します。
   goose configure
2. 対話型プロンプトに従います。
   • Add extension選択
   • Command-line Extensionを選択
   • 拡張機能名としてmcp-confluentを入力します
   • 次のいずれかの構成方法を選択します。
   node /path/to/confluent-mcp-server/dist/index.js --env-file /path/to/confluent-mcp-server/.env
   npx -y @confluentinc/mcp-confluent -e /path/to/confluent-mcp-server/.env

/path/to/confluent-mcp-server/この MCP サーバーをインストールした実際のパスに置き換えます。

開発者ガイド

プロジェクト構造

構築と実行

1. 依存関係をインストールします:
   npm install
2. 開発モード（変更に注意してください）:
   npm run dev
   このコマンドは、TypeScript コードを JavaScript にコンパイルし、 src/ディレクトリで変更が検出されると自動的に再構築します。
3. プロダクションビルド（1回限りのコンパイル）:
   npm run build
4. サーバーを起動します。
   npm run start

テスト

MCP検査官

MCP サーバーをテストするには、MCP サーバーのテストとデバッグを行う対話型開発者ツールであるMCP Inspector を使用できます。

新しいツールの追加

1. 列挙クラスToolNameに新しい列挙を追加します。
2. 新しいツールをToolFactoryクラスのハンドラー マップに追加します。
3. BaseToolHandler拡張するクラスをエクスポートして、新しいファイルを作成します。
   1. 基本クラスのhandleメソッドを実装します。
   2. 基本クラスのgetToolConfigメソッドを実装します。
4. 満足したら、 index.tsのenabledToolsセットに追加します。

型の生成

貢献

バグ報告やフィードバックはGithub Issuesで受け付けています。貢献に関するガイドラインについては、 CONTRIBUTING.mdをご覧ください。