REST Resource: projects.locations.apps.toolsets

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 (ExecutionType),
  "toolFakeConfig": {
    object (ToolFakeConfig)
  },

  // Union field toolset_type can be only one of the following:
  "mcpToolset": {
    object (McpToolset)
  },
  "openApiToolset": {
    object (OpenApiToolset)
  },
  "connectorToolset": {
    object (ConnectorToolset)
  }
  // End of list of possible types for union field toolset_type.
}
Fields
name

string

Identifier. The unique identifier of the toolset. Format: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
displayName

string

Optional. The display name of the toolset. Must be unique within the same app.
description

string

Optional. The description of the toolset.
createTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
etag

string

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

enum (ExecutionType)

Optional. The execution type of the tools in the toolset.
toolFakeConfig

object (ToolFakeConfig)

Optional. Configuration for tools behavior in fake mode.
Union field toolset_type. The type of the toolset. toolset_type can be only one of the following:
mcpToolset

object (McpToolset)

Optional. A toolset that contains a list of tools that are offered by the MCP server.
openApiToolset

object (OpenApiToolset)

Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema.
connectorToolset

object (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 (ApiAuthentication)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "customHeaders": {
    string: string,
    ...
  },
  "toolOverrides": [
    {
      object (McpToolOverride)
    }
  ]
}
Fields
serverAddress

string

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

object (ApiAuthentication)

Optional. Authentication information required to access tools and execute a tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.
tlsConfig

object (TlsConfig)

Optional. The TLS configuration. Includes the custom server certificates that the client should trust.
customHeaders

map (key: string, value: string)

Optional. The custom headers to send in the request to the MCP server. The values must be in the format $context.variables.<name_of_variable> and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
toolOverrides[]

object (McpToolOverride)

Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic.

McpToolOverride

Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server.

JSON representation 
{
  "tool": string,
  "nameOverride": string,
  "descriptionOverride": string,
  "snapshot": {
    object (McpToolDefinition)
  }
}
Fields
tool

string

Required. The original name of the tool as it is emitted by the MCP server.
nameOverride

string

Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools.
descriptionOverride

string

Optional. If present, this tool uses this description instead of the original description from the server.
snapshot

object (McpToolDefinition)

Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present.

McpToolDefinition

Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden.

JSON representation 
{
  "description": string,
  "inputSchema": {
    object (Schema)
  },
  "outputSchema": {
    object (Schema)
  }
}
Fields
description

string

Output only. The description of the MCP tool. This can be overridden by descriptionOverride in McpToolOverride.
inputSchema

object (Schema)

Output only. The schema of the input arguments of the MCP tool.
outputSchema

object (Schema)

Output only. The schema of the output arguments of the MCP tool.

OpenApiToolset

A toolset that contains a list of tools that are defined by an OpenAPI schema.

JSON representation 
{
  "openApiSchema": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "ignoreUnknownFields": boolean,
  "url": string
}
Fields
openApiSchema

string

Required. The OpenAPI schema of the toolset.
apiAuthentication

object (ApiAuthentication)

Optional. Authentication information required by the API.
tlsConfig

object (TlsConfig)

Optional. The TLS configuration. Includes the custom server certificates
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Optional. Service Directory configuration.
ignoreUnknownFields

boolean

Optional. If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema.
url

string

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 (EndUserAuthConfig)
  },
  "connectorActions": [
    {
      object (Action)
    }
  ]
}
Fields
connection

string

Required. The full resource name of the referenced Integration Connectors Connection. Format: projects/{project}/locations/{location}/connections/{connection}
authConfig

object (EndUserAuthConfig)

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[]

object (Action)

Required. The list of connector actions/entity operations to generate tools for.

Methods

create

 Creates a new toolset in the given app.

delete

 Deletes the specified toolset.

get

 Gets details of the specified toolset.

list

 Lists toolsets in the given app.

patch

 Updates the specified toolset.

retrieveTools

 Retrieve the list of tools included in the specified toolset.