Agent Registry API . projects . locations . mcpServers

Instance Methods

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Gets details of a single McpServer.

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists McpServers in a given project and location.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
get(name, x__xgafv=None)
Gets details of a single McpServer.

Args:
  name: string, Required. Name of the resource (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents an MCP (Model Context Protocol) Server.
  "attributes": { # 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.
    "a_key": {
      "a_key": "", # Properties of the object.
    },
  },
  "createTime": "A String", # Output only. Create time.
  "description": "A String", # Output only. The description of the MCP Server.
  "displayName": "A String", # Output only. The display name of the MCP Server.
  "interfaces": [ # Output only. The connection details for the MCP Server.
    { # Represents the connection details for an Agent or MCP Server.
      "protocolBinding": "A String", # Required. The protocol binding of the interface.
      "url": "A String", # Required. The destination URL.
    },
  ],
  "mcpServerId": "A String", # Output only. A stable, globally unique identifier for MCP Servers.
  "name": "A String", # Identifier. The resource name of the MCP Server. Format: `projects/{project}/locations/{location}/mcpServers/{mcp_server}`.
  "tools": [ # Output only. Tools provided by the MCP Server.
    { # Represents a single tool provided by an MCP Server.
      "annotations": { # Annotations describing the characteristics and behavior of a tool or operation. # Output only. Annotations associated with the tool.
        "destructiveHint": True or False, # 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
        "idempotentHint": True or False, # 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
        "openWorldHint": True or False, # 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
        "readOnlyHint": True or False, # Output only. If true, the tool does not modify its environment. Default: false
        "title": "A String", # Output only. A human-readable title for the tool.
      },
      "description": "A String", # Output only. Description of what the tool does.
      "name": "A String", # Output only. Human-readable name of the tool.
    },
  ],
  "updateTime": "A String", # Output only. Update time.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists McpServers in a given project and location.

Args:
  parent: string, Required. Parent value for ListMcpServersRequest. Format: `projects/{project}/locations/{location}`. (required)
  filter: string, Optional. Filtering results
  orderBy: string, Optional. Hint for how to order the results
  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  pageToken: string, Optional. A token identifying a page of results the server should return.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message for response to listing McpServers
  "mcpServers": [ # The list of McpServers.
    { # Represents an MCP (Model Context Protocol) Server.
      "attributes": { # 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.
        "a_key": {
          "a_key": "", # Properties of the object.
        },
      },
      "createTime": "A String", # Output only. Create time.
      "description": "A String", # Output only. The description of the MCP Server.
      "displayName": "A String", # Output only. The display name of the MCP Server.
      "interfaces": [ # Output only. The connection details for the MCP Server.
        { # Represents the connection details for an Agent or MCP Server.
          "protocolBinding": "A String", # Required. The protocol binding of the interface.
          "url": "A String", # Required. The destination URL.
        },
      ],
      "mcpServerId": "A String", # Output only. A stable, globally unique identifier for MCP Servers.
      "name": "A String", # Identifier. The resource name of the MCP Server. Format: `projects/{project}/locations/{location}/mcpServers/{mcp_server}`.
      "tools": [ # Output only. Tools provided by the MCP Server.
        { # Represents a single tool provided by an MCP Server.
          "annotations": { # Annotations describing the characteristics and behavior of a tool or operation. # Output only. Annotations associated with the tool.
            "destructiveHint": True or False, # 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
            "idempotentHint": True or False, # 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
            "openWorldHint": True or False, # 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
            "readOnlyHint": True or False, # Output only. If true, the tool does not modify its environment. Default: false
            "title": "A String", # Output only. A human-readable title for the tool.
          },
          "description": "A String", # Output only. Description of what the tool does.
          "name": "A String", # Output only. Human-readable name of the tool.
        },
      ],
      "updateTime": "A String", # Output only. Update time.
    },
  ],
  "nextPageToken": "A String", # A token identifying a page of results the server should return.
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.