MCP Tools Reference: dataform.googleapis.com

Outil : get_compilation_result

Récupérer un seul résultat de compilation Dataform.

La valeur du paramètre name doit être au format projects/{project_id}/locations/{location}/repositories/{repository}/compilationResults/{compilation_result}.

L'exemple de code suivant montre comment utiliser curl pour appeler l'outil MCP get_compilation_result.

Requête curl 
curl --location 'https://dataform.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "get_compilation_result",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Schéma d'entrée

Message de requête GetCompilationResult.

GetCompilationResultRequest

Représentation JSON 
{
  "name": string
}
Champs
name

string

Obligatoire. Nom du résultat de la compilation.

Schéma de sortie

Représente le résultat de la compilation d'un projet Dataform.

CompilationResult

Représentation JSON 
{
  "name": string,
  "codeCompilationConfig": {
    object (CodeCompilationConfig)
  },
  "resolvedGitCommitSha": string,
  "dataformCoreVersion": string,
  "compilationErrors": [
    {
      object (CompilationError)
    }
  ],
  "dataEncryptionState": {
    object (DataEncryptionState)
  },
  "createTime": string,
  "privateResourceMetadata": {
    object (PrivateResourceMetadata)
  },
  "gcsRepositorySnapshotMetadata": {
    object (GcsRepositorySnapshotMetadata)
  },

  // Union field source can be only one of the following:
  "gitCommitish": string,
  "workspace": string,
  "releaseConfig": string
  // End of list of possible types for union field source.

  // Union field _internal_metadata can be only one of the following:
  "internalMetadata": string
  // End of list of possible types for union field _internal_metadata.
}
Champs
name

string

Uniquement en sortie. Nom du résultat de la compilation.
codeCompilationConfig

object (CodeCompilationConfig)

Immuable. Si cette option est définie, les champs de code_compilation_config remplacent les paramètres de compilation par défaut spécifiés dans dataform.json.
resolvedGitCommitSha

string

Uniquement en sortie. SHA de commit Git entièrement résolu du code compilé. Non défini pour les résultats de compilation dont la source est un espace de travail.
dataformCoreVersion

string

Uniquement en sortie. Version de @dataform/core utilisée pour la compilation.
compilationErrors[]

object (CompilationError)

Uniquement en sortie. Erreurs rencontrées lors de la compilation du projet.
dataEncryptionState

object (DataEncryptionState)

Uniquement en sortie. Défini uniquement si le dépôt possède une clé KMS.
createTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la création du résultat de la compilation.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
privateResourceMetadata

object (PrivateResourceMetadata)

Uniquement en sortie. Métadonnées indiquant si cette ressource est de portée utilisateur. La ressource CompilationResult est user_scoped uniquement si elle provient d'un espace de travail.
gcsRepositorySnapshotMetadata

object (GcsRepositorySnapshotMetadata)

Uniquement en sortie. Métadonnées sur l'instantané du dépôt utilisé par les notebooks planifiés.
Champ d'union source. Source du résultat de la compilation. source ne peut être qu'un des éléments suivants :
gitCommitish

string

Immuable. Nom de la branche, du tag ou du commit Git à partir duquel le dépôt doit être compilé. Doit exister dans le dépôt distant. Exemples : - un SHA de commit : 12ade345 - un tag : tag1 - un nom de branche : branch1
workspace

string

Immuable. Nom de l'espace de travail à compiler. Il doit respecter le format projects/*/locations/*/repositories/*/workspaces/*.
releaseConfig

string

