MCP Reference: dataform.googleapis.com

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 parent muss das Format projects/{project_id}/locations/{location} haben.

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 parent muss das Format projects/{project_id}/locations/{location} haben.

Der Parameterwert repository_id ist die ID, die für das Repository verwendet werden soll.

Lassen Sie den Parameter strictActAsChecks weg, damit er in einem neuen Repository nicht festgelegt wird. Beachten Sie, dass für neue Projekte standardmäßig strenge „Act-as“-Prüfungen erzwungen werden. Für die Ausführung eines Workflows in diesem Repository ist daher ein benutzerdefiniertes Dienstkonto erforderlich.

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 get_repository-Tool. Wenn das Feld git_remote_settings vorhanden ist, ist das Repository mit einem Remote-Host verbunden und Sie müssen stattdessen Arbeitsbereich-basierte Tools wie commit_workspace_changes verwenden.

Durch diese Commit-Aktion wird ein permanenter Eintrag im internen Git-Verlauf des Repositorys erstellt.

Der Parameterwert name muss das Format projects/{project_id}/locations/{location}/repositories/{repository} haben.

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 get_repository-Tool. Wenn das Feld git_remote_settings vorhanden ist, ist das Repository mit einem Remote-Host verbunden und Sie müssen das read_file-Tool verwenden, um die Datei stattdessen aus einem Arbeitsbereich zu lesen.

Der Parameterwert name bezieht sich auf das Repository und muss das Format projects/{project_id}/locations/{location}/repositories/{repository} haben.

Der Parameterwert path muss relativ zum Stammverzeichnis des Repository sein. Verwenden Sie keine Pfadmanipulation wie ... Verwenden Sie das Tool query_repository_directory_contents, um gültige Dateipfade zu erhalten.

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 get_repository-Tool. Wenn das Feld git_remote_settings vorhanden ist, ist das Repository mit einem Remote-Host verbunden und Sie müssen stattdessen das Tool query_directory_contents verwenden, um ein Arbeitsbereichverzeichnis aufzulisten.

Der Parameterwert name verweist auf das Repository im Format projects/{project_id}/locations/{location}/repositories/{repository}.

Der Parameterwert path muss relativ zum Stammverzeichnis des Repository sein. Verwenden Sie keine Pfadmanipulation wie ... Wenn Sie dieses Feld leer lassen, wird das Stammverzeichnis des Repositorys verwendet.

list_workflow_configs

Listet die Workflowkonfigurationen in einem bestimmten Dataform-Repository auf.

Der Parameterwert parent muss das Format projects/{project_id}/locations/{location}/repositories/{repository} haben.

get_workflow_config

Einzelne Dataform-Workflowkonfiguration abrufen.

Der Parameterwert name muss das Format projects/{project_id}/locations/{location}/repositories/{repository}/workflowConfigs/{workflow_config} haben.

create_workflow_config

Erstellt eine neue Workflowkonfiguration in einem bestimmten Dataform-Repository.

Der Parameterwert parent muss das Format projects/{project_id}/locations/{location}/repositories/{repository} haben.

workflow_config_id ist die ID der Workflowkonfiguration.

In einer Workflowkonfiguration wird ein ReleaseConfig mit einem Zeitplan und einer Identität verknüpft. Mit ReleaseConfig wird festgelegt, welcher Code kompiliert wird. Mit diesem Tool wird festgelegt, wann dieser Code ausgeführt wird und mit welchem Dienstkonto er ausgeführt wird.

Voraussetzung: Sie müssen zuerst mit dem Tool create_release_config ein ReleaseConfig erstellen. Der Parameterwert workflow_config.release_config ist erforderlich. Ohne ihn schlägt die Anfrage fehl.

Workflowaufrufe, die aus dieser Workflowkonfiguration erstellt werden, werden unter einem benutzerdefinierten Dienstkonto ausgeführt. Legen Sie den Parameterwert invocationConfig.serviceAccount fest, um dieses Dienstkonto anzugeben. Wenn nichts angegeben ist, wird für Aufrufe das service_account des Repositorys verwendet. 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 Konto zu agieren. Diese Autorisierung wird in der Regel über die IAM-Rolle „Dienstkontonutzer“ (roles/iam.serviceAccountUser) erteilt, die für das Dienstkonto selbst oder für das Projekt, das es enthält, erteilt werden kann.

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 cron_schedule werden sofort für alle zukünftigen geplanten Ausführungen wirksam.

