Package google.cloud.agentregistry.v1alpha

Index

AgentRegistry

CreateBinding

rpc CreateBinding(CreateBindingRequest) returns (Operation)

Creates a new Binding in a given project and location.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/agentregistry.read-write

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • agentregistry.bindings.create

For more information, see the IAM documentation.
CreateService

rpc CreateService(CreateServiceRequest) returns (Operation)

Creates a new Service in a given project and location.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/agentregistry.read-write

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • agentregistry.services.create

For more information, see the IAM documentation.
DeleteBinding

rpc DeleteBinding(DeleteBindingRequest) returns (Operation)

Deletes a single Binding.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/agentregistry.read-write

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • agentregistry.bindings.delete

For more information, see the IAM documentation.
DeleteService

rpc DeleteService(DeleteServiceRequest) returns (Operation)

Deletes a single Service.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/agentregistry.read-write

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • agentregistry.services.delete

For more information, see the IAM documentation.
FetchAvailableBindings

rpc FetchAvailableBindings(FetchAvailableBindingsRequest) returns (FetchAvailableBindingsResponse)

Fetches available Bindings.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/agentregistry.read-write
  • https://www.googleapis.com/auth/agentregistry.read-only

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • agentregistry.bindings.fetchAvailable

For more information, see the IAM documentation.
GetAgent

rpc GetAgent(GetAgentRequest) returns (Agent)

Gets details of a single Agent.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/agentregistry.read-write
  • https://www.googleapis.com/auth/agentregistry.read-only

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • agentregistry.agents.get

For more information, see the IAM documentation.
GetBinding

rpc GetBinding(GetBindingRequest) returns (Binding)

Gets details of a single Binding.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/agentregistry.read-write
  • https://www.googleapis.com/auth/agentregistry.read-only

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • agentregistry.bindings.get

For more information, see the IAM documentation.
GetEndpoint

rpc GetEndpoint(GetEndpointRequest) returns (Endpoint)

Gets details of a single Endpoint.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/agentregistry.read-write
  • https://www.googleapis.com/auth/agentregistry.read-only

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • agentregistry.endpoints.get

For more information, see the IAM documentation.
GetMcpServer

rpc GetMcpServer(GetMcpServerRequest) returns (McpServer)

Gets details of a single McpServer.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/agentregistry.read-write
  • https://www.googleapis.com/auth/agentregistry.read-only

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • agentregistry.mcpServers.get

For more information, see the IAM documentation.
GetService

rpc GetService(GetServiceRequest) returns (Service)

Gets details of a single Service.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/agentregistry.read-write
  • https://www.googleapis.com/auth/agentregistry.read-only

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • agentregistry.services.get

For more information, see the IAM documentation.
ListAgents

rpc ListAgents(ListAgentsRequest) returns (ListAgentsResponse)

Lists Agents in a given project and location.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/agentregistry.read-write
  • https://www.googleapis.com/auth/agentregistry.read-only

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • agentregistry.agents.list

For more information, see the IAM documentation.
ListBindings

rpc ListBindings(ListBindingsRequest) returns (ListBindingsResponse)

Lists Bindings in a given project and location.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/agentregistry.read-write
  • https://www.googleapis.com/auth/agentregistry.read-only

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • agentregistry.bindings.list

For more information, see the IAM documentation.
ListEndpoints

rpc ListEndpoints(ListEndpointsRequest) returns (ListEndpointsResponse)

Lists Endpoints in a given project and location.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/agentregistry.read-write
  • https://www.googleapis.com/auth/agentregistry.read-only

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • agentregistry.endpoints.list

For more information, see the IAM documentation.
ListMcpServers

rpc ListMcpServers(ListMcpServersRequest) returns (ListMcpServersResponse)

Lists McpServers in a given project and location.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/agentregistry.read-write
  • https://www.googleapis.com/auth/agentregistry.read-only

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • agentregistry.mcpServers.list

For more information, see the IAM documentation.
ListServices

rpc ListServices(ListServicesRequest) returns (ListServicesResponse)

Lists Services in a given project and location.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/agentregistry.read-write
  • https://www.googleapis.com/auth/agentregistry.read-only

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • agentregistry.services.list

For more information, see the IAM documentation.
SearchAgents

rpc SearchAgents(SearchAgentsRequest) returns (SearchAgentsResponse)

Searches Agents in a given project and location.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/agentregistry.read-write
  • https://www.googleapis.com/auth/agentregistry.read-only

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • agentregistry.agents.search

