MCP Tools Reference: dataform.googleapis.com

工具:commit_workspace_changes

记录 Dataform 工作区中未提交的更改的 Git 提交。

提交会保留在工作区本地,直到使用 push_git_commits 工具发布为止。

默认情况下,所有未提交的更改都会提交。如需仅提交部分文件,请提供 paths 参数值。

name 参数值必须采用 projects/{project_id}/locations/{location}/repositories/{repository}/workspaces/{workspace} 格式。

author 参数值用于标识为提交记录的 Git 作者。必须提供 author.nameauthor.email_address。提供用于标识提交所代表的用户的相应值。请勿使用占位符,因为它们会写入 Git 历史记录。

commit_message 参数值是提交的消息。

以下代码示例展示了如何使用 curl 调用 commit_workspace_changes 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": "commit_workspace_changes",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

输入架构

CommitWorkspaceChanges 请求消息。

CommitWorkspaceChangesRequest

JSON 表示法
{
  "name": string,
  "author": {
    object (CommitAuthor)
  },
  "commitMessage": string,
  "paths": [
    string
  ]
}
字段
name

string

必需。工作区的名称。

author

object (CommitAuthor)

必需。相应提交的作者。

commitMessage

string

可选。相应提交的消息。

paths[]

string

可选。要提交的文件的完整路径(包括文件名),以工作区根目录为根。如果留空,系统将提交所有文件。

CommitAuthor

JSON 表示法
{
  "name": string,
  "emailAddress": string
}
字段
name

string

必需。提交作者的姓名。

emailAddress

string

必需。提交作者的电子邮件地址。

输出架构

CommitWorkspaceChanges 响应消息。

工具注释

工具注释会发送给 MCP 客户端,用于描述指定工具的基本风险。大多数客户端会将这些提示视为不受信任的,但它们可用于确定何时向用户发送确认提示。

除了标题字符串之外,还定义了以下布尔值提示:

  • readOnlyHint:如果为 true,则工具不会修改其环境。默认值:false。
  • destructiveHint:如果为 true,则工具可以执行破坏性操作。如果为 false,则该工具只能执行添加操作。默认值:true。
  • idempotentHint:如果为 true,则使用相同实参重复调用该工具不会对其环境产生任何额外影响。默认值:false。
  • openWorldHint:如果为 true,则工具可以与外部实体的“开放世界”进行交互。如果为 false,则该工具只能与内部实体互动。例如,网络搜索工具是开放世界工具,而内存工具不是开放世界工具。

破坏性提示:❌ | 等幂性提示:❌ | 只读提示:❌ | 开放世界提示:❌