Der Parameterwert name muss das Format projects/{project_id}/locations/{location}/repositories/{repository}/workflowConfigs/{workflow_config} haben.

Der Parameterwert workflow_config.release_config ist für jedes Update unbedingt erforderlich. Lesen Sie mit dem get_workflow_config-Tool die aktuelle Workflowkonfiguration und fügen Sie den release_config-Wert in Ihre Aktualisierungsanfrage ein.

Workflowaufrufe, die aus dieser Workflowkonfiguration erstellt werden, werden unter einem benutzerdefinierten Dienstkonto ausgeführt. Legen Sie den Parameterwert invocationConfig.serviceAccount fest, um dieses Dienstkonto anzugeben. Wenn nichts angegeben ist, wird für Aufrufe das service_account des Repositorys verwendet. 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 IAM-Rolle „Dienstkontonutzer“ (roles/iam.serviceAccountUser) erteilt, die für das Dienstkonto selbst oder für das Projekt, das es enthält, erteilt werden kann.

list_release_configs

Listet die Releasekonfigurationen in einem bestimmten Dataform-Repository auf.

Der Parameterwert parent muss das Format projects/{project_id}/locations/{location}/repositories/{repository} haben.

get_release_config

Eine einzelne Dataform-Releasekonfiguration abrufen.

Der Parameterwert name muss das Format projects/{project_id}/locations/{location}/repositories/{repository}/releaseConfigs/{release_config} haben.

create_release_config

Erstellen einer neuen Releasekonfiguration in einem bestimmten Dataform-Repository

Der Parameterwert parent muss das Format projects/{project_id}/locations/{location}/repositories/{repository} haben.

release_config_id ist die benutzerdefinierte ID für die Releasekonfiguration. Wenn der Nutzer keine ID angibt, generiere eine kurze, beschreibende ID mit Kleinbuchstaben, Zahlen und Bindestrichen, die auf seiner Anfrage basiert.

Lassen Sie den Parameterwert release_config.cron_schedule für von Google gehostete Repositories weg. Verwenden Sie zur Bestätigung das get_repository-Tool. Wenn das Feld git_remote_settings fehlt, wird das Repository von Google gehostet. Um die Pipeline zu planen, legen Sie den Zeitplan mit dem create_workflow_config-Tool fest.

update_release_config

Aktualisieren Sie eine vorhandene Dataform-Releasekonfiguration, die als Vorlage für die automatische Codekompilierung dient.

Aktualisierungen von Feldern wie git_commitish wirken sich darauf aus, wie zukünftige Kompilierungsergebnisse generiert werden. Sie ändern jedoch nicht rückwirkend vorhandene CompilationResult-Assets.

Lassen Sie den Parameterwert release_config.cron_schedule beim Aktualisieren von von Google gehosteten Repositories weg. Verwenden Sie zur Bestätigung das get_repository-Tool. Wenn das Feld git_remote_settings fehlt, wird das Repository von Google gehostet. Wenn Sie die Pipeline planen möchten, legen Sie den Zeitplan mit dem Tool create_workflow_config oder update_workflow_config fest oder aktualisieren Sie ihn.

Der Parameterwert name muss das Format projects/{project_id}/locations/{location}/repositories/{repository}/releaseConfigs/{release_config} haben.

create_compilation_result

Erstellt ein neues Dataform-Kompilierungsergebnis in einem bestimmten Google Cloud-Projekt und an einem bestimmten Standort.

Mit diesem Tool werden .sqlx-Dateien in ausführbaren SQL-Code kompiliert. KI-Agenten müssen wissen, dass nachfolgende Codeänderungen in diesem Ergebnis nicht berücksichtigt werden, sofern keine neue Kompilierung ausgelöst wird.

Der Parameterwert parent muss das Format projects/{project_id}/locations/{location}/repositories/{repository} haben.

Agents können das kompilierte SQL validieren, indem sie CompilationResultAction-Ressourcen prüfen und möglicherweise ein BigQuery-Tool für einen Probelauf verwenden.

Bevor Sie einen manuellen Workflow mit dem Tool create_workflow_invocation aufrufen, ist ein gültiges Kompilierungsergebnis erforderlich.

