Google Cloud Agent Registry V1 Client - Class SearchMcpServersRequest (0.2.0)

Reference documentation and code samples for the Google Cloud Agent Registry V1 Client class SearchMcpServersRequest.

Message for searching MCP Servers

Generated from protobuf message google.cloud.agentregistry.v1.SearchMcpServersRequest

Namespace

Google \ Cloud \ AgentRegistry \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ 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	int 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.

getParent

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

Returns
Type	Description
string

setParent

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getSearchString

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.

Returns
Type	Description
string

setSearchString

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

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.

Returns
Type	Description
int

setPageSize

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.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

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.

Returns
Type	Description
string

setPageToken

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameter
Name	Description
parent	string Required. Parent value for SearchMcpServersRequest. Format: projects/{project}/locations/{location}. Please see AgentRegistryClient::locationName() for help formatting this field.

Returns
Type	Description
SearchMcpServersRequest