Immuable. Nom de la configuration de version à compiler. Il doit respecter le format projects/*/locations/*/repositories/*/releaseConfigs/*.

Champ d'union _internal_metadata.

_internal_metadata ne peut être qu'un des éléments suivants :
internalMetadata

string

Uniquement en sortie. Toutes les informations de métadonnées utilisées en interne pour diffuser la ressource. Par exemple : codes temporels, indicateurs, champs d'état, etc. Le format de ce champ est une chaîne JSON.

CodeCompilationConfig

Représentation JSON 
{
  "defaultDatabase": string,
  "defaultSchema": string,
  "defaultLocation": string,
  "assertionSchema": string,
  "vars": {
    string: string,
    ...
  },
  "databaseSuffix": string,
  "schemaSuffix": string,
  "tablePrefix": string,
  "builtinAssertionNamePrefix": string,
  "defaultNotebookRuntimeOptions": {
    object (NotebookRuntimeOptions)
  },
  "pipelineConfig": {
    object (PipelineConfig)
  }
}
Champs
defaultDatabase

string

Facultatif. Base de données par défaut (ID du projet Google Cloud).
defaultSchema

string

Facultatif. Schéma par défaut (ID de l'ensemble de données BigQuery).
defaultLocation

string

Facultatif. Emplacement BigQuery par défaut à utiliser. La valeur par défaut est "US". Pour obtenir la liste complète des emplacements, consultez la documentation BigQuery : https://cloud.google.com/bigquery/docs/locations.
assertionSchema

string

Facultatif. Schéma par défaut (ID de l'ensemble de données BigQuery) pour les assertions.
vars

map (key: string, value: string)

Facultatif. Variables définies par l'utilisateur et mises à la disposition du code du projet lors de la compilation.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
databaseSuffix

string

Facultatif. Suffixe à ajouter à tous les noms de bases de données (ID de projet Google Cloud).
schemaSuffix

string

Facultatif. Suffixe à ajouter à tous les noms de schémas (ID d'ensemble de données BigQuery).
tablePrefix

string

Facultatif. Préfixe à ajouter à tous les noms de tables.
builtinAssertionNamePrefix

string

Facultatif. Préfixe à ajouter aux noms d'assertion intégrés.
defaultNotebookRuntimeOptions

object (NotebookRuntimeOptions)

Facultatif. Options d'exécution de notebook par défaut.
pipelineConfig

object (PipelineConfig)

Facultatif. Options de pipeline qui définissent le type et le chemin d'accès du pipeline dans le dépôt Git.

VarsEntry

Représentation JSON 
{
  "key": string,
  "value": string
}
Champs
key

string
value

string

NotebookRuntimeOptions

Représentation JSON 
{
  "aiPlatformNotebookRuntimeTemplate": string,

  // Union field execution_sink can be only one of the following:
  "gcsOutputBucket": string
  // End of list of possible types for union field execution_sink.

  // Union field repository_snapshot_storage can be only one of the following:
  "gcsRepositorySnapshotDestination": {
    object (GcsRepositorySnapshotDestination)
  }
  // End of list of possible types for union field repository_snapshot_storage.
}
Champs
aiPlatformNotebookRuntimeTemplate

string

Facultatif. Nom de ressource du modèle d'exécution Colab à partir duquel un environnement d'exécution est créé pour les exécutions de notebooks. Si aucune spécification n'est fournie, un environnement d'exécution est créé avec les spécifications par défaut de Colab.
Champ d'union execution_sink. Emplacement pour stocker le résultat de l'exécution du notebook. execution_sink ne peut être qu'un des éléments suivants :
gcsOutputBucket

string

Facultatif. Emplacement Google Cloud Storage dans lequel importer le résultat. Format : gs://bucket-name.
Champ d'union repository_snapshot_storage. La destination de l'instantané des fichiers de dépôt qui seront disponibles en accès en lecture seule dans un environnement d'exécution de notebook repository_snapshot_storage ne peut être que l'une des suivantes :
gcsRepositorySnapshotDestination

object (GcsRepositorySnapshotDestination)

Facultatif. Destination Google Cloud Storage vers laquelle importer l'instantané. Si l'URI est vide, le bucket de sortie GCS fourni est utilisé par défaut. Format : gs://bucket-name/path/.

GcsRepositorySnapshotDestination

Représentation JSON 
{
  "repositorySnapshotUri": string
}
Champs
repositorySnapshotUri

string

Facultatif. Destination Google Cloud Storage vers laquelle importer l'instantané du dépôt. Format : gs://bucket-name/path/.

PipelineConfig

Représentation JSON 
{
  "pipelineType": enum (PipelineType),
  "path": string
}
Champs
pipelineType

enum (PipelineType)

Obligatoire. Type de pipeline.
path

string

Obligatoire. Chemin d'accès relatif dans le dépôt Git où le pipeline est défini. Par exemple, pour un pipeline Dataform, il s'agit d'un chemin d'accès au dossier où se trouve workflow_settings.yaml ou dataform.json.

CompilationError

Représentation JSON 
{
  "message": string,
  "stack": string,
  "path": string,
  "actionTarget": {
    object (Target)
  }
}
Champs
message

string

Uniquement en sortie. Message de premier niveau de l'erreur.
stack

string

Uniquement en sortie. Trace de la pile complète de l'erreur.
path

string

Uniquement en sortie. Chemin d'accès au fichier dans lequel cette erreur s'est produite, le cas échéant, par rapport à la racine du projet.
actionTarget

object (Target)

Uniquement en sortie. Identifiant de l'action au cours de laquelle cette erreur s'est produite, le cas échéant.

Cible

Représentation JSON 
{
  "database": string,
  "schema": string,
  "name": string
}
Champs
database

string

Facultatif. Base de données de l'action (ID de projet Google Cloud) .
schema

string

Facultatif. Schéma de l'action (ID de l'ensemble de données BigQuery), dans database.
name

string

Facultatif. Nom de l'action, dans database et schema.

DataEncryptionState

Représentation JSON 
{
  "kmsKeyVersionName": string
}
Champs
kmsKeyVersionName

string

Obligatoire. Nom de la version de clé KMS avec laquelle les données d'une ressource sont chiffrées.

Horodatage

Représentation JSON 
{
  "seconds": string,
  "nanos": integer
}
Champs
seconds

string (int64 format)

Représente les secondes de l'heure UTC à partir de l'epoch Unix 1970-01-01T00:00:00Z. La valeur doit être comprise entre -62135596800 et 253402300799 inclus (ce qui correspond à 0001-01-01T00:00:00Z et 9999-12-31T23:59:59Z).
nanos

integer

Fractions de secondes non négatives avec une précision de l'ordre de la nanoseconde. Ce champ correspond à la partie en nanosecondes de la durée, et non à une alternative aux secondes. Les valeurs de secondes négatives avec des fractions doivent toujours comporter des valeurs de nanosecondes non négatives comptabilisées dans le temps. La valeur doit être comprise entre 0 et 999 999 999 inclus.

PrivateResourceMetadata

Représentation JSON 
{
  "userScoped": boolean
}
Champs
userScoped

boolean

Uniquement en sortie. Si la valeur est "true", cette ressource est de portée utilisateur, ce qui signifie qu'elle est associée à un espace de travail ou provient d'un espace de travail.

GcsRepositorySnapshotMetadata

Représentation JSON 
{
  "repositorySnapshotUri": string,
  "crc32cChecksum": string,
  "generation": string
}
Champs
repositorySnapshotUri

string

Uniquement en sortie. URI Google Cloud Storage du snapshot du dépôt.
crc32cChecksum

string

Uniquement en sortie. Somme de contrôle crc32c de l'instantané du dépôt, encodée en base64 big-endian.
generation

string (int64 format)

Uniquement en sortie. Numéro de génération de l'objet Cloud Storage. Consultez https://cloud.google.com/storage/docs/metadata#generation-number.

PipelineType

Type de pipeline. Cette durée pourra être prolongée à l'avenir. En cas de valeur UNSPECIFIED, l'erreur sera générée.

Enums
PIPELINE_TYPE_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
DATAFORM Pipeline Dataform standard.
SQL Élément de fichier unique SQL.
NOTEBOOK Composant de fichier unique Notebook.

Annotations d'outils

Les annotations d'outil sont envoyées aux clients MCP pour décrire le risque de base d'un outil donné. La plupart des clients traitent ces indices comme non fiables, mais ils peuvent être utilisés pour déterminer quand un message de confirmation peut être envoyé à un utilisateur.

En plus de la chaîne de titre, les indications booléennes suivantes sont définies comme suit :

  • readOnlyHint : si la valeur est "true", l'outil ne modifie pas son environnement. Valeur par défaut : "false".
  • destructiveHint : si la valeur est "true", l'outil peut effectuer des actions destructrices. Si la valeur est "false", l'outil ne peut effectuer que des actions d'ajout. Valeur par défaut : "true".
  • idempotentHint : si la valeur est "true", appeler l'outil à plusieurs reprises avec les mêmes arguments n'aura aucun effet supplémentaire sur son environnement. Valeur par défaut : "false".
  • openWorldHint : si la valeur est "true", l'outil peut interagir avec un "monde ouvert" d'entités externes. Si la valeur est "false", l'outil ne peut interagir qu'avec des entités internes. Par exemple, un outil de recherche Web serait en monde ouvert, tandis qu'un outil de mémoire ne le serait pas.

Indication destructive : ❌ | Indication d'idempotence : ✅ | Indication de lecture seule : ✅ | Indication de monde ouvert : ❌