Voraussetzung: Erstellen Sie ein Repository mit dem Tool create_repository, bevor Sie das Tool create_compilation_result aufrufen.

list_workflow_invocations

Listet die Workflow-Aufrufe in einem bestimmten Dataform-Repository auf.

Der Parameterwert parent muss das Format projects/{project_id}/locations/{location}/repositories/{repository} haben.

create_workflow_invocation

Erstellt einen neuen Workflowaufruf in einem bestimmten Dataform-Repository.

Der Parameterwert parent muss das Format projects/{project_id}/locations/{location}/repositories/{repository} haben.

Der Parameterwert compilation_result oder workflow_config ist erforderlich.

  • Wenn Sie compilation_result verwenden, muss der Parameterwert das Format projects/{project_id}/locations/{location}/repositories/{repository}/compilationResults/{compilation_result} haben.
  • Wenn Sie workflow_config verwenden, muss der Parameterwert das Format projects/{project_id}/locations/{location}/repositories/{repository}/workflowConfigs/{workflow_config} haben.

Voraussetzung: Damit eine Aufrufung ausgelöst werden kann, müssen Sie zuerst entweder eine compilation_result mit dem Tool create_compilation_result oder eine workflow_config mit dem Tool create_workflow_config erstellen. Sie können einen Aufruf nicht direkt über den Rohcode des Repositorys auslösen.

Der Workflowaufruf wird unter einem Dienstkonto ausgeführt, das durch die Kompilierungsquelle bestimmt wird:

  • Wenn Sie compilation_result verwenden, legen Sie den Parameterwert invocationConfig.serviceAccount fest. Wenn keine Angabe erfolgt, wird der Standardwert service_account des Repositorys verwendet.
  • Wenn Sie workflow_config verwenden, legen Sie den Parameter invocationConfig nicht fest. Der Aufruf wird automatisch unter dem Dienstkonto ausgeführt, das für diese Workflowkonfiguration konfiguriert ist.

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“ (roles/iam.serviceAccountUser) erteilt, die für das Dienstkonto selbst oder für das Projekt, das es enthält, erteilt werden kann.

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 name muss das Format projects/{project_id}/locations/{location}/repositories/{repository}/workflowInvocations/{workflow_invocation} haben.

get_compilation_result

Ein einzelnes Dataform-Kompilierungsergebnis abrufen.

Der Parameterwert name muss das Format projects/{project_id}/locations/{location}/repositories/{repository}/compilationResults/{compilation_result} haben.

query_compilation_actions

Gibt die Aktionen für das Kompilierungsergebnis für ein bestimmtes Dataform-Kompilierungsergebnis zurück.

Der Parameterwert name muss das Format projects/{project_id}/locations/{location}/repositories/{repository}/compilationResults/{compilation_result} haben.

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 name muss das Format projects/{project_id}/locations/{location}/repositories/{repository}/workflowInvocations/{workflow_invocation} haben.

get_workflow_invocation

Einen einzelnen Dataform-Workflowaufruf abrufen.

Der Parameterwert name muss das Format projects/{project_id}/locations/{location}/repositories/{repository}/workflowInvocations/{workflow_invocation} haben.

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 read_file oder write_file) ausführen oder Code (mit einem Tool wie commit_workspace_changes) committen.

Der Parameterwert parent muss das Format projects/{project_id}/locations/{location}/repositories/{repository} haben.

get_workspace

Einen einzelnen Dataform-Entwicklungsarbeitsbereich abrufen.

Der Parameterwert name muss das Format projects/{project_id}/locations/{location}/repositories/{repository}/workspaces/{workspace} haben.

Wenn Sie den genauen Namen des Arbeitsbereichs nicht kennen, können Sie ihn mit dem Tool list_workspaces ermitteln.

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 write_file und remove_file, zeichnen Sie das Ergebnis mit dem Tool commit_workspace_changes auf und veröffentlichen Sie die übernommenen Änderungen im Repository mit dem Tool push_git_commits.

Verwenden Sie das Tool commit_repository_changes nicht für die Entwicklung von Standardpipelines. Dieses Tool schreibt direkt in das Repository, ist nur für Assets mit einer einzelnen Datei wie Notebooks oder gespeicherte Abfragen vorgesehen und schlägt bei Repositories fehl, die mit einem Remote-Git-Host verbunden sind.

