Elasticsearch MCP Server

Elasticsearch MCP-Server

Dieses Repository enthält experimentelle Funktionen, die für Forschung und Evaluierung bestimmt sind und nicht produktionsreif sind.

Stellen Sie mithilfe des Model Context Protocol (MCP) direkt von jedem MCP-Client (wie Claude Desktop) eine Verbindung zu Ihren Elasticsearch-Daten her.

Dieser Server verbindet Agenten über das Model Context Protocol mit Ihren Elasticsearch-Daten. Er ermöglicht Ihnen die Interaktion mit Ihren Elasticsearch-Indizes über natürliche Sprachkonversationen.

Verfügbare Tools

• list_indices : Listet alle verfügbaren Elasticsearch-Indizes auf
• get_mappings : Ruft Feldzuordnungen für einen bestimmten Elasticsearch-Index ab
• search : Führen Sie eine Elasticsearch-Suche mit der bereitgestellten Abfrage-DSL durch
• get_shards : Shard-Informationen für alle oder bestimmte Indizes abrufen

Voraussetzungen

• Eine Elasticsearch-Instanz
• Elasticsearch-Authentifizierungsdaten (API-Schlüssel oder Benutzername/Passwort)
• MCP-Client (z. B. Claude Desktop)

Demo

https://github.com/user-attachments/assets/5dd292e1-a728-4ca7-8f01-1380d1bebe0c

Installation und Einrichtung

Verwenden des veröffentlichten NPM-Pakets

[!TIP] Am einfachsten lässt sich der Elasticsearch MCP-Server über das veröffentlichte npm-Paket verwenden.

1. MCP-Client konfigurieren
   • Öffnen Sie Ihren MCP-Client. Sehen Sie sich die Liste der MCP-Clients an. Hier konfigurieren wir Claude Desktop.
   • Gehen Sie zu Einstellungen > Entwickler > MCP-Server
   • Klicken Sie auf Edit Config und fügen Sie einen neuen MCP-Server mit der folgenden Konfiguration hinzu:
   { "mcpServers": { "elasticsearch-mcp-server": { "command": "npx", "args": [ "-y", "@elastic/mcp-server-elasticsearch" ], "env": { "ES_URL": "your-elasticsearch-url", "ES_API_KEY": "your-api-key" } } } }
2. Eine Unterhaltung beginnen
   • Öffnen Sie eine neue Konversation in Ihrem MCP-Client
   • Der MCP-Server sollte automatisch eine Verbindung herstellen
   • Sie können jetzt Fragen zu Ihren Elasticsearch-Daten stellen

Konfigurationsoptionen

Der Elasticsearch MCP-Server unterstützt Konfigurationsoptionen zum Herstellen einer Verbindung mit Ihrem Elasticsearch:

[!NOTE] Sie müssen zur Authentifizierung entweder einen API-Schlüssel oder sowohl Benutzernamen als auch Kennwort angeben.

Lokale Entwicklung

[!NOTE] Wenn Sie den MCP-Server ändern oder erweitern möchten, befolgen Sie diese lokalen Entwicklungsschritte.

1. Verwenden Sie die richtige Node.js-Version
   nvm use
2. Abhängigkeiten installieren
   npm install
3. Erstellen des Projekts
   npm run build
4. Lokal in der Claude Desktop App ausführen
   • Öffnen Sie die Claude Desktop App
   • Gehen Sie zu Einstellungen > Entwickler > MCP-Server
   • Klicken Sie auf Edit Config und fügen Sie einen neuen MCP-Server mit der folgenden Konfiguration hinzu:
   { "mcpServers": { "elasticsearch-mcp-server-local": { "command": "node", "args": [ "/path/to/your/project/dist/index.js" ], "env": { "ES_URL": "your-elasticsearch-url", "ES_API_KEY": "your-api-key" } } } }
5. Debuggen mit MCP Inspector
   ES_URL=your-elasticsearch-url ES_API_KEY=your-api-key npm run inspector
   Dadurch wird der MCP Inspector gestartet, mit dem Sie Anfragen debuggen und analysieren können. Folgendes sollte angezeigt werden:
   Starting MCP inspector... Proxy server listening on port 3000 🔍 MCP Inspector is up and running at http://localhost:5173 🚀

Beitragen

Wir freuen uns über Beiträge aus der Community! Weitere Informationen dazu, wie Sie beitragen können, finden Sie in den Richtlinien für Beiträge .

Beispielfragen

[!TIP] Hier sind einige Abfragen in natürlicher Sprache, die Sie mit Ihrem MCP-Client ausprobieren können.

• „Welche Indizes habe ich in meinem Elasticsearch-Cluster?“
• „Zeigen Sie mir die Feldzuordnungen für den Index ‚Produkte‘.“
• „Finden Sie alle Bestellungen über 500 $ vom letzten Monat.“
• „Welche Produkte haben die meisten 5-Sterne-Bewertungen erhalten?“

Wie es funktioniert

1. Der MCP-Client analysiert Ihre Anfrage und ermittelt, welche Elasticsearch-Operationen erforderlich sind.
2. Der MCP-Server führt diese Vorgänge aus (Auflisten von Indizes, Abrufen von Zuordnungen, Durchführen von Suchvorgängen).
3. Der MCP-Client verarbeitet die Ergebnisse und präsentiert sie in einem benutzerfreundlichen Format.

Bewährte Sicherheitspraktiken

[!WARNING] Vermeiden Sie die Verwendung von Clusteradministratorberechtigungen. Erstellen Sie dedizierte API-Schlüssel mit begrenztem Umfang und wenden Sie eine differenzierte Zugriffssteuerung auf Indexebene an, um unbefugten Datenzugriff zu verhindern.

Sie können einen dedizierten Elasticsearch-API-Schlüssel mit minimalen Berechtigungen erstellen, um den Zugriff auf Ihre Daten zu kontrollieren:

Lizenz

Dieses Projekt ist unter der Apache-Lizenz 2.0 lizenziert.

Fehlerbehebung

• Stellen Sie sicher, dass Ihre MCP-Konfiguration korrekt ist.
• Stellen Sie sicher, dass Ihre Elasticsearch-URL von Ihrem Computer aus zugänglich ist.
• Überprüfen Sie, ob Ihre Authentifizierungsdaten (API-Schlüssel oder Benutzername/Passwort) über die erforderlichen Berechtigungen verfügen.
• Wenn Sie SSL/TLS mit einer benutzerdefinierten Zertifizierungsstelle verwenden, überprüfen Sie, ob der Zertifikatspfad korrekt ist und die Datei lesbar ist.
• Suchen Sie in der Terminalausgabe nach Fehlermeldungen.

Wenn Sie auf Probleme stoßen, können Sie gerne ein Problem im GitHub-Repository öffnen.