Interface McpToolOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
McpTool, McpTool.Builder

@Generated public interface McpToolOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Struct
    Optional key-value object that allows developers to provide additional information regarding tool properties, behavior, and usage best practices.
    com.google.protobuf.StructOrBuilder
    Optional key-value object that allows developers to provide additional information regarding tool properties, behavior, and usage best practices.
    A human-readable description of the tool's functionality.
    com.google.protobuf.ByteString
    A human-readable description of the tool's functionality.
    Optional.
    com.google.protobuf.ByteString
    Optional.
    com.google.protobuf.Struct
    A JSON Schema object defining the expected parameters for invoking the tool.
    com.google.protobuf.StructOrBuilder
    A JSON Schema object defining the expected parameters for invoking the tool.
    getMcpServerUrls(int index)
    Automatically populated reference to MCP Server.
    com.google.protobuf.ByteString
    Automatically populated reference to MCP Server.
    int
    Automatically populated reference to MCP Server.
    Automatically populated reference to MCP Server.
    Identifier.
    com.google.protobuf.ByteString
    Identifier.
    com.google.protobuf.Struct
    Optional.
    com.google.protobuf.StructOrBuilder
    Optional.
    boolean
    Optional key-value object that allows developers to provide additional information regarding tool properties, behavior, and usage best practices.
    boolean
    A JSON Schema object defining the expected parameters for invoking the tool.
    boolean
    Optional.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Method Details

    • getName

      String getName()
       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:
      The name.
    • getNameBytes

      com.google.protobuf.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:
      The bytes for name.
    • getDisplayName

      String getDisplayName()
       Optional. A human-readable name for the tool, suitable for display.
       
      string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The displayName.
    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       Optional. A human-readable name for the tool, suitable for display.
       
      string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for displayName.
    • getDescription

      String getDescription()
       A human-readable description of the tool's functionality.
       
      string description = 3;
      Returns:
      The description.
    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       A human-readable description of the tool's functionality.
       
      string description = 3;
      Returns:
      The bytes for description.
    • getMcpServerUrlsList

      List<String> getMcpServerUrlsList()
       Automatically populated reference to MCP Server. Helpful when multiple
       tools are requested across different MCP Servers.
       
      repeated string mcp_server_urls = 4;
      Returns:
      A list containing the mcpServerUrls.
    • getMcpServerUrlsCount

      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:
      The count of mcpServerUrls.
    • getMcpServerUrls

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The mcpServerUrls at the given index.
    • getMcpServerUrlsBytes

      com.google.protobuf.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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the mcpServerUrls at the given index.
    • hasInputSchema

      boolean hasInputSchema()
       A JSON Schema object defining the expected parameters for invoking the
       tool.
       
      .google.protobuf.Struct input_schema = 5;
      Returns:
      Whether the inputSchema field is set.
    • getInputSchema

      com.google.protobuf.Struct getInputSchema()
       A JSON Schema object defining the expected parameters for invoking the
       tool.
       
      .google.protobuf.Struct input_schema = 5;
      Returns:
      The inputSchema.
    • getInputSchemaOrBuilder

      com.google.protobuf.StructOrBuilder getInputSchemaOrBuilder()
       A JSON Schema object defining the expected parameters for invoking the
       tool.
       
      .google.protobuf.Struct input_schema = 5;
    • hasOutputSchema

      boolean hasOutputSchema()
       Optional. A JSON Schema object defining the expected structure of the
       tool's output.
       
      .google.protobuf.Struct output_schema = 6;
      Returns:
      Whether the outputSchema field is set.
    • getOutputSchema

      com.google.protobuf.Struct getOutputSchema()
       Optional. A JSON Schema object defining the expected structure of the
       tool's output.
       
      .google.protobuf.Struct output_schema = 6;
      Returns:
      The outputSchema.
    • getOutputSchemaOrBuilder

      com.google.protobuf.StructOrBuilder getOutputSchemaOrBuilder()
       Optional. A JSON Schema object defining the expected structure of the
       tool's output.
       
      .google.protobuf.Struct output_schema = 6;
    • hasAnnotations

      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:
      Whether the annotations field is set.
    • getAnnotations

      com.google.protobuf.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:
      The annotations.
    • getAnnotationsOrBuilder

      com.google.protobuf.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;