Voraussetzung: Das übergeordnete Repository muss vorhanden sein.

Der Parameterwert parent muss das Format projects/{project_id}/locations/{location}/repositories/{repository} haben.

Der Parameterwert workspace_id ist die ID, die für den Arbeitsbereich verwendet werden soll.

Der Parameterwert workspace enthält den Workspace, der erstellt werden soll.

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 read_file oder write_file aufrufen.

Der Parameterwert workspace muss das Format projects/{project_id}/locations/{location}/repositories/{repository}/workspaces/{workspace} haben.

Der Parameterwert path ist der relative Pfad zum Verzeichnis vom Workspace-Stammverzeichnis aus. Verwenden Sie keine Pfadmanipulation wie ... Wenn nichts angegeben ist, wird das Arbeitsbereich-Stammverzeichnis verwendet.

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 query_directory_contents, wenn Sie eine Datei anhand des Namens oder der Erweiterung in einem großen Repository suchen.

Der Parameterwert workspace muss das Format projects/{project_id}/locations/{location}/repositories/{repository}/workspaces/{workspace} haben.

Der Parameterwert filter schränkt die Ergebnisse ein. Das Filtern wird nur für das Feld path unterstützt, z. B. path="*.sqlx" oder path="definitions/model.sqlx".

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 workflow_settings.yaml des Arbeitsbereichs lesen, die die Kompilierungseinstellungen der Pipeline enthält, z. B. das Standard-BigQuery-Dataset, den standardmäßigen Standort und die Dataform Core-Version. Diese Datei befindet sich im Stammverzeichnis der Pipeline, das nicht unbedingt das Stammverzeichnis des Arbeitsbereichs ist, da ein Repository mehrere Pipelines in Unterverzeichnissen enthalten kann. Suchen Sie mit dem search_files-Tool nach der Datei.

Wenn Sie eine committete Datei direkt aus dem Repository ohne Arbeitsbereich lesen möchten, verwenden Sie stattdessen das read_repository_file-Tool. Beachten Sie, dass read_repository_file nur für Repositories funktioniert, die nicht mit einem Remote-Git-Host verbunden sind.

Der Parameterwert workspace muss das Format projects/{project_id}/locations/{location}/repositories/{repository}/workspaces/{workspace} haben.

Der Parameterwert path ist der relative Pfad zur Datei vom Arbeitsbereichsstamm aus. Verwenden Sie keine Pfadmanipulation wie ... Gültige Pfade können mit den Tools query_directory_contents oder search_files abgerufen werden.

Mit dem Parameterwert revision wird optional eine bestimmte Git-Version der Datei ausgewählt. Wird sie nicht angegeben, wird der aktuelle nicht übertragene Status der Datei zurückgegeben.

write_file

Schreibt den Inhalt einer Datei in einen Dataform-Arbeitsbereich und erstellt die Datei, wenn sie nicht vorhanden ist.

Der angegebene Parameterwert contents ersetzt die gesamte Datei. Lesen Sie daher die aktuellen Inhalte mit dem Tool read_file, bevor Sie eine teilweise Bearbeitung vornehmen. Änderungen werden erst übernommen, wenn das commit_workspace_changes-Tool aufgerufen wird.

Der Parameterwert workspace muss das Format projects/{project_id}/locations/{location}/repositories/{repository}/workspaces/{workspace} haben.

Der Parameterwert path ist der relative Pfad zur Datei vom Arbeitsbereichsstamm aus. Verwenden Sie keine Pfadmanipulation wie ...

Der Parameterwert contents muss ein Base64-codierter String mit dem Dateiinhalt sein.

remove_file

Löschen einer Datei in einem Dataform-Arbeitsbereich

Das Löschen wird erst übernommen, wenn das commit_workspace_changes-Tool aufgerufen wird.

Der Parameterwert workspace muss das Format projects/{project_id}/locations/{location}/repositories/{repository}/workspaces/{workspace} haben.

Der Parameterwert path ist der relative Pfad zur Datei vom Arbeitsbereichsstamm aus. Verwenden Sie keine Pfadmanipulation wie ... Gültige Dateipfade können mit den Tools query_directory_contents oder search_files abgerufen werden.

