Class McpTool (0.7.0)

  public 
  
 final 
  
 class 
 McpTool 
  
 extends 
  
 GeneratedMessage 
  
 implements 
  
 McpToolOrBuilder 
 

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

Protobuf type google.cloud.ces.v1.McpTool

Implements

McpToolOrBuilder

Static Fields

API_AUTHENTICATION_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 API_AUTHENTICATION_FIELD_NUMBER 
 
Field Value
Type
Description
int

CUSTOM_HEADERS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 CUSTOM_HEADERS_FIELD_NUMBER 
 
Field Value
Type
Description
int

DESCRIPTION_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 DESCRIPTION_FIELD_NUMBER 
 
Field Value
Type
Description
int

INPUT_SCHEMA_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 INPUT_SCHEMA_FIELD_NUMBER 
 
Field Value
Type
Description
int

NAME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 NAME_FIELD_NUMBER 
 
Field Value
Type
Description
int

OUTPUT_SCHEMA_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 OUTPUT_SCHEMA_FIELD_NUMBER 
 
Field Value
Type
Description
int

SERVER_ADDRESS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 SERVER_ADDRESS_FIELD_NUMBER 
 
Field Value
Type
Description
int

SERVICE_DIRECTORY_CONFIG_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 SERVICE_DIRECTORY_CONFIG_FIELD_NUMBER 
 
Field Value
Type
Description
int

TLS_CONFIG_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 TLS_CONFIG_FIELD_NUMBER 
 
Field Value
Type
Description
int

Static Methods

getDefaultInstance()

  public 
  
 static 
  
 McpTool 
  
 getDefaultInstance 
 () 
 
Returns
Type
Description

getDescriptor()

  public 
  
 static 
  
 final 
  
 Descriptors 
 . 
 Descriptor 
  
 getDescriptor 
 () 
 
Returns
Type
Description

newBuilder()

  public 
  
 static 
  
 McpTool 
 . 
 Builder 
  
 newBuilder 
 () 
 
Returns
Type
Description

newBuilder(McpTool prototype)

  public 
  
 static 
  
 McpTool 
 . 
 Builder 
  
 newBuilder 
 ( 
 McpTool 
  
 prototype 
 ) 
 
Parameter
Name
Description
prototype
Returns
Type
Description

parseDelimitedFrom(InputStream input)

  public 
  
 static 
  
 McpTool 
  
 parseDelimitedFrom 
 ( 
 InputStream 
  
 input 
 ) 
 