For more information, see the IAM documentation.
SearchMcpServers

rpc SearchMcpServers(SearchMcpServersRequest) returns (SearchMcpServersResponse)

Searches McpServers in a given project and location.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/agentregistry.read-write
  • https://www.googleapis.com/auth/agentregistry.read-only

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • agentregistry.mcpServers.search

For more information, see the IAM documentation.
UpdateBinding

rpc UpdateBinding(UpdateBindingRequest) returns (Operation)

Updates the parameters of a single Binding.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/agentregistry.read-write

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • agentregistry.bindings.update

For more information, see the IAM documentation.
UpdateService

rpc UpdateService(UpdateServiceRequest) returns (Operation)

Updates the parameters of a single Service.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/agentregistry.read-write

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • agentregistry.services.update

For more information, see the IAM documentation.

Agent

Represents an Agent. "A2A" below refers to the Agent-to-Agent protocol.

Fields
name

string

Identifier. The resource name of an Agent. Format: projects/{project}/locations/{location}/agents/{agent}.
agent_id

string

Output only. A stable, globally unique identifier for agents.
location

string

Output only. The location where agent is hosted. The value is defined by the hosting environment (i.e. cloud provider).
display_name

string

Output only. The display name of the agent, often obtained from the A2A Agent Card.
description

string

Output only. The description of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no description.
version

string

Output only. The version of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no version or agent is not an A2A Agent.
protocols[]

Protocol

Output only. The connection details for the Agent.
skills[]

Skill

Output only. Skills the agent possesses, often obtained from the A2A Agent Card.
uid

string

Output only. A universally unique identifier for the Agent.
create_time

Timestamp

Output only. Create time.
update_time

Timestamp

Output only. Update time.
attributes

map<string, Struct>

Output only. Attributes of the Agent. Valid values:

  • agentregistry.googleapis.com/system/Framework: {"framework": "google-adk"} - the agent framework used to develop the Agent. Example values: "google-adk", "langchain", "custom".
  • agentregistry.googleapis.com/system/RuntimeIdentity: {"principal": "principal://..."} - the runtime identity associated with the Agent.
  • agentregistry.googleapis.com/system/RuntimeReference: {"uri": "//..."}
  • the URI of the underlying resource hosting the Agent, for example, the Reasoning Engine URI.
card

Card

Output only. Full Agent Card payload, when available.

Card

Full Agent Card payload, often obtained from the A2A Agent Card.

Fields
type

Type

Output only. The type of agent card.
content

Struct

Output only. The content of the agent card.

Type

Represents the type of the agent card.

Enums
TYPE_UNSPECIFIED Unspecified type.
A2A_AGENT_CARD Indicates that the card is an A2A Agent Card.

Protocol

Represents the protocol of an Agent.

Fields
type

Type

Output only. The type of the protocol.
protocol_version

string

Output only. The version of the protocol, for example, the A2A Agent Card version.
interfaces[]

Interface

Output only. The connection details for the Agent.

Type

The type of the protocol.

Enums
TYPE_UNSPECIFIED Unspecified type.
A2A_AGENT The interfaces point to an A2A Agent following the A2A specification.
CUSTOM Agent does not follow any standard protocol.

Skill

Represents the skills of an Agent.

Fields
id

string

Output only. A unique identifier for the agent's skill.
name

string

Output only. A human-readable name for the agent's skill.
description

string

Output only. A more detailed description of the skill.
tags[]

string

Output only. Keywords describing the skill.
examples[]

string

Output only. Example prompts or scenarios this skill can handle.

Binding

Represents a user-defined Binding.

Fields
name

string

Required. Identifier. The resource name of the Binding. Format: projects/{project}/locations/{location}/bindings/{binding}.
display_name

string

Optional. User-defined display name for the Binding. Can have a maximum length of 63 characters.
description

string

Optional. User-defined description of a Binding. Can have a maximum length of 2048 characters.
source

Source

Required. The target Agent of the Binding.
target

Target

Required. The target Agent Registry Resource of the Binding.
create_time

Timestamp

Output only. Timestamp when this binding was created.
update_time

Timestamp

Output only. Timestamp when this binding was last updated.
Union field binding. The configuration for the Binding. binding can be only one of the following:
auth_provider_binding

AuthProviderBinding

The binding for AuthProvider.

AuthProviderBinding

The AuthProvider of the Binding.

Fields
auth_provider

string

Required. The resource name of the target AuthProvider. Format:

  • projects/{project}/locations/{location}/authProviders/{auth_provider}
scopes[]

