MCP Tools Reference: dataform.googleapis.com

ツール: get_compilation_result

単一の Dataform コンパイル結果を取得します。

name パラメータの値は projects/{project_id}/locations/{location}/repositories/{repository}/compilationResults/{compilation_result} 形式にする必要があります。

次のコードサンプルは、curl を使用して get_compilation_result MCP ツールを呼び出す方法を示しています。

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

入力スキーマ

GetCompilationResult リクエスト メッセージ。

GetCompilationResultRequest

JSON 表現 
{
  "name": string
}
フィールド
name

string

必須。コンパイル結果の名前。

出力スキーマ

Dataform プロジェクトのコンパイル結果を表します。

CompilationResult

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.
}
フィールド
name

string

出力専用。コンパイル結果の名前。
codeCompilationConfig

object (CodeCompilationConfig)

変更不可。設定すると、code_compilation_config のフィールドは dataform.json で指定されたデフォルトのコンパイル設定をオーバーライドします。
resolvedGitCommitSha

string

出力専用。コンパイルされたコードの完全に解決された Git commit SHA。ソースがワークスペースであるコンパイル結果には設定されません。
dataformCoreVersion

string

出力専用。コンパイルに使用された @dataform/core のバージョン。
compilationErrors[]

object (CompilationError)

出力専用。プロジェクトのコンパイル中に発生したエラー。
dataEncryptionState

object (DataEncryptionState)

出力専用。リポジトリに KMS 鍵がある場合にのみ設定します。
createTime

string (Timestamp format)

出力専用。コンパイル結果が作成されたときのタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
privateResourceMetadata

object (PrivateResourceMetadata)

出力専用。このリソースがユーザー スコープかどうかを示すメタデータ。CompilationResult リソースは、ワークスペースから取得された場合にのみ user_scoped になります。
gcsRepositorySnapshotMetadata

object (GcsRepositorySnapshotMetadata)

出力専用。スケジュールされたノートブックで使用されるリポジトリ スナップショットに関するメタデータ。
共用体フィールド source。コンパイル結果のソース。source は次のいずれかになります。
gitCommitish

string

変更不可。リポジトリをコンパイルする Git コミット/タグ/ブランチ名。リモート リポジトリに存在する必要があります。例: - commit SHA: 12ade345 - タグ: tag1 - ブランチ名: branch1
workspace

string