make_directory

Erstellt ein Verzeichnis in einem Dataform-Arbeitsbereich, einschließlich aller fehlenden übergeordneten Verzeichnisse.

Der Parameterwert workspace muss das Format projects/{project_id}/locations/{location}/repositories/{repository}/workspaces/{workspace} haben.

Der Parameterwert path ist der relative Pfad zum Verzeichnis vom Workspace-Stammverzeichnis aus. Verwenden Sie keine Pfadmanipulation wie ...

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 push_git_commits veröffentlicht wird.

Standardmäßig werden alle Änderungen ohne durchgeführten Commit übernommen. Wenn Sie nur eine Teilmenge von Dateien committen möchten, geben Sie den Parameterwert paths an.

Der Parameterwert name muss das Format projects/{project_id}/locations/{location}/repositories/{repository}/workspaces/{workspace} haben.

Der Parameterwert author gibt den Git-Autor an, der für den Commit aufgezeichnet wurde. Sowohl author.name als auch author.email_address sind erforderlich. Geben Sie die Werte an, die den Nutzer identifizieren, in dessen Namen der Commit erfolgt. Verwenden Sie keine Platzhalter, da sie in den Git-Verlauf geschrieben werden.

Der Parameterwert commit_message ist die Commit-Nachricht.

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 commit_workspace_changes committen, bevor Sie sie übertragen. Nicht übernommene Änderungen bleiben lokal und werden nicht übertragen.

Wenn Sie das create_release_config-Tool verwenden möchten, müssen Sie Ihre Commits zuerst pushen. Eine Releasekonfiguration löst ihr git_commitish im Git-Remote-Repository auf. Ein Branch oder Commit, der nur im lokalen Arbeitsbereich vorhanden ist, ist für sie also nicht sichtbar.

Der Parameterwert name muss das Format projects/{project_id}/locations/{location}/repositories/{repository}/workspaces/{workspace} haben.

Der Parameterwert remote_branch ist der Remote-Branch, in den die Änderungen übertragen werden sollen. Wird dieser Parameter weggelassen, wird ein Arbeitsbereich mit aktivierter Zweigverwaltung in den aktuell ausgecheckten Zweig übertragen und jeder andere Arbeitsbereich in den konfigurierten Standardzweig des Repositorys.

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 git_remote_settings prüfen, um zu ermitteln, wie Sie mit dem Repository interagieren können. Wenn das Feld git_remote_settings vorhanden ist, ist das Repository mit einem Remote-Git-Host verbunden. Das bedeutet, dass Sie für die Pipelineentwicklung arbeitsbereichbasierte Tools wie create_workspace oder commit_workspace_changes verwenden müssen. Wenn das Feld fehlt, wird das Repository von Google gehostet. Sie können Arbeitsbereiche in diesem Fall weiterhin für die Pipelineentwicklung verwenden. Direkte Repository-Tools wie commit_repository_changes werden nicht empfohlen, es sei denn, Sie verwalten Assets mit einzelnen Dateien.

Der Parameterwert name muss das Format projects/{project_id}/locations/{location}/repositories/{repository} haben.

Wenn Sie den genauen Namen des Repositorys nicht kennen, können Sie ihn mit dem Tool list_repositories herausfinden.

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 get_repository, um den aktuellen Repository-Status vor der Aktualisierung zu lesen.

Wenn der Parameterwert update_mask weggelassen wird, werden alle veränderbaren Felder mit den im Parameterwert repository angegebenen Werten überschrieben. Wenn Sie nur bestimmte Felder ändern möchten, ohne die anderen zu löschen, listen Sie diese Felder in update_mask auf.

Der Parameterwert repository.name muss das Format projects/{project_id}/locations/{location}/repositories/{repository} haben.

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 containing_folder fest, wenn Sie das Tool create_repository verwenden.

Versuchen Sie nicht, ein vorhandenes Repository mit dem update_repository-Tool in einen Ordner zu verschieben. Nachdem ein Repository erstellt wurde, kann das Feld containing_folder nicht mehr mit MCP-Tools geändert werden.

Der Parameterwert parent muss das Format projects/{project_id}/locations/{location} haben.

Der Parameterwert folder.display_name ist erforderlich und gibt den benutzerfreundlichen Namen des Ordners an.

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
}'