string

Optional. The list of OAuth2 scopes of the AuthProvider.
continue_uri

string

Optional. The continue URI of the AuthProvider. The URI is used to reauthenticate the user and finalize the managed OAuth flow.

Source

The source of the Binding.

Fields
Union field source_type. The type of the source, currently only supports Agents. Potential future fields include 'tag', etc. source_type can be only one of the following:
identifier

string

The identifier of the source Agent. Format:

  • urn:agent:{publisher}:{namespace}:{name}

Target

The target of the Binding.

Fields
Union field target_type. The type of the target, currently only supports an AgentRegistry Resource. Potential future fields include 'tag', etc. target_type can be only one of the following:
identifier

string

The identifier of the target Agent, MCP Server, or Endpoint. Format:

  • urn:agent:{publisher}:{namespace}:{name}
  • urn:mcp:{publisher}:{namespace}:{name}
  • urn:endpoint:{publisher}:{namespace}:{name}

CreateBindingRequest

Message for creating a Binding

Fields
parent

string

Required. The project and location to create the Binding in. Expected format: projects/{project}/locations/{location}.
binding_id

string

Required. The ID to use for the binding, which will become the final component of the binding's resource name.

This value should be 4-63 characters, and must conform to RFC-1034. Specifically, it must match the regular expression ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$.
binding

Binding

Required. The Binding resource that is being created.
request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

CreateServiceRequest

Message for creating a Service

Fields
parent

string

Required. The project and location to create the Service in. Expected format: projects/{project}/locations/{location}.
service_id

string

Required. The ID to use for the service, which will become the final component of the service's resource name.

This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.
service

Service

Required. The Service resource that is being created. Format: projects/{project}/locations/{location}/services/{service}.
request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

DeleteBindingRequest

Message for deleting a Binding

Fields
name

string

Required. The name of the Binding. Format: projects/{project}/locations/{location}/bindings/{binding}.
request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

DeleteServiceRequest

Message for deleting a Service

Fields
name

string

Required. The name of the Service. Format: projects/{project}/locations/{location}/services/{service}.
request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Endpoint

Represents an Endpoint.

Fields
name

string

Identifier. The resource name of the Endpoint. Format: projects/{project}/locations/{location}/endpoints/{endpoint}.
endpoint_id

string

Output only. A stable, globally unique identifier for Endpoint.
display_name

string

Output only. Display name for the Endpoint.
description

string

Output only. Description of an Endpoint.
interfaces[]

Interface

Required. The connection details for the Endpoint.
create_time

Timestamp

Output only. Create time.
update_time

Timestamp

Output only. Update time.
attributes

map<string, Struct>

Output only. Attributes of the Endpoint.

Valid values:

  • agentregistry.googleapis.com/system/RuntimeReference: {"uri": "//..."} - the URI of the underlying resource hosting the Endpoint, for example, the GKE Deployment.

FetchAvailableBindingsRequest

Message for fetching available Bindings.

Fields
parent

string

Required. The parent, in the format projects/{project}/locations/{location}.
page_size

int32

Optional. Requested page size. Server may return fewer items than requested. Page size is 500 if unspecified and is capped at 500 even if a larger value is given.
page_token

string

Optional. A token identifying a page of results the server should return.
Union field source. The reference of the source Agent. source can be only one of the following:
source_identifier

string

The identifier of the source Agent. Format:

  • urn:agent:{publisher}:{namespace}:{name}
Union field target. The reference of the target Agent Registry resource. target can be only one of the following:
target_identifier

string

Optional. The identifier of the target Agent, MCP Server, or Endpoint. Format:

  • urn:agent:{publisher}:{namespace}:{name}
  • urn:mcp:{publisher}:{namespace}:{name}
  • urn:endpoint:{publisher}:{namespace}:{name}

FetchAvailableBindingsResponse

Message for response to fetching available Bindings.

Fields
bindings[]

Binding

The list of Bindings.
next_page_token

string

A token identifying a page of results the server should return.

GetAgentRequest

Message for getting a Agent

Fields
name

string

Required. Name of the resource

GetBindingRequest

Message for getting a Binding

Fields
name

string

Required. The name of the Binding. Format: projects/{project}/locations/{location}/bindings/{binding}.

GetEndpointRequest

Message for getting a Endpoint

Fields
name

string

Required. The name of the endpoint to retrieve. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

GetMcpServerRequest

Message for getting a McpServer

Fields
name

string

Required. Name of the resource

GetServiceRequest

Message for getting a Service

