0.3.1 (latest) 0.3.0 0.2.0 0.1.0 Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1BETA API class Google::Cloud::Ces::V1beta::McpTool.

An MCP tool.
See <https://modelcontextprotocol.io/specification/2025-06-18/server/tools> for
more details.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #api_authentication

    def api_authentication() -> ::Google::Cloud::Ces::V1beta::ApiAuthentication

**Returns**

- ([::Google::Cloud::Ces::V1beta::ApiAuthentication](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ces-v1beta/latest/Google-Cloud-Ces-V1beta-ApiAuthentication)) --- Optional. Authentication information required to execute the 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.

### #api_authentication=

    def api_authentication=(value) -> ::Google::Cloud::Ces::V1beta::ApiAuthentication

**Parameter**

- **value** ([::Google::Cloud::Ces::V1beta::ApiAuthentication](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ces-v1beta/latest/Google-Cloud-Ces-V1beta-ApiAuthentication)) --- Optional. Authentication information required to execute the 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.
**Returns**

- ([::Google::Cloud::Ces::V1beta::ApiAuthentication](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ces-v1beta/latest/Google-Cloud-Ces-V1beta-ApiAuthentication)) --- Optional. Authentication information required to execute the 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.

### #custom_headers

    def custom_headers() -> ::Google::Protobuf::Map{::String => ::String}

**Returns**

- (::Google::Protobuf::Map{::String =\> ::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.

### #custom_headers=

    def custom_headers=(value) -> ::Google::Protobuf::Map{::String => ::String}

**Parameter**

- **value** (::Google::Protobuf::Map{::String =\> ::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.
**Returns**

- (::Google::Protobuf::Map{::String =\> ::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.

### #description

    def description() -> ::String

**Returns**

- (::String) --- Optional. The description of the MCP tool.

### #description=

    def description=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. The description of the MCP tool.
**Returns**

- (::String) --- Optional. The description of the MCP tool.

### #input_schema

    def input_schema() -> ::Google::Cloud::Ces::V1beta::Schema

**Returns**

- ([::Google::Cloud::Ces::V1beta::Schema](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ces-v1beta/latest/Google-Cloud-Ces-V1beta-Schema)) --- Optional. The schema of the input arguments of the MCP tool.

### #input_schema=

    def input_schema=(value) -> ::Google::Cloud::Ces::V1beta::Schema

**Parameter**

- **value** ([::Google::Cloud::Ces::V1beta::Schema](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ces-v1beta/latest/Google-Cloud-Ces-V1beta-Schema)) --- Optional. The schema of the input arguments of the MCP tool.
**Returns**

- ([::Google::Cloud::Ces::V1beta::Schema](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ces-v1beta/latest/Google-Cloud-Ces-V1beta-Schema)) --- Optional. The schema of the input arguments of the MCP tool.

### #name

    def name() -> ::String

**Returns**

- (::String) --- Required. The name of the MCP tool.

### #name=

    def name=(value) -> ::String

**Parameter**

- **value** (::String) --- Required. The name of the MCP tool.
**Returns**

- (::String) --- Required. The name of the MCP tool.

### #name_override

    def name_override() -> ::String

**Returns**

- (::String) --- Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override.

### #name_override=

    def name_override=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override.
**Returns**

- (::String) --- Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override.

### #output_schema

    def output_schema() -> ::Google::Cloud::Ces::V1beta::Schema

**Returns**

- ([::Google::Cloud::Ces::V1beta::Schema](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ces-v1beta/latest/Google-Cloud-Ces-V1beta-Schema)) --- Optional. The schema of the output arguments of the MCP tool.

### #output_schema=

    def output_schema=(value) -> ::Google::Cloud::Ces::V1beta::Schema

**Parameter**

- **value** ([::Google::Cloud::Ces::V1beta::Schema](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ces-v1beta/latest/Google-Cloud-Ces-V1beta-Schema)) --- Optional. The schema of the output arguments of the MCP tool.
**Returns**

- ([::Google::Cloud::Ces::V1beta::Schema](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ces-v1beta/latest/Google-Cloud-Ces-V1beta-Schema)) --- Optional. The schema of the output arguments of the MCP tool.

### #server_address

    def server_address() -> ::String

**Returns**

- (::String) --- Required. The server address of the MCP server, e.g., "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. This is the same as the server_address in the McpToolset. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details.

### #server_address=

    def server_address=(value) -> ::String

**Parameter**

- **value** (::String) --- Required. The server address of the MCP server, e.g., "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. This is the same as the server_address in the McpToolset. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details.
**Returns**

- (::String) --- Required. The server address of the MCP server, e.g., "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. This is the same as the server_address in the McpToolset. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details.

### #service_directory_config

    def service_directory_config() -> ::Google::Cloud::Ces::V1beta::ServiceDirectoryConfig

**Returns**

- ([::Google::Cloud::Ces::V1beta::ServiceDirectoryConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ces-v1beta/latest/Google-Cloud-Ces-V1beta-ServiceDirectoryConfig)) --- Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.

### #service_directory_config=

    def service_directory_config=(value) -> ::Google::Cloud::Ces::V1beta::ServiceDirectoryConfig

**Parameter**

- **value** ([::Google::Cloud::Ces::V1beta::ServiceDirectoryConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ces-v1beta/latest/Google-Cloud-Ces-V1beta-ServiceDirectoryConfig)) --- Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.
**Returns**

- ([::Google::Cloud::Ces::V1beta::ServiceDirectoryConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ces-v1beta/latest/Google-Cloud-Ces-V1beta-ServiceDirectoryConfig)) --- Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.

### #state

    def state() -> ::Google::Cloud::Ces::V1beta::McpTool::State

**Returns**

- ([::Google::Cloud::Ces::V1beta::McpTool::State](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ces-v1beta/latest/Google-Cloud-Ces-V1beta-McpTool-State)) --- Output only. The dynamic availability state of the tool on the external server.

### #tls_config

    def tls_config() -> ::Google::Cloud::Ces::V1beta::TlsConfig

**Returns**

- ([::Google::Cloud::Ces::V1beta::TlsConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ces-v1beta/latest/Google-Cloud-Ces-V1beta-TlsConfig)) --- Optional. The TLS configuration. Includes the custom server certificates that the client should trust.

### #tls_config=

    def tls_config=(value) -> ::Google::Cloud::Ces::V1beta::TlsConfig

**Parameter**

- **value** ([::Google::Cloud::Ces::V1beta::TlsConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ces-v1beta/latest/Google-Cloud-Ces-V1beta-TlsConfig)) --- Optional. The TLS configuration. Includes the custom server certificates that the client should trust.
**Returns**

- ([::Google::Cloud::Ces::V1beta::TlsConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ces-v1beta/latest/Google-Cloud-Ces-V1beta-TlsConfig)) --- Optional. The TLS configuration. Includes the custom server certificates that the client should trust.