REST Resource: projects.locations.apps.toolsets

资源：Toolset

工具集表示一组可供智能体使用的动态管理工具。

JSON 表示法 
{
  "name": string,
  "displayName": string,
  "description": string,
  "timeout": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "executionType": enum (ExecutionType),
  "toolFakeConfig": {
    object (ToolFakeConfig)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "mcpToolset": {
    object (McpToolset)
  },
  "openApiToolset": {
    object (OpenApiToolset)
  },
  "connectorToolset": {
    object (ConnectorToolset)
  }
  // End of mutually exclusive fields.
}
字段
name

string

标识符。工具集的唯一标识符。格式：projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
displayName

string

可选。工具集的显示名称。在同一应用中必须是唯一的。
description

string

可选。工具集的说明。
timeout

string (Duration format)

可选。工具集执行的超时时间。如果未设置，则 SYNCHRONOUS 工具集的默认超时时间为 30 秒，ASYNCHRONOUS 工具集的默认超时时间为 60 秒。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
createTime

string (Timestamp format)

仅限输出。工具集创建时的时间戳。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

仅限输出。工具集上次更新时的时间戳。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
etag

string

用于确保对象在读取-修改-写入操作期间未发生更改的 ETag。如果 etag 为空，则更新会覆盖任何并发更改。
executionType

enum (ExecutionType)

可选。工具集中工具的执行类型。
toolFakeConfig

object (ToolFakeConfig)

可选。伪模式下工具行为的配置。
工具集的类型。以下是互斥字段的列表。在响应中，最多只能设置以下字段之一：
mcpToolset

object (McpToolset)

可选。包含 MCP 服务器提供的工具列表的工具集。
openApiToolset

object (OpenApiToolset)

可选。包含由 OpenAPI 架构定义的一系列工具的工具集。
connectorToolset

object (ConnectorToolset)

可选。一种可从 Integration Connectors 连接生成工具的工具集。
互斥字段的结束。

McpToolset

包含 MCP 服务器提供的工具列表的工具集。

JSON 表示法 
{
  "serverAddress": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "customHeaders": {
    string: string,
    ...
  },
  "toolOverrides": [
    {
      object (McpToolOverride)
    }
  ]
}
字段
serverAddress

string

必需。MCP 服务器的地址，例如“https://example.com/mcp/”。如果服务器是使用 MCP SDK 构建的，则网址应以“/mcp/”为后缀。仅支持基于可流式传输的 HTTP 传输的服务器。如需了解详情，请参阅 https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http。
apiAuthentication

object (ApiAuthentication)

可选。访问工具并针对 MCP 服务器执行工具所需的身份验证信息。对于不记名令牌身份验证，令牌仅适用于工具执行，不适用于列出工具。这要求无需身份验证即可列出工具。
serviceDirectoryConfig

object (ServiceDirectoryConfig)

可选。用于在边界内解析服务名称的 VPC-SC 的 Service Directory 配置。
tlsConfig

object (TlsConfig)

可选。TLS 配置。包含客户端应信任的自定义服务器证书。
customHeaders

map (key: string, value: string)

可选。要在发送到 MCP 服务器的请求中发送的自定义标头。这些值必须采用 $context.variables.<name_of_variable> 格式，并且可以在会话变量中设置。如需了解详情，请参阅 https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
toolOverrides[]

object (McpToolOverride)

可选。此工具集中各个工具的替换项。这样一来，您就可以替换说明、名称等特定详细信息，或固定工具的状态，使其不完全动态。

McpToolOverride

与工具集中给定工具相关联的替换项。这样便可“固定”或“替换”来自外部动态服务器的工具定义。

JSON 表示法 
{
  "tool": string,
  "nameOverride": string,
  "descriptionOverride": string,
  "snapshot": {
    object (McpToolDefinition)
  }
}
字段
tool

string

必需。工具的原始名称，由 MCP 服务器发出。
nameOverride

string

可选。如果存在，此工具会在代理中使用此名称，而不是原始名称。如果 MCP 服务器提供的工具名称不理想，则主要使用此属性作为别名。
descriptionOverride

string

可选。如果存在，此工具将使用此说明，而不是服务器中的原始说明。
snapshot

object (McpToolDefinition)

仅限输出。如果存在，此工具会被“固定”，并且在服务器暂时不可用或不存在替换项时，使用快照值作为后备值。

McpToolDefinition

用于存放工具的核心定义元素（即快照）的容器。快照中的架构按原样使用，无法替换。

JSON 表示法 
{
  "description": string,
  "inputSchema": {
    object (Schema)
  },
  "outputSchema": {
    object (Schema)
  }
}
字段
description

string

仅限输出。MCP 工具的说明。此值可由 McpToolOverride 中的 descriptionOverride 替换。
inputSchema

object (Schema)

仅限输出。MCP 工具的输入实参的架构。
outputSchema

object (Schema)

仅限输出。MCP 工具的输出实参的架构。

OpenApiToolset

包含由 OpenAPI 架构定义的一系列工具的工具集。

JSON 表示法 
{
  "openApiSchema": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "ignoreUnknownFields": boolean,
  "url": string
}
字段
openApiSchema

string

必需。工具集的 OpenAPI 架构。
apiAuthentication

object (ApiAuthentication)

可选。API 所需的身份验证信息。
tlsConfig

object (TlsConfig)

可选。TLS 配置。包含自定义服务器证书
serviceDirectoryConfig

object (ServiceDirectoryConfig)

可选。Service Directory 配置。
ignoreUnknownFields

boolean

可选。如果为 true，则对于 OpenAPI 架构中定义的所有操作，代理将忽略 API 响应中的未知字段。
url

string

可选。Open API schema 的服务器网址。仅当架构包含服务器网址时，此字段才会在导出过程中设置到环境依赖项中的工具集中。在导入过程中，如果此网址存在于环境依赖项中，并且架构具有 $env_var 占位符，则该网址将替换架构中的占位符。

ConnectorToolset

一种可从 Integration Connectors 连接生成工具的工具集。

JSON 表示法 
{
  "connection": string,
  "authConfig": {
    object (EndUserAuthConfig)
  },
  "connectorActions": [
    {
      object (Action)
    }
  ]
}
字段
connection

string

必需。所引用 Integration Connectors 连接的完整资源名称。格式：projects/{project}/locations/{location}/connections/{connection}
authConfig

object (EndUserAuthConfig)

可选。配置 Integration Connectors 中身份验证的处理方式。默认情况下，管理员身份验证会在 Integration Connectors API 请求中传递。您可以使用其他最终用户身份验证配置来替换此配置。注意：连接必须启用身份验证替换，才能在此处指定 EUC 配置；否则，工具集创建将失败。请参阅：https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override
connectorActions[]

object (Action)

必需。要为其生成工具的连接器操作/实体操作的列表。

方法

create

 在指定应用中创建新的工具集。

delete

 删除指定的工具集。

get

 获取指定工具集的详细信息。

list

 列出指定应用中的工具集。

patch

 更新指定的工具集。

retrieveTools

 检索指定工具集中包含的工具列表。