Fields
name

string

Required. The name of the Service. Format: projects/{project}/locations/{location}/services/{service}.

Interface

Represents the connection details for an Agent or MCP Server.

Fields
url

string

Required. The destination URL.
protocol_binding

ProtocolBinding

Required. The protocol binding of the interface.

ProtocolBinding

The protocol binding of the interface.

Enums
PROTOCOL_BINDING_UNSPECIFIED Unspecified transport protocol.
JSONRPC JSON-RPC specification.
GRPC gRPC specification.
HTTP_JSON HTTP+JSON specification.

ListAgentsRequest

Message for requesting list of Agents

Fields
parent

string

Required. Parent value for ListAgentsRequest
page_size

int32

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token

string

Optional. A token identifying a page of results the server should return.
filter

string

Optional. Filtering results
order_by

string

Optional. Hint for how to order the results

ListAgentsResponse

Message for response to listing Agents

Fields
agents[]

Agent

The list of Agents.
next_page_token

string

A token identifying a page of results the server should return.

ListBindingsRequest

Message for requesting a list of Bindings.

Fields
parent

string

Required. The project and location to list bindings in. Expected format: projects/{project}/locations/{location}.
page_size

int32

Optional. Requested page size. Server may return fewer items than requested. Page size is 500 if unspecified and is capped at 500 even if a larger value is given.
page_token

string

Optional. A token identifying a page of results the server should return.
filter

string

Optional. A query string used to filter the list of bindings returned. The filter expression must follow AIP-160 syntax.
order_by

string

Optional. Hint for how to order the results

ListBindingsResponse

Message for response to listing Bindings

Fields
bindings[]

Binding

The list of Binding resources matching the parent and filter criteria in the request. Each Binding resource follows the format: projects/{project}/locations/{location}/bindings/{binding}.
next_page_token

string

A token identifying a page of results the server should return. Used in page_token.

ListEndpointsRequest

Message for requesting list of Endpoints

Fields
parent

string

Required. The project and location to list endpoints in. Expected format: projects/{project}/locations/{location}.
page_size

int32

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token

string

Optional. A token identifying a page of results the server should return.
filter

string

Optional. A query string used to filter the list of endpoints returned. The filter expression must follow AIP-160 syntax.

Filtering is supported on the name, display_name, description, version, and interfaces fields.

Some examples:

  • name = "projects/p1/locations/l1/endpoints/e1"
  • display_name = "my-endpoint"
  • description = "my-endpoint-description"
  • version = "v1"
  • interfaces.transport = "HTTP_JSON"

ListEndpointsResponse

Message for response to listing Endpoints

Fields
endpoints[]

Endpoint

The list of Endpoint resources matching the parent and filter criteria in the request. Each Endpoint resource follows the format: projects/{project}/locations/{location}/endpoints/{endpoint}.
next_page_token

string

A token identifying a page of results the server should return. Used in page_token.

ListMcpServersRequest

Message for requesting list of McpServers

Fields
parent

string

Required. Parent value for ListMcpServersRequest. Format: projects/{project}/locations/{location}.
page_size

int32

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token

string

Optional. A token identifying a page of results the server should return.
filter

string

Optional. Filtering results
order_by

string

Optional. Hint for how to order the results

ListMcpServersResponse

Message for response to listing McpServers

Fields
mcp_servers[]

McpServer

The list of McpServers.
next_page_token

string

A token identifying a page of results the server should return.

ListServicesRequest

Message for requesting list of Services

Fields
parent

string

Required. The project and location to list services in. Expected format: projects/{project}/locations/{location}.
page_size

int32

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token

string

Optional. A token identifying a page of results the server should return.
filter

string

Optional. A query string used to filter the list of services returned. The filter expression must follow AIP-160 syntax.

Filtering is supported on the name, display_name, description, and labels fields.

Some examples:

  • name = "projects/p1/locations/l1/services/s1"
  • display_name = "my-service"
  • description : "myservice description"
  • labels.env = "prod"

ListServicesResponse

Message for response to listing Services

Fields
services[]

Service

The list of Service resources matching the parent and filter criteria in the request. Each Service resource follows the format: projects/{project}/locations/{location}/services/{service}.
next_page_token

string

A token identifying a page of results the server should return. Used in page_token.

McpServer

Represents an MCP (Model Context Protocol) Server.

Fields
name

string

Identifier. The resource name of the MCP Server. Format: projects/{project}/locations/{location}/mcpServers/{mcp_server}.
mcp_server_id

string

Output only. A stable, globally unique identifier for MCP Servers.
display_name

string

Output only. The display name of the MCP Server.
description

string

Output only. The description of the MCP Server.
interfaces[]

Interface

Output only. The connection details for the MCP Server.
tools[]

Tool

Output only. Tools provided by the MCP Server.
create_time

Timestamp

Output only. Create time.
update_time

Timestamp

Output only. Update time.
attributes

map<string, Struct>

Output only. Attributes of the MCP Server. Valid values:

  • agentregistry.googleapis.com/system/RuntimeIdentity: {"principal": "principal://..."} - the runtime identity associated with the MCP Server.
  • agentregistry.googleapis.com/system/RuntimeReference: {"uri": "//..."}
  • the URI of the underlying resource hosting the MCP Server, for example, the GKE Deployment.

Tool

Represents a single tool provided by an MCP Server.

Fields
name

string

Output only. Human-readable name of the tool.
description

string

Output only. Description of what the tool does.
annotations

Annotations

Output only. Annotations associated with the tool.

Annotations

Annotations describing the characteristics and behavior of a tool or operation.

Fields
title

string

Output only. A human-readable title for the tool.
destructive_hint

bool

Output only. If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates. NOTE: This property is meaningful only when read_only_hint == false Default: true
idempotent_hint

bool

Output only. If true, calling the tool repeatedly with the same arguments will have no additional effect on its environment. NOTE: This property is meaningful only when read_only_hint == false Default: false
open_world_hint

bool

Output only. If true, this tool may interact with an "open world" of external entities. If false, the tool's domain of interaction is closed. For example, the world of a web search tool is open, whereas that of a memory tool is not. Default: true
read_only_hint

bool

Output only. If true, the tool does not modify its environment. Default: false

OperationMetadata

Represents the metadata of the long-running operation.

Fields
create_time

Timestamp

Output only. The time the operation was created.
end_time

Timestamp

Output only. The time the operation finished running.
target

string

Output only. Server-defined resource path for the target of the operation.
verb

string

Output only. Name of the verb executed by the operation.
status_message

string

Output only. Human-readable status of the operation, if any.
requested_cancellation

bool

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
api_version

string

Output only. API version used to start the operation.

SearchAgentsRequest

Message for searching Agents

Fields
parent

string

Required. Parent value for SearchAgentsRequest. Format: projects/{project}/locations/{location}.
search_string

string

Optional. Search criteria used to select the Agents to return. If no search criteria is specified then all accessible Agents will be returned.

Search expressions can be used to restrict results based upon searchable fields, where the operators can be used along with the suffix wildcard symbol *. See instructions for more details.

Allowed operators: =, :, NOT, AND, OR, and ().

Searchable fields:

Field = : * Keyword Search
agentId Yes Yes Yes Included
name No Yes Yes Included
displayName No Yes Yes Included
description No Yes No Included
skills No Yes No Included
skills.id No Yes No Included
skills.name No Yes No Included
skills.description No Yes No Included
skills.tags No Yes No Included
skills.examples No Yes No Included

Examples:

  • agentId="urn:agent:projects-123:projects:123:locations:us-central1:reasoningEngines:1234" to find the agent with the specified agent ID.
  • name:important to find agents whose name contains important as a word.
  • displayName:works* to find agents whose display name contains words that start with works.
  • skills.tags:test to find agents whose skills tags contain test.
  • planner OR booking to find agents whose metadata contains the words planner or booking.
page_size

int32

Optional. The maximum number of search results to return per page. The page size is capped at 100, even if a larger value is specified. A negative value will result in an INVALID_ARGUMENT error. If unspecified or set to 0, a default value of 20 will be used. The server may return fewer results than requested.
page_token

string

Optional. If present, retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of all other method parameters, must be identical to those in the previous call.

SearchAgentsResponse

Message for response to searching Agents

Fields
agents[]

Agent

A list of Agents that match the search_string.
next_page_token

string

If there are more results than those appearing in this response, then next_page_token is included. To get the next set of results, call this method again using the value of next_page_token as page_token.

SearchMcpServersRequest

Message for searching MCP Servers

Fields
parent

string

Required. Parent value for SearchMcpServersRequest. Format: projects/{project}/locations/{location}.
search_string

string

Optional. Search criteria used to select the MCP Servers to return. If no search criteria is specified then all accessible MCP Servers will be returned.

Search expressions can be used to restrict results based upon searchable fields, where the operators can be used along with the suffix wildcard symbol *. See instructions for more details.

