Der Dataform-MCP-Server bietet Tools für die Interaktion mit Dataform.
Ein Model Context Protocol (MCP)-Server fungiert als Proxy zwischen einem externen Dienst, der einem Large Language Model (LLM) oder einer KI-Anwendung Kontext, Daten oder Funktionen bereitstellt. MCP-Server verbinden KI-Anwendungen mit externen Systemen wie Datenbanken und Webdiensten und übersetzen deren Antworten in ein Format, das die KI-Anwendung versteht.
Server einrichten
Sie müssen MCP-Server aktivieren und die Authentifizierung einrichten, bevor Sie sie verwenden können. Weitere Informationen zur Verwendung von Remote-MCP-Servern von Google und Google Cloud finden Sie unter Google Cloud-MCP-Server – Übersicht.
Serverendpunkte
Ein MCP-Dienstendpunkt ist die Netzwerkadresse und Kommunikationsschnittstelle (in der Regel eine URL) des MCP-Servers, über die eine KI-Anwendung (der Host für den MCP-Client) eine sichere, standardisierte Verbindung herstellt. Es ist der Ansprechpartner für das LLM, um Kontext anzufordern, ein Tool aufzurufen oder auf eine Ressource zuzugreifen. Google MCP-Endpunkte können global oder regional sein.
Der Dataform API-MCP-Server hat den folgenden globalen MCP-Endpunkt:
- https://dataform.googleapis.com/mcp
MCP-Tools
Ein MCP-Tool ist eine Funktion oder ausführbare Funktion, die ein MCP-Server für ein LLM oder eine KI-Anwendung bereitstellt, um eine Aktion in der realen Welt auszuführen.
Tools
Der MCP-Server dataform.googleapis.com hat die folgenden Tools:
| MCP-Tools | |
|---|---|
list_repositories |
Dataform-Repositories in einem bestimmten Google Cloud-Projekt und an einem bestimmten Standort auflisten. Der Parameterwert |
create_repository |
Erstellt ein neues Dataform-Repository in einem bestimmten Google Cloud-Projekt und an einem bestimmten Standort. Mit diesem Tool wird die Stammressource erstellt, die für alle anderen Transformations-Assets erforderlich ist, z. B. Kompilierungsergebnisse und Workflowkonfigurationen. Ein Repository muss erstellt werden, bevor ein anderes Dataform MCP-Tool verwendet werden kann. Die Aktivierung dieses Tools ist der erste Schritt beim Einrichten eines Dataform-Projekts. Der Parameterwert Der Parameterwert Lassen Sie den Parameter |
commit_repository_changes |
Wenden Sie einen Git-Commit an, um den Status von Dateien in einem Dataform-Repository aufzuzeichnen. Dieses Tool ist in erster Linie für die Verwaltung von Assets mit einer einzelnen Datei vorgesehen, z. B. Notebooks oder gespeicherte Abfragen, die sich direkt im Repository befinden. Dieses Tool wird nicht in typischen Pipeline-Workflows verwendet, für die Arbeitsbereiche erforderlich sind. Verwenden Sie dieses Tool nicht für Repositorys, die mit einem Remote-Git-Host verbunden sind. Verwenden Sie zur Bestätigung das Durch diese Commit-Aktion wird ein permanenter Eintrag im internen Git-Verlauf des Repositorys erstellt. Der Parameterwert |
read_repository_file |
Gibt den Inhalt einer Datei zurück, die sich in einem Dataform-Repository befindet. Dieses Tool ist nicht für die Entwicklung von Standardpipelines gedacht. Sie ist für die direkte Repository-Interaktion vorgesehen, in der Regel zum Verwalten von Einzeldatei-Assets wie Notebooks oder gespeicherten Abfragen. Verwenden Sie dieses Tool nicht für Repositorys, die mit einem Remote-Git-Host verbunden sind. Verwenden Sie zur Bestätigung das Der Parameterwert Der Parameterwert |
query_repository_directory_contents |
Gibt den Inhalt eines bestimmten Dataform-Repository-Verzeichnisses zurück. Dieses Tool wird hauptsächlich dazu verwendet, Assets mit einer einzelnen Datei direkt im Repository aufzulisten und zu verwalten. Verwenden Sie dieses Tool nicht für Repositorys, die mit einem Remote-Git-Host verbunden sind. Verwenden Sie zur Bestätigung das Der Parameterwert Der Parameterwert |
list_workflow_configs |
Listet die Workflowkonfigurationen in einem bestimmten Dataform-Repository auf. Der Parameterwert |
get_workflow_config |
Einzelne Dataform-Workflowkonfiguration abrufen. Der Parameterwert |
create_workflow_config |
Erstellt eine neue Workflowkonfiguration in einem bestimmten Dataform-Repository. Der Parameterwert
In einer Workflowkonfiguration wird ein Voraussetzung: Sie müssen zuerst mit dem Tool Workflowaufrufe, die aus dieser Workflowkonfiguration erstellt werden, werden unter einem benutzerdefinierten Dienstkonto ausgeführt. Legen Sie den Parameterwert |
update_workflow_config |
Aktualisieren Sie die Attribute einer vorhandenen Dataform-Workflowkonfiguration, z. B. den Ausführungszeitplan (Cron), die zugehörige Releasekonfiguration oder die Überschreibungen für den Aufruf. Änderungen an der Der Parameterwert Der Parameterwert Workflowaufrufe, die aus dieser Workflowkonfiguration erstellt werden, werden unter einem benutzerdefinierten Dienstkonto ausgeführt. Legen Sie den Parameterwert |
list_release_configs |
Listet die Releasekonfigurationen in einem bestimmten Dataform-Repository auf. Der Parameterwert |
get_release_config |
Eine einzelne Dataform-Releasekonfiguration abrufen. Der Parameterwert |
create_release_config |
Erstellen einer neuen Releasekonfiguration in einem bestimmten Dataform-Repository Der Parameterwert
Lassen Sie den Parameterwert |
update_release_config |
Aktualisieren Sie eine vorhandene Dataform-Releasekonfiguration, die als Vorlage für die automatische Codekompilierung dient. Aktualisierungen von Feldern wie Lassen Sie den Parameterwert Der Parameterwert |
create_compilation_result |
Erstellt ein neues Dataform-Kompilierungsergebnis in einem bestimmten Google Cloud-Projekt und an einem bestimmten Standort. Mit diesem Tool werden Der Parameterwert Agents können das kompilierte SQL validieren, indem sie Bevor Sie einen manuellen Workflow mit dem Tool Voraussetzung: Erstellen Sie ein Repository mit dem Tool |
list_workflow_invocations |
Listet die Workflow-Aufrufe in einem bestimmten Dataform-Repository auf. Der Parameterwert |
create_workflow_invocation |
Erstellt einen neuen Workflowaufruf in einem bestimmten Dataform-Repository. Der Parameterwert Der Parameterwert
Voraussetzung: Damit eine Aufrufung ausgelöst werden kann, müssen Sie zuerst entweder eine Der Workflowaufruf wird unter einem Dienstkonto ausgeführt, das durch die Kompilierungsquelle bestimmt wird:
Das Dienstkonto darf nicht der Dataform-Standarddienst-Agent sein. Das Dienstkonto muss die erforderlichen Berechtigungen zum Ausführen des Workflows haben und der Nutzer muss berechtigt sein, als das ausgewählte Dienstkonto zu agieren. Diese Autorisierung wird in der Regel über die Rolle „Dienstkontonutzer“ ( |
cancel_workflow_invocation |
Fordern Sie die ordnungsgemäße Beendigung eines laufenden Dataform-Workflowaufrufs an. Mit diesem Tool wird ein Abbruchsignal an den laufenden Workflow gesendet. Einzelne BigQuery-Jobs, Tabellenerstellungen oder Zusicherungen, die bereits im Rahmen dieses Workflows abgeschlossen wurden, werden jedoch nicht rückgängig gemacht. Der Parameterwert |
get_compilation_result |
Ein einzelnes Dataform-Kompilierungsergebnis abrufen. Der Parameterwert |
query_compilation_actions |
Gibt die Aktionen für das Kompilierungsergebnis für ein bestimmtes Dataform-Kompilierungsergebnis zurück. Der Parameterwert |
query_workflow_invocation_actions |
Gibt die Workflow-Aufrufaktionen für einen bestimmten Dataform-Workflow-Aufruf zurück. Diese Aktionen stellen die einzelnen BigQuery-Jobs, Tabellenerstellungen oder Zusicherungen dar, aus denen der Workflow besteht. Der Parameterwert |
get_workflow_invocation |
Einen einzelnen Dataform-Workflowaufruf abrufen. Der Parameterwert |
list_workspaces |
Entwicklungsarbeitsbereiche in einem bestimmten Dataform-Repository auflisten Mit diesem Tool können Sie vorhandene Arbeitsbereiche ermitteln, bevor Sie Dateivorgänge (mit Tools wie Der Parameterwert |
get_workspace |
Einen einzelnen Dataform-Entwicklungsarbeitsbereich abrufen. Der Parameterwert Wenn Sie den genauen Namen des Arbeitsbereichs nicht kennen, können Sie ihn mit dem Tool |
create_workspace |
Einen neuen Entwicklungsarbeitsbereich in einem bestimmten Dataform-Repository erstellen Ein Arbeitsbereich ist ein isolierter, bearbeitbarer Checkout des Repositorys. Verwenden Sie einen Arbeitsbereich, wenn Sie Pipelinecode in mehreren Dateien erstellen oder überarbeiten und vor dem Committen validieren müssen. Bearbeiten Sie Dateien im Arbeitsbereich mit den Tools Verwenden Sie das Tool Voraussetzung: Das übergeordnete Repository muss vorhanden sein. Der Parameterwert Der Parameterwert Der Parameterwert |
query_directory_contents |
Gibt den Inhalt eines bestimmten Verzeichnisses in einem Dataform-Arbeitsbereich zurück. Mit diesem Tool können Sie gültige Dateipfade ermitteln, bevor Sie die Tools Der Parameterwert Der Parameterwert |
search_files |
Dateien und Verzeichnisse in einem Dataform-Arbeitsbereich finden, die einem Suchfilter entsprechen Verwenden Sie dieses Tool anstelle des rekursiven Auflistens von Verzeichnissen mit dem Tool Der Parameterwert Der Parameterwert |
read_file |
Gibt den Inhalt einer Datei in einem Dataform-Arbeitsbereich zurück, einschließlich nicht übertragener Änderungen. Mit diesem Tool können Sie die Datei Wenn Sie eine committete Datei direkt aus dem Repository ohne Arbeitsbereich lesen möchten, verwenden Sie stattdessen das Der Parameterwert Der Parameterwert Mit dem Parameterwert |
write_file |
Schreibt den Inhalt einer Datei in einen Dataform-Arbeitsbereich und erstellt die Datei, wenn sie nicht vorhanden ist. Der angegebene Parameterwert Der Parameterwert Der Parameterwert Der Parameterwert |
remove_file |
Löschen einer Datei in einem Dataform-Arbeitsbereich Das Löschen wird erst übernommen, wenn das Der Parameterwert Der Parameterwert |
make_directory |
Erstellt ein Verzeichnis in einem Dataform-Arbeitsbereich, einschließlich aller fehlenden übergeordneten Verzeichnisse. Der Parameterwert Der Parameterwert |
commit_workspace_changes |
Einen Git-Commit für die Änderungen ohne Commit in einem Dataform-Arbeitsbereich aufzeichnen Der Commit bleibt lokal im Arbeitsbereich, bis er mit dem Tool Standardmäßig werden alle Änderungen ohne durchgeführten Commit übernommen. Wenn Sie nur eine Teilmenge von Dateien committen möchten, geben Sie den Parameterwert Der Parameterwert Der Parameterwert Der Parameterwert |
push_git_commits |
Übertragen Sie per Push-Befehl die Änderungen, die in einem Dataform-Arbeitsbereich vorgenommen wurden, an das Git-Remote des Repositorys. Voraussetzung: Sie müssen Arbeitsbereichsänderungen mit dem Tool Wenn Sie das Der Parameterwert Der Parameterwert |
get_repository |
Ein einzelnes Dataform-Repository abrufen, einschließlich der Git-Remote-Einstellungen, der Überschreibungen für die Workspace-Kompilierung und des Standarddienstkontos. Mit diesem Tool können Sie das Feld Der Parameterwert Wenn Sie den genauen Namen des Repositorys nicht kennen, können Sie ihn mit dem Tool |
update_repository |
Aktualisieren Sie die Eigenschaften eines vorhandenen Dataform-Repositorys, z. B. die Git-Remote-Einstellungen, Überschreibungen der Arbeitsbereichskompilierung oder das Standarddienstkonto. Voraussetzung: Verwenden Sie das Tool Wenn der Parameterwert Der Parameterwert |
create_folder |
Erstellt einen neuen Dataform-Ordner in einem bestimmten Google Cloud-Projekt und an einem bestimmten Standort. Mit Ordnern werden Dataform-Repositories in einer Hierarchie organisiert. Wenn Sie einen Ordner erstellen, werden keine Repositorys darin verschoben. Wenn Sie ein Repository in einem Ordner platzieren möchten, legen Sie den Parameterwert Versuchen Sie nicht, ein vorhandenes Repository mit dem Der Parameterwert Der Parameterwert |
Spezifikationen für MCP-Tools abrufen
Wenn Sie die MCP-Tool-Spezifikationen für alle Tools auf einem MCP-Server abrufen möchten, verwenden Sie die Methode tools/list. Im folgenden Beispiel wird gezeigt, wie Sie mit curl alle Tools und ihre Spezifikationen auflisten, die derzeit auf dem MCP-Server verfügbar sind.
| Curl-Anfrage |
|---|
curl --location 'https://dataform.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/list", "jsonrpc": "2.0", "id": 1 }' |