変更不可。コンパイルするワークスペースの名前。projects/*/locations/*/repositories/*/workspaces/* の形式で指定してください。
releaseConfig

string

変更不可。コンパイルするリリース構成の名前。projects/*/locations/*/repositories/*/releaseConfigs/* の形式で指定してください。

共用体フィールド _internal_metadata。

_internal_metadata は次のいずれかになります。
internalMetadata

string

出力専用。リソースの提供に内部で使用されるすべてのメタデータ情報。たとえば、タイムスタンプ、フラグ、ステータス フィールドなどです。このフィールドの形式は JSON 文字列です。

CodeCompilationConfig

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)
  }
}
フィールド
defaultDatabase

string

省略可。デフォルト データベース（Google Cloud プロジェクト ID）。
defaultSchema

string

省略可。デフォルトのスキーマ（BigQuery データセット ID）。
defaultLocation

string

省略可。使用するデフォルトの BigQuery のロケーション。デフォルトは「US」です。ロケーションの完全なリストについては、BigQuery のドキュメント（https://cloud.google.com/bigquery/docs/locations）をご覧ください。
assertionSchema

string

省略可。アサーションのデフォルトのスキーマ（BigQuery データセット ID）
vars

map (key: string, value: string)

省略可。コンパイル中にプロジェクト コードで使用できるユーザー定義変数。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
databaseSuffix

string

省略可。すべてのデータベース（Google Cloud プロジェクト ID）名に追加する接尾辞。
schemaSuffix

string

省略可。すべてのスキーマ（BigQuery データセット ID）名に追加する接尾辞。
tablePrefix

string

省略可。すべてのテーブル名の先頭に追加する接頭辞。
builtinAssertionNamePrefix

string

省略可。組み込みアサーション名の先頭に付加する接頭辞。
defaultNotebookRuntimeOptions

object (NotebookRuntimeOptions)

省略可。デフォルトのノートブック ランタイム オプション。
pipelineConfig

object (PipelineConfig)

省略可。パイプラインのタイプと Git リポジトリ内のパスを定義するパイプライン オプション。

VarsEntry

JSON 表現 
{
  "key": string,
  "value": string
}
フィールド
key

string
value

string

NotebookRuntimeOptions

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.
}
フィールド
aiPlatformNotebookRuntimeTemplate

string

省略可。ノートブック実行用のランタイムが作成される Colab ランタイム テンプレートのリソース名。指定しない場合、ランタイムは Colab のデフォルトの仕様で作成されます。
共用体フィールド execution_sink。ノートブックの実行結果を保存する場所。execution_sink は次のいずれかになります。
gcsOutputBucket

string

省略可。結果をアップロードする Google Cloud Storage のロケーション。形式: gs://bucket-name。
共用体フィールド repository_snapshot_storage。ノートブック ランタイム repository_snapshot_storage 内で読み取り専用アクセスに使用できるレポジトリ ファイルのスナップショットの宛先は、次のいずれか 1 つのみです。
gcsRepositorySnapshotDestination

object (GcsRepositorySnapshotDestination)

省略可。スナップショットのアップロード先となる Google Cloud Storage。URI が空の場合、デフォルトで指定された gcs_output_bucket になります。形式: gs://bucket-name/path/。

GcsRepositorySnapshotDestination

JSON 表現 
{
  "repositorySnapshotUri": string
}
フィールド
repositorySnapshotUri

string

省略可。リポジトリ スナップショットのアップロード先となる Google Cloud Storage。形式: gs://bucket-name/path/。

PipelineConfig

JSON 表現 
{
  "pipelineType": enum (PipelineType),
  "path": string
}
フィールド
pipelineType

enum (PipelineType)

必須。パイプラインのタイプ。
path

string

必須。パイプラインが定義されている Git リポジトリ内の相対パス。たとえば、Dataform パイプラインの場合、workflow_settings.yaml または dataform.json があるフォルダへのパスです。

CompilationError

JSON 表現 
{
  "message": string,
  "stack": string,
  "path": string,
  "actionTarget": {
    object (Target)
  }
}
フィールド
message

string

出力専用。エラーの最上位レベルのメッセージ。
stack

string

出力専用。エラーのフルスタック トレース。
path

string

出力専用。このエラーが発生したファイルのパス（プロジェクト ルートを基準とする相対パス）。
actionTarget

object (Target)

出力専用。このエラーが発生したアクションの ID（利用可能な場合）。

ターゲット

JSON 表現 
{
  "database": string,
  "schema": string,
  "name": string
}
フィールド
database

string

省略可。アクションのデータベース（Google Cloud プロジェクト ID）。
schema

string

省略可。database 内のアクションのスキーマ（BigQuery データセット ID）。
name

string

省略可。database と schema 内のアクションの名前。

DataEncryptionState

JSON 表現 
{
  "kmsKeyVersionName": string
}
フィールド
kmsKeyVersionName

string

必須。リソースのデータの暗号化に使用される KMS 鍵バージョンの名前。

タイムスタンプ

JSON 表現 
{
  "seconds": string,
  "nanos": integer
}
フィールド
seconds

string (int64 format)

UNIX エポック 1970-01-01T00:00:00Z からの UTC 時刻の秒数を表します。-62135596800～253402300799 の範囲（両端を含む）にする必要があります（これは 0001-01-01T00:00:00Z～9999-12-31T23:59:59Z に対応します）。
nanos

integer

ナノ秒分解能による、秒の負ではない小数以下部分。このフィールドは、秒の代替ではなく、期間のナノ秒部分です。小数以下を含む負の秒の値は、時間を前方にカウントする負ではない nanos 値を持つ必要があります。0～999,999,999 にする必要があります（両端を含む）。

PrivateResourceMetadata

JSON 表現 
{
  "userScoped": boolean
}
フィールド
userScoped

boolean

出力専用。true の場合、このリソースはユーザー スコープです。つまり、ワークスペースであるか、ワークスペースから取得されています。

GcsRepositorySnapshotMetadata

JSON 表現 
{
  "repositorySnapshotUri": string,
  "crc32cChecksum": string,
  "generation": string
}
フィールド
repositorySnapshotUri

string

出力専用。リポジトリ スナップショットの Google Cloud Storage URI。
crc32cChecksum

string

出力専用。リポジトリ スナップショットの crc32c チェックサム。ビッグ エンディアンの Base64 でエンコードされます。
generation

string (int64 format)

出力専用。Cloud Storage オブジェクトの世代番号。https://cloud.google.com/storage/docs/metadata#generation-number をご覧ください。

PipelineType

パイプラインのタイプ。この期間は今後延長される可能性があります。UNSPECIFIED の場合は、エラーがスローされます。

列挙型
PIPELINE_TYPE_UNSPECIFIED デフォルト値。この値は使用されません。
DATAFORM 通常の Dataform パイプライン。
SQL SQL 単一ファイル アセット。
NOTEBOOK ノートブックの単一ファイル アセット。

ツールのアノテーション

ツールのアノテーションは、特定のツールの基本的なリスクを説明するために MCP クライアントに送信されます。ほとんどのクライアントはこれらのヒントを信頼できないものとして扱いますが、確認プロンプトをユーザーに送信するタイミングを決定するために使用できます。

タイトル文字列とともに、次のブール値のヒントが次のように定義されています。

  • readOnlyHint: true の場合、ツールは環境を変更しません。デフォルトは false です。
  • destructiveHint: true の場合、ツールは破壊的なアクションを実行できます。false の場合、ツールは追加アクションのみを実行できます。デフォルト値は true です。
  • idempotentHint: true の場合、同じ引数でツールを繰り返し呼び出しても、環境に影響はありません。デフォルトは false です。
  • openWorldHint: true の場合、ツールは外部エンティティの「オープン ワールド」とやり取りできます。false の場合、ツールは内部エンティティとのみやり取りできます。たとえば、ウェブ検索ツールはオープン ワールドですが、メモリツールはオープン ワールドではありません。

破壊的ヒント: ❌ | べき等ヒント: ✅ | 読み取り専用ヒント: ✅ | オープン ワールド ヒント: ❌