Resource: Toolset
A toolset represents a group of dynamically managed tools that can be used by the agent.
| JSON representation |
|---|
{ "name": string, "displayName": string, "description": string, "createTime": string, "updateTime": string, "etag": string, "executionType": enum ( |
| Fields | |
|---|---|
name |
Identifier. The unique identifier of the toolset. Format: |
displayName |
Optional. The display name of the toolset. Must be unique within the same app. |
description |
Optional. The description of the toolset. |
createTime |
Output only. Timestamp when the toolset was created. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
updateTime |
Output only. Timestamp when the toolset was last updated. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
etag |
ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. |
executionType |
Optional. The execution type of the tools in the toolset. |
Union field toolset_type. The type of the toolset. toolset_type can be only one of the following: |
|
mcpToolset |
Optional. A toolset that contains a list of tools that are offered by the MCP server. |
openApiToolset |
Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. |
connectorToolset |
Optional. A toolset that generates tools from an Integration Connectors Connection. |
McpToolset
A toolset that contains a list of tools that are offered by the MCP server.
| JSON representation |
|---|
{ "serverAddress": string, "apiAuthentication": { object ( |
| Fields | |
|---|---|
serverAddress |
Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details. |
apiAuthentication |
Optional. Authentication information required to access tools and execute a tool against the MCP server. For API key auth, the API key can only be sent in the request header; sending it via query parameters is not supported. |
serviceDirectoryConfig |
Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. |
tlsConfig |
Optional. The TLS configuration. Includes the custom server certificates that the client should trust. |
OpenApiToolset
A toolset that contains a list of tools that are defined by an OpenAPI schema.
| JSON representation |
|---|
{ "openApiSchema": string, "apiAuthentication": { object ( |
| Fields | |
|---|---|
openApiSchema |
Required. The OpenAPI schema of the toolset. |
apiAuthentication |
Optional. Authentication information required by the API. |
tlsConfig |
Optional. The TLS configuration. Includes the custom server certificates |
serviceDirectoryConfig |
Optional. Service Directory configuration. |
ignoreUnknownFields |
Optional. If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema. |
url |
Optional. The server URL of the Open API schema. This field is only set in toolsets in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema. |
ConnectorToolset
A toolset that generates tools from an Integration Connectors Connection.
| JSON representation |
|---|
{ "connection": string, "authConfig": { object ( |
| Fields | |
|---|---|
connection |
Required. The full resource name of the referenced Integration Connectors Connection. Format: |
authConfig |
Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. Note: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the Toolset creation will fail. See: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override |
connectorActions[] |
Required. The list of connector actions/entity operations to generate tools for. |
Methods |
|
|---|---|
|
Creates a new toolset in the given app. |
|
Deletes the specified toolset. |
|
Gets details of the specified toolset. |
|
Lists toolsets in the given app. |
|
Updates the specified toolset. |
|
Retrieve the list of tools included in the specified toolset. |