Cloud API Registry V1BETA API - Class Google::Cloud::ApiRegistry::V1beta::McpTool (v0.1.0)

Reference documentation and code samples for the Cloud API Registry V1BETA API class Google::Cloud::ApiRegistry::V1beta::McpTool.

Message describing McpTool object

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#annotations

def annotations() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) —

    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.

#annotations=

def annotations=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) —

    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.
Returns
  • (::Google::Protobuf::Struct) —

    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.

#description

def description() -> ::String
Returns
  • (::String) — A human-readable description of the tool's functionality.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — A human-readable description of the tool's functionality.
Returns
  • (::String) — A human-readable description of the tool's functionality.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Optional. A human-readable name for the tool, suitable for display.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Optional. A human-readable name for the tool, suitable for display.
Returns
  • (::String) — Optional. A human-readable name for the tool, suitable for display.

#input_schema

def input_schema() -> ::Google::Protobuf::Struct
Returns

#input_schema=

def input_schema=(value) -> ::Google::Protobuf::Struct
Parameter
Returns

#mcp_server_urls

def mcp_server_urls() -> ::Array<::String>
Returns
  • (::Array<::String>) — Automatically populated reference to MCP Server. Helpful when multiple tools are requested across different MCP Servers.

#mcp_server_urls=

def mcp_server_urls=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Automatically populated reference to MCP Server. Helpful when multiple tools are requested across different MCP Servers.
Returns
  • (::Array<::String>) — Automatically populated reference to MCP Server. Helpful when multiple tools are requested across different MCP Servers.

#name

def name() -> ::String
Returns
  • (::String) — 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

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — 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
Returns
  • (::String) — 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

#output_schema

def output_schema() -> ::Google::Protobuf::Struct
Returns

#output_schema=

def output_schema=(value) -> ::Google::Protobuf::Struct
Parameter
Returns