Parameter
Name
Description
input
Returns
Type
Description
Exceptions
Type
Description

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 McpTool 
  
 parseDelimitedFrom 
 ( 
 InputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
input
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(byte[] data)

  public 
  
 static 
  
 McpTool 
  
 parseFrom 
 ( 
 byte 
 [] 
  
 data 
 ) 
 
Parameter
Name
Description
data
byte []
Returns
Type
Description
Exceptions
Type
Description

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 McpTool 
  
 parseFrom 
 ( 
 byte 
 [] 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
byte []
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(ByteString data)

  public 
  
 static 
  
 McpTool 
  
 parseFrom 
 ( 
 ByteString 
  
 data 
 ) 
 
Parameter
Name
Description
data
Returns
Type
Description
Exceptions
Type
Description

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 McpTool 
  
 parseFrom 
 ( 
 ByteString 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(CodedInputStream input)

  public 
  
 static 
  
 McpTool 
  
 parseFrom 
 ( 
 CodedInputStream 
  
 input 
 ) 
 
Parameter
Name
Description
Returns
Type
Description
Exceptions
Type
Description

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 McpTool 
  
 parseFrom 
 ( 
 CodedInputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(InputStream input)

  public 
  
 static 
  
 McpTool 
  
 parseFrom 
 ( 
 InputStream 
  
 input 
 ) 
 
Parameter
Name
Description
input
Returns
Type
Description
Exceptions
Type
Description

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 McpTool 
  
 parseFrom 
 ( 
 InputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
input
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(ByteBuffer data)

  public 
  
 static 
  
 McpTool 
  
 parseFrom 
 ( 
 ByteBuffer 
  
 data 
 ) 
 
Parameter
Name
Description
data
Returns
Type
Description
Exceptions
Type
Description

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 McpTool 
  
 parseFrom 
 ( 
 ByteBuffer 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parser()

  public 
  
 static 
  
 Parser<McpTool> 
  
 parser 
 () 
 
Returns
Type
Description

Methods

containsCustomHeaders(String key)

  public 
  
 boolean 
  
 containsCustomHeaders 
 ( 
 String 
  
 key 
 ) 
 

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.

map<string, string> custom_headers = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
key
Returns
Type
Description

equals(Object obj)

  public 
  
 boolean 
  
 equals 
 ( 
 Object 
  
 obj 
 ) 
 
Parameter
Name
Description
obj
Returns
Type
Description
Overrides

getApiAuthentication()

  public 
  
 ApiAuthentication 
  
 getApiAuthentication 
 () 
 

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.

.google.cloud.ces.v1.ApiAuthentication api_authentication = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

The apiAuthentication.

getApiAuthenticationOrBuilder()

  public 
  
 ApiAuthenticationOrBuilder 
  
 getApiAuthenticationOrBuilder 
 () 
 

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.

.google.cloud.ces.v1.ApiAuthentication api_authentication = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

getCustomHeaders() (deprecated)

  public 
  
 Map<String 
 , 
 String 
>  
 getCustomHeaders 
 () 
 

Use #getCustomHeadersMap() instead.

Returns
Type
Description
Map < String , String >

getCustomHeadersCount()

  public 
  
 int 
  
 getCustomHeadersCount 
 () 
 

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.

map<string, string> custom_headers = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
int

getCustomHeadersMap()

  public 
  
 Map<String 
 , 
 String 
>  
 getCustomHeadersMap 
 () 
 

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.

map<string, string> custom_headers = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
Map < String , String >

getCustomHeadersOrDefault(String key, String defaultValue)

  public 
  
 String 
  
 getCustomHeadersOrDefault 
 ( 
 String 
  
 key 
 , 
  
 String 
  
 defaultValue 
 ) 
 

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.

map<string, string> custom_headers = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name
Description
key
defaultValue
Returns
Type
Description

getCustomHeadersOrThrow(String key)

  public 
  
 String 
  
 getCustomHeadersOrThrow 
 ( 
 String 
  
 key 
 ) 
 

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.

map<string, string> custom_headers = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
key
Returns
Type
Description

getDefaultInstanceForType()

  public 
  
 McpTool 
  
 getDefaultInstanceForType 
 () 
 
Returns
Type
Description

getDescription()

  public 
  
 String 
  
 getDescription 
 () 
 

Optional. The description of the MCP tool.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

The description.

getDescriptionBytes()

  public 
  
 ByteString 
  
 getDescriptionBytes 
 () 
 

Optional. The description of the MCP tool.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

The bytes for description.

getInputSchema()

  public 
  
 Schema 
  
 getInputSchema 
 () 
 

Optional. The schema of the input arguments of the MCP tool.

.google.cloud.ces.v1.Schema input_schema = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

The inputSchema.

getInputSchemaOrBuilder()

  public 
  
 SchemaOrBuilder 
  
 getInputSchemaOrBuilder 
 () 
 

Optional. The schema of the input arguments of the MCP tool.

.google.cloud.ces.v1.Schema input_schema = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

getName()

  public 
  
 String 
  
 getName 
 () 
 

Required. The name of the MCP tool.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type
Description

The name.

getNameBytes()

  public 
  
 ByteString 
  
 getNameBytes 
 () 
 

Required. The name of the MCP tool.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type
Description

The bytes for name.

getOutputSchema()

  public 
  
 Schema 
  
 getOutputSchema 
 () 
 

Optional. The schema of the output arguments of the MCP tool.

.google.cloud.ces.v1.Schema output_schema = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

The outputSchema.

getOutputSchemaOrBuilder()

  public 
  
 SchemaOrBuilder 
  
 getOutputSchemaOrBuilder 
 () 
 

Optional. The schema of the output arguments of the MCP tool.

.google.cloud.ces.v1.Schema output_schema = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

getParserForType()

  public 
  
 Parser<McpTool> 
  
 getParserForType 
 () 
 
Returns
Type
Description
Overrides

getSerializedSize()

  public 
  
 int 
  
 getSerializedSize 
 () 
 
Returns
Type
Description
int
Overrides

getServerAddress()

  public 
  
 String 
  
 getServerAddress 
 () 
 

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.

string server_address = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type
Description

The serverAddress.

getServerAddressBytes()

  public 
  
 ByteString 
  
 getServerAddressBytes 
 () 
 

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.

string server_address = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type
Description

The bytes for serverAddress.

getServiceDirectoryConfig()

  public 
  
 ServiceDirectoryConfig 
  
 getServiceDirectoryConfig 
 () 
 

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

.google.cloud.ces.v1.ServiceDirectoryConfig service_directory_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

The serviceDirectoryConfig.

getServiceDirectoryConfigOrBuilder()

  public 
  
 ServiceDirectoryConfigOrBuilder 
  
 getServiceDirectoryConfigOrBuilder 
 () 
 

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

.google.cloud.ces.v1.ServiceDirectoryConfig service_directory_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

getTlsConfig()

  public 
  
 TlsConfig 
  
 getTlsConfig 
 () 
 

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

.google.cloud.ces.v1.TlsConfig tls_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

The tlsConfig.

getTlsConfigOrBuilder()

  public 
  
 TlsConfigOrBuilder 
  
 getTlsConfigOrBuilder 
 () 
 

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

.google.cloud.ces.v1.TlsConfig tls_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

hasApiAuthentication()

  public 
  
 boolean 
  
 hasApiAuthentication 
 () 
 

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.

.google.cloud.ces.v1.ApiAuthentication api_authentication = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

Whether the apiAuthentication field is set.

hasInputSchema()

  public 
  
 boolean 
  
 hasInputSchema 
 () 
 

Optional. The schema of the input arguments of the MCP tool.

.google.cloud.ces.v1.Schema input_schema = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

Whether the inputSchema field is set.

hasOutputSchema()

  public 
  
 boolean 
  
 hasOutputSchema 
 () 
 

Optional. The schema of the output arguments of the MCP tool.

.google.cloud.ces.v1.Schema output_schema = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

Whether the outputSchema field is set.

hasServiceDirectoryConfig()

  public 
  
 boolean 
  
 hasServiceDirectoryConfig 
 () 
 

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

.google.cloud.ces.v1.ServiceDirectoryConfig service_directory_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

Whether the serviceDirectoryConfig field is set.

hasTlsConfig()

  public 
  
 boolean 
  
 hasTlsConfig 
 () 
 

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

.google.cloud.ces.v1.TlsConfig tls_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

Whether the tlsConfig field is set.

hashCode()

  public 
  
 int 
  
 hashCode 
 () 
 
Returns
Type
Description
int
Overrides

internalGetFieldAccessorTable()

  protected 
  
 GeneratedMessage 
 . 
 FieldAccessorTable 
  
 internalGetFieldAccessorTable 
 () 
 
Returns
Type
Description
Overrides

internalGetMapFieldReflection(int number)

  protected 
  
 MapFieldReflectionAccessor 
  
 internalGetMapFieldReflection 
 ( 
 int 
  
 number 
 ) 
 
Parameter
Name
Description
number
int
Returns
Type
Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

isInitialized()

  public 
  
 final 
  
 boolean 
  
 isInitialized 
 () 
 
Returns
Type
Description
Overrides

newBuilderForType()

  public 
  
 McpTool 
 . 
 Builder 
  
 newBuilderForType 
 () 
 
Returns
Type
Description

newBuilderForType(AbstractMessage.BuilderParent parent)

  protected 
  
 McpTool 
 . 
 Builder 
  
 newBuilderForType 
 ( 
 AbstractMessage 
 . 
 BuilderParent 
  
 parent 
 ) 
 
Parameter
Name
Description
parent
Returns
Type
Description
Overrides

toBuilder()

  public 
  
 McpTool 
 . 
 Builder 
  
 toBuilder 
 () 
 
Returns
Type
Description

writeTo(CodedOutputStream output)

  public 
  
 void 
  
 writeTo 
 ( 
 CodedOutputStream 
  
 output 
 ) 
 
Parameter
Name
Description
Overrides
Exceptions
Type
Description
Create a Mobile Website
View Site in Mobile | Classic
Share by: