mcp-konfluent

Eine MCP-Serverimplementierung, die KI-Assistenten die Interaktion mit Confluent Cloud REST-APIs ermöglicht. Dieser Server ermöglicht KI-Tools wie Claude Desktop und Goose CLI die Verwaltung von Kafka-Themen, Konnektoren und Flink-SQL-Anweisungen durch natürliche Sprachinteraktionen.

Demo

Goose-Befehlszeilenschnittstelle

Claude Desktop

Inhaltsverzeichnis

• mcp-konfluent

  • Demo

    • Goose-Befehlszeilenschnittstelle

    • Claude Desktop

  • Inhaltsverzeichnis

  • Benutzerhandbuch

    • Erste Schritte

    • Konfiguration

    • Referenz zu Umgebungsvariablen

    • Verwendung

    • Konfigurieren von Claude Desktop

    • Konfigurieren der Goose CLI

    • mcp-confluent CLI-Nutzung

      • Grundlegende Verwendung

      • Beispiel: Bereitstellung mit allen Transportmöglichkeiten

      • Beispiel: Nur bestimmte Tools zulassen

      • Beispiel: Bestimmte Tools blockieren

      • Beispiel: Werkzeuglisten aus Dateien verwenden

      • Beispiel: Alle verfügbaren Tools auflisten

  • Entwicklerhandbuch

    • Projektstruktur

    • Bauen und Ausführen

    • Testen

      • MCP-Inspektor

    • Hinzufügen eines neuen Tools

    • Generieren von Typen

    • Beitragen

Benutzerhandbuch

Erste Schritte

1. Erstellen Sie eine Kopieren Sie die Beispielstruktur .env Datei (siehe unten) in eine neue Datei mit dem Namen .env im Stammverzeichnis Ihres Projekts.

2. Füllen Sie die Geben Sie die erforderlichen Werte für Ihre Confluent Cloud-Umgebung ein. Details zu den einzelnen Variablen finden Sie im Abschnitt „Konfiguration“ .

3. Installieren Sie Node.js (falls noch nicht installiert)

   • Wir empfehlen die Verwendung von NVM (Node Version Manager) zur Verwaltung von Node.js-Versionen

   • Installieren und verwenden Sie Node.js:

   nvm install 22 nvm use 22

Konfiguration

Erstellen Sie im Stammverzeichnis Ihres Projekts eine .env Datei mit der folgenden Konfiguration:

Referenz zu Umgebungsvariablen

Verwendung

Dieser MCP-Server ist für die Verwendung mit verschiedenen MCP-Clients wie Claude Desktop oder Goose CLI/Desktop konzipiert. Die spezifische Konfiguration und Interaktion hängt vom verwendeten Client ab. Die allgemeinen Schritte sind jedoch:

1. Starten Sie den Server: Sie können den MCP-Server auf zwei Arten ausführen:

   • Aus der Quelle: Folgen Sie den Anweisungen im Entwicklerhandbuch, um den Server aus der Quelle zu erstellen und auszuführen. Dies umfasst in der Regel:

     • Installieren von Abhängigkeiten ( npm install )

     • Erstellen des Projekts ( npm run build oder npm run dev )

   • Mit npx: Sie können den Server direkt mit npx starten (kein Build erforderlich):

     npx -y @confluentinc/mcp-confluent -e /path/to/confluent-mcp-server/.env

2. Konfigurieren Sie Ihren MCP-Client: Jeder Client hat seine eigene Methode, die Adresse des MCP-Servers und die erforderlichen Anmeldeinformationen anzugeben. Sie müssen Ihren Client (z. B. Claude, Goose) so konfigurieren, dass er sich mit der Adresse verbindet, auf der dieser Server läuft (wahrscheinlich localhost mit einem bestimmten Port). Der Port, auf dem der Server läuft, kann durch eine Umgebungsvariable konfiguriert werden.

3. Starten Sie den MCP-Client: Sobald Ihr Client für die Verbindung mit dem MCP-Server konfiguriert ist, können Sie ihn starten. Beim Start wird eine lokale Instanz des MCP-Servers eingerichtet. Diese Instanz verwaltet die Datenschemata und interagiert in Ihrem Namen mit Confluent Cloud.

4. Interaktion mit Confluent über den Client: Sobald der Client verbunden ist, können Sie über dessen Schnittstelle mit Confluent Cloud-Ressourcen interagieren. Der Client sendet Anfragen an den MCP-Server, der dann in Ihrem Namen mit Confluent Cloud interagiert.

Konfigurieren von Claude Desktop

Weitere Einzelheiten zur Installation von Claude Desktop- und MCP-Servern finden Sie hier .

So konfigurieren Sie Claude Desktop für die Verwendung dieses MCP-Servers:

1. Öffnen Sie die Claude Desktop-Konfiguration

   • Auf dem Mac: ~/Library/Application Support/Claude/claude_desktop_config.json

   • Unter Windows: %APPDATA%\Claude\claude_desktop_config.json

2. Konfigurationsdatei bearbeiten

   • Öffnen Sie die Konfigurationsdatei in Ihrem bevorzugten Texteditor

   • Fügen Sie die Konfiguration mit einer der folgenden Methoden hinzu oder ändern Sie sie:

   { "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" ] } } }

   Ersetzen Sie /path/to/confluent-mcp-server/ durch den tatsächlichen Pfad, in dem Sie diesen MCP-Server installiert haben.

3. Starten Sie Claude Desktop neu

   • Schließen Sie Claude Desktop und öffnen Sie es erneut, damit die Änderungen wirksam werden.

   • Der MCP-Server wird automatisch gestartet, wenn Claude Desktop startet

Jetzt wird Claude Desktop so konfiguriert, dass Ihr lokaler MCP-Server für Confluent-Interaktionen verwendet wird.

Konfigurieren der Goose CLI

Ausführliche Anweisungen zur Installation der Goose CLI finden Sie hier .

Führen Sie nach der Installation die folgenden Schritte aus:

1. Führen Sie den Konfigurationsbefehl aus:

   goose configure

2. Folgen Sie den interaktiven Anweisungen:

   • Wählen Sie Add extension

   • Wählen Sie Command-line Extension

   • Geben Sie als Erweiterungsnamen mcp-confluent ein

   • Wählen Sie eine der folgenden Konfigurationsmethoden:

   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

Ersetzen Sie /path/to/confluent-mcp-server/ durch den tatsächlichen Pfad, in dem Sie diesen MCP-Server installiert haben.

mcp-confluent CLI-Nutzung

Der MCP-Server bietet eine flexible Befehlszeilenschnittstelle (CLI) für erweiterte Konfiguration und Steuerung. Über die CLI können Sie Umgebungsdateien und Transporte angeben und genau festlegen, welche Tools aktiviert oder blockiert werden.

Grundlegende Verwendung

Sie können alle CLI-Optionen anzeigen und Hilfe zu Folgendem erhalten:

Beispiel: Bereitstellung mit allen Transportmöglichkeiten

Beispiel: Nur bestimmte Tools zulassen

Beispiel: Bestimmte Tools blockieren

Beispiel: Werkzeuglisten aus Dateien verwenden

Beispiel: Alle verfügbaren Tools auflisten

Tipp: Die Zulassungsliste wird vor der Sperrliste angewendet. Wenn keine der beiden Optionen angegeben ist, sind alle Tools standardmäßig aktiviert.

Entwicklerhandbuch

Projektstruktur

Bauen und Ausführen

1. Abhängigkeiten installieren:

   npm install

2. Entwicklungsmodus (achten Sie auf Änderungen):

   npm run dev

   Dieser Befehl kompiliert den TypeScript-Code in JavaScript und erstellt ihn automatisch neu, wenn Änderungen im Verzeichnis src/ erkannt werden.

3. Produktionsbuild (einmalige Kompilierung):

   npm run build

4. Starten Sie den Server:

   npm run start

Testen

MCP-Inspektor

Zum Testen von MCP-Servern können Sie MCP Inspector verwenden, ein interaktives Entwicklertool zum Testen und Debuggen von MCP-Servern.

Hinzufügen eines neuen Tools

1. Fügen Sie der Enumerationsklasse ToolName eine neue Enumeration hinzu.

2. Fügen Sie Ihr neues Tool zur Handler-Map in der ToolFactory Klasse hinzu.

3. Erstellen Sie eine neue Datei und exportieren Sie die Klasse, die BaseToolHandler erweitert.

   1. Implementieren Sie die handle -Methode der Basisklasse.

   2. Implementieren Sie die Methode getToolConfig der Basisklasse.

4. Wenn Sie zufrieden sind, fügen Sie es dem Satz enabledTools “ in index.ts hinzu.

Generieren von Typen

Beitragen

Fehlerberichte und Feedback werden in Form von Github Issues gerne entgegengenommen. Richtlinien zum Mitwirken finden Sie unter CONTRIBUTING.md