public final class McpTool extends GeneratedMessage implements McpToolOrBuilder
Message describing McpTool object
Protobuf type google.cloud.apiregistry.v1.McpTool
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
public static final int ANNOTATIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int INPUT_SCHEMA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int MCP_SERVER_URLS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int OUTPUT_SCHEMA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static McpTool getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static McpTool.Builder newBuilder()
public static McpTool.Builder newBuilder(McpTool prototype)
| Parameter |
| Name |
Description |
prototype |
McpTool
|
public static McpTool parseDelimitedFrom(InputStream input)
public static McpTool parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static McpTool parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static McpTool parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static McpTool parseFrom(ByteString data)
public static McpTool parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static McpTool parseFrom(CodedInputStream input)
public static McpTool parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static McpTool parseFrom(InputStream input)
public static McpTool parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static McpTool parseFrom(ByteBuffer data)
public static McpTool parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<McpTool> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public Struct getAnnotations()
Optional key-value object that allows developers to provide additional
information regarding tool properties, behavior, and usage best practices.
Annotations or tags to facilitate semantic search across tools ("semantic
tags") are not in the MVP scope. When implemented, the first set of
supported annotations will likely be the standard, predefined annotations
from the open-source MCP spec. These include:
- title: A human-readable title for the tool, useful for UI display.
- readOnlyHint: If true, indicates the tool does not modify its
environment.
- destructiveHint: If true, the tool may perform destructive updates
(only meaningful when readOnlyHint is false).
- idempotentHint: If true, calling the tool repeatedly with the same
arguments has no additional effect (only meaningful when readOnlyHint is
false).
- openWorldHint: If true, the tool may interact with an "open world" of
external entities.
.google.protobuf.Struct annotations = 7;
| Returns |
| Type |
Description |
Struct |
The annotations.
|
public StructOrBuilder getAnnotationsOrBuilder()
Optional key-value object that allows developers to provide additional
information regarding tool properties, behavior, and usage best practices.
Annotations or tags to facilitate semantic search across tools ("semantic
tags") are not in the MVP scope. When implemented, the first set of
supported annotations will likely be the standard, predefined annotations
from the open-source MCP spec. These include:
- title: A human-readable title for the tool, useful for UI display.
- readOnlyHint: If true, indicates the tool does not modify its
environment.
- destructiveHint: If true, the tool may perform destructive updates
(only meaningful when readOnlyHint is false).
- idempotentHint: If true, calling the tool repeatedly with the same
arguments has no additional effect (only meaningful when readOnlyHint is
false).
- openWorldHint: If true, the tool may interact with an "open world" of
external entities.
.google.protobuf.Struct annotations = 7;
public McpTool getDefaultInstanceForType()
public String getDescription()
A human-readable description of the tool's functionality.
string description = 3;
| Returns |
| Type |
Description |
String |
The description.
|
public ByteString getDescriptionBytes()
A human-readable description of the tool's functionality.
string description = 3;
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
public String getDisplayName()
Optional. A human-readable name for the tool, suitable for display.
string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The displayName.
|
public ByteString getDisplayNameBytes()
Optional. A human-readable name for the tool, suitable for display.
string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for displayName.
|
public Struct getInputSchema()
A JSON Schema object defining the expected parameters for invoking the
tool.
.google.protobuf.Struct input_schema = 5;
| Returns |
| Type |
Description |
Struct |
The inputSchema.
|
public StructOrBuilder getInputSchemaOrBuilder()
A JSON Schema object defining the expected parameters for invoking the
tool.
.google.protobuf.Struct input_schema = 5;
public String getMcpServerUrls(int index)
Automatically populated reference to MCP Server. Helpful when multiple
tools are requested across different MCP Servers.
repeated string mcp_server_urls = 4;
| Parameter |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The mcpServerUrls at the given index.
|
public ByteString getMcpServerUrlsBytes(int index)
Automatically populated reference to MCP Server. Helpful when multiple
tools are requested across different MCP Servers.
repeated string mcp_server_urls = 4;
| Parameter |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the mcpServerUrls at the given index.
|
public int getMcpServerUrlsCount()
Automatically populated reference to MCP Server. Helpful when multiple
tools are requested across different MCP Servers.
repeated string mcp_server_urls = 4;
| Returns |
| Type |
Description |
int |
The count of mcpServerUrls.
|
public ProtocolStringList getMcpServerUrlsList()
Automatically populated reference to MCP Server. Helpful when multiple
tools are requested across different MCP Servers.
repeated string mcp_server_urls = 4;
Identifier. The resource name of the McpTool.
Format:
projects/{project}/locations/{location}/mcpServers/{mcp_server}/mcpTools/{mcp_tool}.
Example:
projects/12345/locations/us-central1/mcpServers/google:bigquery.googleapis.com:mcp/mcpTools/insert_job
for 1p
projects/12345/locations/us-central1/mcpServers/apphub:starbucks/mcpTools/order_pizza
for 2p
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
String |
The name.
|
public ByteString getNameBytes()
Identifier. The resource name of the McpTool.
Format:
projects/{project}/locations/{location}/mcpServers/{mcp_server}/mcpTools/{mcp_tool}.
Example:
projects/12345/locations/us-central1/mcpServers/google:bigquery.googleapis.com:mcp/mcpTools/insert_job
for 1p
projects/12345/locations/us-central1/mcpServers/apphub:starbucks/mcpTools/order_pizza
for 2p
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
public Struct getOutputSchema()
Optional. A JSON Schema object defining the expected structure of the
tool's output.
.google.protobuf.Struct output_schema = 6;
| Returns |
| Type |
Description |
Struct |
The outputSchema.
|
public StructOrBuilder getOutputSchemaOrBuilder()
Optional. A JSON Schema object defining the expected structure of the
tool's output.
.google.protobuf.Struct output_schema = 6;
public Parser<McpTool> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public boolean hasAnnotations()
Optional key-value object that allows developers to provide additional
information regarding tool properties, behavior, and usage best practices.
Annotations or tags to facilitate semantic search across tools ("semantic
tags") are not in the MVP scope. When implemented, the first set of
supported annotations will likely be the standard, predefined annotations
from the open-source MCP spec. These include:
- title: A human-readable title for the tool, useful for UI display.
- readOnlyHint: If true, indicates the tool does not modify its
environment.
- destructiveHint: If true, the tool may perform destructive updates
(only meaningful when readOnlyHint is false).
- idempotentHint: If true, calling the tool repeatedly with the same
arguments has no additional effect (only meaningful when readOnlyHint is
false).
- openWorldHint: If true, the tool may interact with an "open world" of
external entities.
.google.protobuf.Struct annotations = 7;
| Returns |
| Type |
Description |
boolean |
Whether the annotations field is set.
|
public boolean hasInputSchema()
A JSON Schema object defining the expected parameters for invoking the
tool.
.google.protobuf.Struct input_schema = 5;
| Returns |
| Type |
Description |
boolean |
Whether the inputSchema field is set.
|
public boolean hasOutputSchema()
Optional. A JSON Schema object defining the expected structure of the
tool's output.
.google.protobuf.Struct output_schema = 6;
| Returns |
| Type |
Description |
boolean |
Whether the outputSchema field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public McpTool.Builder newBuilderForType()
protected McpTool.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
public McpTool.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides