Reference documentation and code samples for the Google Cloud Api Registry V1 Client class McpServer.
Represents an MCP Server. MCP Servers act as endpoints that expose a collection of tools that can be invoked by agents.
Generated from protobuf message google.cloud.apiregistry.v1.McpServer
Namespace
Google \ Cloud \ ApiRegistry \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The resource name of the MCP Server. Format: |
↳ display_name |
string
Optional. A human readable name for the MCP server. |
↳ description |
string
Optional. A human-readable description of the MCP Server's functionality. |
↳ urls |
array
The base URL of the MCP server. Example: [geolocation.googleapis.com/mcp]. |
↳ capabilities |
Google\Protobuf\Struct
The capabilities that a server may support. Known capabilities defined in https://modelcontextprotocol.io/specification/2025-06-18/schema#servercapabilities and additional capabilities defined by the servers. |
↳ state |
int
Output only. The state of the MCP Server. |
getName
Identifier. The resource name of the MCP Server.
Format:
projects/{project}/locations/{location}/mcpServers/{mcp_server}.
Example:
projects/12345/locations/us-central1/mcpServers/google:bigquery.googleapis.com:mcp
for 1p
projects/12345/locations/us-central1/mcpServers/apphub:starbucks for
2p
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name of the MCP Server.
Format:
projects/{project}/locations/{location}/mcpServers/{mcp_server}.
Example:
projects/12345/locations/us-central1/mcpServers/google:bigquery.googleapis.com:mcp
for 1p
projects/12345/locations/us-central1/mcpServers/apphub:starbucks for
2p
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Optional. A human readable name for the MCP server.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Optional. A human readable name for the MCP server.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. A human-readable description of the MCP Server's functionality.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. A human-readable description of the MCP Server's functionality.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUrls
The base URL of the MCP server. Example: [geolocation.googleapis.com/mcp].
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setUrls
The base URL of the MCP server. Example: [geolocation.googleapis.com/mcp].
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCapabilities
The capabilities that a server may support. Known capabilities defined in https://modelcontextprotocol.io/specification/2025-06-18/schema#servercapabilities and additional capabilities defined by the servers.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null |
|
hasCapabilities
clearCapabilities
setCapabilities
The capabilities that a server may support. Known capabilities defined in https://modelcontextprotocol.io/specification/2025-06-18/schema#servercapabilities and additional capabilities defined by the servers.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. The state of the MCP Server.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type State. |
setState
Output only. The state of the MCP Server.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type State. |
| Returns | |
|---|---|
| Type | Description |
$this |
|