Metabase MCP Server

Metabase MCP-Server

Ein Model Control Protocol (MCP)-Server, der KI-Assistenten die Interaktion mit Metabase-Datenbanken und -Aktionen ermöglicht.

![Metabase MCP Server]

Überblick

Der Metabase MCP-Server stellt eine Brücke zwischen KI-Assistenten und Metabase her und ermöglicht KI-Modellen:

• In Metabase konfigurierte Datenbanken auflisten und erkunden
• Abrufen detaillierter Metadaten zu Datenbankschemata, Tabellen und Feldern
• Visualisieren Sie Beziehungen zwischen Tabellen in einer Datenbank
• Auflisten und Ausführen von Metabase-Aktionen
• Führen Sie Vorgänge an Metabase-Daten über eine sichere API durch

Dieser Server implementiert die Spezifikation [Model Control Protocol (MCP)] und ist daher mit KI-Assistenten kompatibel, die MCP-Tools unterstützen.

Merkmale

• Datenbank-Exploration : Alle Datenbanken auflisten und ihre Schemata erkunden
• Metadatenabruf : Erhalten Sie detaillierte Informationen zu Tabellen, Feldern und Beziehungen
• Visualisierung von Beziehungen : Erstellen Sie visuelle Darstellungen von Datenbankbeziehungen
• Aktionsverwaltung : Auflisten, Details anzeigen und Metabase-Aktionen ausführen
• Sichere Handhabung von API-Schlüsseln : Speichern Sie API-Schlüssel verschlüsselt und verhindern Sie deren Offenlegung
• Webschnittstelle : Testen und Debuggen der Funktionalität über eine benutzerfreundliche Webschnittstelle
• Docker-Unterstützung : Einfache Bereitstellung mit Docker und Docker Compose

Voraussetzungen

• Metabase-Instanz (v0.46.0 oder höher empfohlen)
• Metabase-API-Schlüssel mit entsprechenden Berechtigungen
• Docker (für containerisierte Bereitstellung)
• Python 3.10+ (für lokale Entwicklung)

Installation

Docker verwenden (empfohlen)

1. Klonen Sie dieses Repository:
   git clone https://github.com/yourusername/metabase-mcp.git cd metabase-mcp
2. Erstellen und führen Sie den Docker-Container aus:
   docker-compose up -d
3. Greifen Sie auf die Konfigurationsschnittstelle unter http://localhost:5001 zu

Manuelle Installation

1. Klonen Sie dieses Repository:
   git clone https://github.com/yourusername/metabase-mcp.git cd metabase-mcp
2. Installieren Sie Abhängigkeiten:
   pip install -r requirements.txt
3. Führen Sie die Konfigurationsschnittstelle aus:
   python -m src.server.web_interface
4. Greifen Sie auf die Konfigurationsschnittstelle unter http://localhost:5000 zu

Konfiguration

1. Öffnen Sie die Weboberfläche in Ihrem Browser
2. Geben Sie Ihre Metabase-URL ein (z. B. http://localhost:3000 ).
3. Geben Sie Ihren Metabase-API-Schlüssel ein
4. Klicken Sie auf „Konfiguration speichern“ und testen Sie die Verbindung

Abrufen eines Metabase-API-Schlüssels

1. Melden Sie sich als Administrator bei Ihrer Metabase-Instanz an.
2. Gehen Sie zu Einstellungen > Administratoreinstellungen > API-Schlüssel
3. Erstellen Sie einen neuen API-Schlüssel mit entsprechenden Berechtigungen
4. Kopieren Sie den generierten Schlüssel zur Verwendung im MCP-Server

Verwendung

Ausführen des MCP-Servers

Nach der Konfiguration können Sie den MCP-Server ausführen:

Verfügbare Tools

Der MCP-Server stellt KI-Assistenten die folgenden Tools zur Verfügung:

1. list_databases : Listet alle in Metabase konfigurierten Datenbanken auf
2. get_database_metadata : Holen Sie sich detaillierte Metadaten für eine bestimmte Datenbank
3. db_overview : Erhalten Sie einen allgemeinen Überblick über alle Tabellen in einer Datenbank
4. table_detail : Erhalten Sie detaillierte Informationen zu einer bestimmten Tabelle
5. visualize_database_relationships : Erstellen Sie eine visuelle Darstellung der Datenbankbeziehungen
6. run_database_query : Führen Sie eine SQL-Abfrage für eine Datenbank aus
7. list_actions : Listet alle in Metabase konfigurierten Aktionen auf
8. get_action_details : Erhalten Sie detaillierte Informationen zu einer bestimmten Aktion
9. execute_action : Führt eine Metabase-Aktion mit Parametern aus

Testtools über die Weboberfläche

Die Weboberfläche bietet für jedes Tool einen Testbereich:

1. Datenbanken auflisten : Alle in Metabase konfigurierten Datenbanken anzeigen
2. Datenbankmetadaten abrufen : Detaillierte Schemainformationen für eine Datenbank anzeigen
3. DB-Übersicht : Zeigen Sie eine übersichtliche Liste aller Tabellen in einer Datenbank an
4. Tabellendetails : Zeigen Sie detaillierte Informationen zu einer bestimmten Tabelle an
5. Datenbankbeziehungen visualisieren : Generieren Sie eine visuelle Darstellung der Tabellenbeziehungen
6. Abfrage ausführen : Führen Sie SQL-Abfragen für Datenbanken aus
7. Aktionen auflisten : Alle in der Metabase konfigurierten Aktionen anzeigen
8. Aktionsdetails abrufen : Detaillierte Informationen zu einer bestimmten Aktion anzeigen
9. Aktion ausführen : Testen Sie die Ausführung einer Aktion mit Parametern

Sicherheitsüberlegungen

• API-Schlüssel werden im Ruhezustand verschlüsselt gespeichert
• Die Weboberfläche zeigt API-Schlüssel niemals im Klartext an
• Alle API-Anfragen verwenden HTTPS, wenn sie mit einer sicheren Metabase-URL konfiguriert sind
• Der Server sollte in Produktionsumgebungen hinter einem sicheren Proxy bereitgestellt werden

Entwicklung

Projektstruktur

Neue Tools hinzufügen

So fügen Sie ein neues Werkzeug hinzu:

1. Implementieren Sie die Tool-Funktion in src/tools/
2. Registrieren Sie das Tool in src/server/mcp_server.py
3. Fügen Sie eine Testschnittstelle in templates/config.html hinzu (optional)
4. Fügen Sie eine Route in src/server/web_interface.py hinzu (wenn Sie eine Testschnittstelle hinzufügen)

Fehlerbehebung

Häufige Probleme

• Verbindung fehlgeschlagen : Stellen Sie sicher, dass Ihre Metabase-URL korrekt und zugänglich ist
• Authentifizierungsfehler : Überprüfen Sie, ob Ihr API-Schlüssel über die erforderlichen Berechtigungen verfügt
• Docker-Netzwerkprobleme : Stellen Sie bei der Verwendung von Docker eine ordnungsgemäße Netzwerkkonfiguration sicher

Protokolle

Überprüfen Sie die Protokolle auf detaillierte Fehlerinformationen:

Beitragen

Beiträge sind willkommen! Senden Sie gerne einen Pull Request.