Allowed operators: =, :, NOT, AND, OR, and ().

Searchable fields:

Field = : * Keyword Search
mcpServerId Yes Yes Yes Included
name No Yes Yes Included
displayName No Yes Yes Included

Examples:

  • mcpServerId="urn:mcp:projects-123:projects:123:locations:us-central1:agentregistry:services:service-id" to find the MCP Server with the specified MCP Server ID.
  • name:important to find MCP Servers whose name contains important as a word.
  • displayName:works* to find MCP Servers whose display name contains words that start with works.
  • planner OR booking to find MCP Servers whose metadata contains the words planner or booking.
  • mcpServerId:service-id AND (displayName:planner OR displayName:booking) to find MCP Servers whose MCP Server ID contains service-id and whose display name contains planner or booking.
page_size

int32

Optional. The maximum number of search results to return per page. The page size is capped at 100, even if a larger value is specified. A negative value will result in an INVALID_ARGUMENT error. If unspecified or set to 0, a default value of 20 will be used. The server may return fewer results than requested.
page_token

string

Optional. If present, retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of all other method parameters, must be identical to those in the previous call.

SearchMcpServersResponse

Message for response to searching MCP Servers

Fields
mcp_servers[]

McpServer

A list of McpServers that match the search_string.
next_page_token

string

If there are more results than those appearing in this response, then next_page_token is included. To get the next set of results, call this method again using the value of next_page_token as page_token.

Service

Represents a user-defined Service.

Fields
name

string

Identifier. The resource name of the Service. Format: projects/{project}/locations/{location}/services/{service}.
display_name

string

Optional. User-defined display name for the Service. Can have a maximum length of 63 characters.
description

string

Optional. User-defined description of an Service. Can have a maximum length of 2048 characters.
interfaces[]

Interface

Optional. The connection details for the Service.
registry_resource

string

Output only. The resource name of the resulting Agent, MCP Server, or Endpoint. Format:

  • projects/{project}/locations/{location}/mcpServers/{mcp_server}
  • projects/{project}/locations/{location}/agents/{agent}
  • projects/{project}/locations/{location}/endpoints/{endpoint}
create_time

Timestamp

Output only. Create time.
update_time

Timestamp

Output only. Update time.
Union field spec. The spec of the service. At least one of the specs must be set. spec can be only one of the following:
agent_spec

AgentSpec

Optional. The spec of the Agent. When agent_spec is set, the type of the service is Agent.
mcp_server_spec

McpServerSpec

Optional. The spec of the MCP Server. When mcp_server_spec is set, the type of the service is MCP Server.
endpoint_spec

EndpointSpec

Optional. The spec of the Endpoint. When endpoint_spec is set, the type of the service is Endpoint.

AgentSpec

The spec of the agent.

Fields
type

Type

Required. The type of the agent spec content.
content

Struct

Optional. The content of the Agent spec in the JSON format. This payload is validated against the schema for the specified type. The content size is limited to 10KB.

Type

The type of the agent spec.

Enums
TYPE_UNSPECIFIED Unspecified type.
NO_SPEC There is no spec for the Agent. The content field must be empty.
A2A_AGENT_CARD The content is an A2A Agent Card following the A2A specification. The interfaces field must be empty.

EndpointSpec

The spec of the endpoint.

Fields
type

Type

Required. The type of the endpoint spec content.
content

Struct

Optional. The content of the endpoint spec. Reserved for future use.

Type

The type of the endpoint spec.

Enums
TYPE_UNSPECIFIED Unspecified type.
NO_SPEC There is no spec for the Endpoint. The content field must be empty.

McpServerSpec

The spec of the MCP Server.

Fields
type

Type

Required. The type of the MCP Server spec content.
content

Struct

Optional. The content of the MCP Server spec. This payload is validated against the schema for the specified type. The content size is limited to 10KB.

Type

The type of the MCP Server spec.

Enums
TYPE_UNSPECIFIED Unspecified type.
NO_SPEC There is no spec for the MCP Server. The content field must be empty.
TOOL_SPEC The content is a MCP Tool Spec following the One MCP specification. The payload is the same as the tools/list response.

UpdateBindingRequest

Message for updating a Binding

Fields
binding

Binding

Required. The Binding resource that is being updated.
update_mask

FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the Binding resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.
request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

UpdateServiceRequest

Message for updating a Service

Fields
update_mask

FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the Service resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.
service

Service

Required. The Service resource that is being updated. Format: projects/{project}/locations/{location}/services/{service}.
request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).