apiregistrypb

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 29, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source
const (
	CloudApiRegistry_GetMcpServer_FullMethodName   = "/google.cloud.apiregistry.v1.CloudApiRegistry/GetMcpServer"
	CloudApiRegistry_ListMcpServers_FullMethodName = "/google.cloud.apiregistry.v1.CloudApiRegistry/ListMcpServers"
	CloudApiRegistry_GetMcpTool_FullMethodName     = "/google.cloud.apiregistry.v1.CloudApiRegistry/GetMcpTool"
	CloudApiRegistry_ListMcpTools_FullMethodName   = "/google.cloud.apiregistry.v1.CloudApiRegistry/ListMcpTools"
)

Variables

View Source
var (
	State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "ENABLED",
		2: "DISABLED",
	}
	State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"ENABLED":           1,
		"DISABLED":          2,
	}
)

Enum value maps for State.

View Source
var CloudApiRegistry_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.apiregistry.v1.CloudApiRegistry",
	HandlerType: (*CloudApiRegistryServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetMcpServer",
			Handler:    _CloudApiRegistry_GetMcpServer_Handler,
		},
		{
			MethodName: "ListMcpServers",
			Handler:    _CloudApiRegistry_ListMcpServers_Handler,
		},
		{
			MethodName: "GetMcpTool",
			Handler:    _CloudApiRegistry_GetMcpTool_Handler,
		},
		{
			MethodName: "ListMcpTools",
			Handler:    _CloudApiRegistry_ListMcpTools_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/apiregistry/v1/service.proto",
}

CloudApiRegistry_ServiceDesc is the grpc.ServiceDesc for CloudApiRegistry service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source
var File_google_cloud_apiregistry_v1_common_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_apiregistry_v1_resources_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_apiregistry_v1_service_proto protoreflect.FileDescriptor

Functions

func RegisterCloudApiRegistryServer

func RegisterCloudApiRegistryServer(s grpc.ServiceRegistrar, srv CloudApiRegistryServer)

Types

type CloudApiRegistryClient

type CloudApiRegistryClient interface {
	// Gets a single McpServer.
	GetMcpServer(ctx context.Context, in *GetMcpServerRequest, opts ...grpc.CallOption) (*McpServer, error)
	// Lists McpServers in a given Project.
	ListMcpServers(ctx context.Context, in *ListMcpServersRequest, opts ...grpc.CallOption) (*ListMcpServersResponse, error)
	// Gets a single McpTool.
	GetMcpTool(ctx context.Context, in *GetMcpToolRequest, opts ...grpc.CallOption) (*McpTool, error)
	// Lists McpTools in a given McpServer.
	ListMcpTools(ctx context.Context, in *ListMcpToolsRequest, opts ...grpc.CallOption) (*ListMcpToolsResponse, error)
}

CloudApiRegistryClient is the client API for CloudApiRegistry service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

type CloudApiRegistryServer

type CloudApiRegistryServer interface {
	// Gets a single McpServer.
	GetMcpServer(context.Context, *GetMcpServerRequest) (*McpServer, error)
	// Lists McpServers in a given Project.
	ListMcpServers(context.Context, *ListMcpServersRequest) (*ListMcpServersResponse, error)
	// Gets a single McpTool.
	GetMcpTool(context.Context, *GetMcpToolRequest) (*McpTool, error)
	// Lists McpTools in a given McpServer.
	ListMcpTools(context.Context, *ListMcpToolsRequest) (*ListMcpToolsResponse, error)
}

CloudApiRegistryServer is the server API for CloudApiRegistry service. All implementations should embed UnimplementedCloudApiRegistryServer for forward compatibility

type GetMcpServerRequest

type GetMcpServerRequest struct {

	// Required. Name of the resource
	// Format: projects/{project}/locations/{location}/mcpServers/{mcp_server}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Message for getting a McpServer

func (*GetMcpServerRequest) Descriptor deprecated

func (*GetMcpServerRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetMcpServerRequest.ProtoReflect.Descriptor instead.

func (*GetMcpServerRequest) GetName

func (x *GetMcpServerRequest) GetName() string

func (*GetMcpServerRequest) ProtoMessage

func (*GetMcpServerRequest) ProtoMessage()

func (*GetMcpServerRequest) ProtoReflect

func (x *GetMcpServerRequest) ProtoReflect() protoreflect.Message

func (*GetMcpServerRequest) Reset

func (x *GetMcpServerRequest) Reset()

func (*GetMcpServerRequest) String

func (x *GetMcpServerRequest) String() string

type GetMcpToolRequest

type GetMcpToolRequest struct {

	// Required. Name of the resource
	// Format:
	// projects/{project}/locations/{location}/mcpServers/{mcp_server}/mcpTools/{mcp_tool}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Message for getting a McpTool

func (*GetMcpToolRequest) Descriptor deprecated

func (*GetMcpToolRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetMcpToolRequest.ProtoReflect.Descriptor instead.

func (*GetMcpToolRequest) GetName

func (x *GetMcpToolRequest) GetName() string

func (*GetMcpToolRequest) ProtoMessage

func (*GetMcpToolRequest) ProtoMessage()

func (*GetMcpToolRequest) ProtoReflect

func (x *GetMcpToolRequest) ProtoReflect() protoreflect.Message

func (*GetMcpToolRequest) Reset

func (x *GetMcpToolRequest) Reset()

func (*GetMcpToolRequest) String

func (x *GetMcpToolRequest) String() string

type ListMcpServersRequest

type ListMcpServersRequest struct {

	// Required. Parent value for ListMcpServersRequest
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. Requested page size. Server may return fewer items than
	// requested. If unspecified, at most 50 items will be returned. The maximum
	// value is 100; values above 100 will be coerced to 100.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A token identifying a page of results the server should return.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. An expression that filters the results.
	// For syntax, see https://google.aip.dev/160.
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. A comma-separated list of fields to order by, sorted in ascending
	// order. Use "desc" after a field name for descending. For syntax, see
	// https://google.aip.dev/132#ordering.
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Message for requesting list of McpServers

func (*ListMcpServersRequest) Descriptor deprecated

func (*ListMcpServersRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListMcpServersRequest.ProtoReflect.Descriptor instead.

func (*ListMcpServersRequest) GetFilter

func (x *ListMcpServersRequest) GetFilter() string

func (*ListMcpServersRequest) GetOrderBy

func (x *ListMcpServersRequest) GetOrderBy() string

func (*ListMcpServersRequest) GetPageSize

func (x *ListMcpServersRequest) GetPageSize() int32

func (*ListMcpServersRequest) GetPageToken

func (x *ListMcpServersRequest) GetPageToken() string

func (*ListMcpServersRequest) GetParent

func (x *ListMcpServersRequest) GetParent() string

func (*ListMcpServersRequest) ProtoMessage

func (*ListMcpServersRequest) ProtoMessage()

func (*ListMcpServersRequest) ProtoReflect

func (x *ListMcpServersRequest) ProtoReflect() protoreflect.Message

func (*ListMcpServersRequest) Reset

func (x *ListMcpServersRequest) Reset()

func (*ListMcpServersRequest) String

func (x *ListMcpServersRequest) String() string

type ListMcpServersResponse

type ListMcpServersResponse struct {

	// The list of McpServer
	McpServers []*McpServer `protobuf:"bytes,1,rep,name=mcp_servers,json=mcpServers,proto3" json:"mcp_servers,omitempty"`
	// A token identifying a page of results the server should return.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// Unordered list. Locations that could not be reached.
	Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
	// contains filtered or unexported fields
}

Message for response to listing McpServers

func (*ListMcpServersResponse) Descriptor deprecated

func (*ListMcpServersResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListMcpServersResponse.ProtoReflect.Descriptor instead.

func (*ListMcpServersResponse) GetMcpServers

func (x *ListMcpServersResponse) GetMcpServers() []*McpServer

func (*ListMcpServersResponse) GetNextPageToken

func (x *ListMcpServersResponse) GetNextPageToken() string

func (*ListMcpServersResponse) GetUnreachable

func (x *ListMcpServersResponse) GetUnreachable() []string

func (*ListMcpServersResponse) ProtoMessage

func (*ListMcpServersResponse) ProtoMessage()

func (*ListMcpServersResponse) ProtoReflect

func (x *ListMcpServersResponse) ProtoReflect() protoreflect.Message

func (*ListMcpServersResponse) Reset

func (x *ListMcpServersResponse) Reset()

func (*ListMcpServersResponse) String

func (x *ListMcpServersResponse) String() string

type ListMcpToolsRequest

type ListMcpToolsRequest struct {

	// Required. Parent value for ListMcpToolsRequest
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. Requested page size. Server may return fewer items than
	// requested. If unspecified, at most 50 items will be returned. The maximum
	// value is 100; values above 100 will be coerced to 100.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A token identifying a page of results the server should return.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. An expression that filters the results.
	// For syntax, see https://google.aip.dev/160.
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. A comma-separated list of fields to order by, sorted in ascending
	// order. Use "desc" after a field name for descending. For syntax, see
	// https://google.aip.dev/132#ordering.
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Message for requesting list of McpTools

func (*ListMcpToolsRequest) Descriptor deprecated

func (*ListMcpToolsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListMcpToolsRequest.ProtoReflect.Descriptor instead.

func (*ListMcpToolsRequest) GetFilter

func (x *ListMcpToolsRequest) GetFilter() string

func (*ListMcpToolsRequest) GetOrderBy

func (x *ListMcpToolsRequest) GetOrderBy() string

func (*ListMcpToolsRequest) GetPageSize

func (x *ListMcpToolsRequest) GetPageSize() int32

func (*ListMcpToolsRequest) GetPageToken

func (x *ListMcpToolsRequest) GetPageToken() string

func (*ListMcpToolsRequest) GetParent

func (x *ListMcpToolsRequest) GetParent() string

func (*ListMcpToolsRequest) ProtoMessage

func (*ListMcpToolsRequest) ProtoMessage()

func (*ListMcpToolsRequest) ProtoReflect

func (x *ListMcpToolsRequest) ProtoReflect() protoreflect.Message

func (*ListMcpToolsRequest) Reset

func (x *ListMcpToolsRequest) Reset()

func (*ListMcpToolsRequest) String

func (x *ListMcpToolsRequest) String() string

type ListMcpToolsResponse

type ListMcpToolsResponse struct {

	// The list of McpTool
	McpTools []*McpTool `protobuf:"bytes,1,rep,name=mcp_tools,json=mcpTools,proto3" json:"mcp_tools,omitempty"`
	// A token identifying a page of results the server should return.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// Unordered list. Locations that could not be reached.
	Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
	// contains filtered or unexported fields
}

Message for response to listing McpTools

func (*ListMcpToolsResponse) Descriptor deprecated

func (*ListMcpToolsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListMcpToolsResponse.ProtoReflect.Descriptor instead.

func (*ListMcpToolsResponse) GetMcpTools

func (x *ListMcpToolsResponse) GetMcpTools() []*McpTool

func (*ListMcpToolsResponse) GetNextPageToken

func (x *ListMcpToolsResponse) GetNextPageToken() string

func (*ListMcpToolsResponse) GetUnreachable

func (x *ListMcpToolsResponse) GetUnreachable() []string

func (*ListMcpToolsResponse) ProtoMessage

func (*ListMcpToolsResponse) ProtoMessage()

func (*ListMcpToolsResponse) ProtoReflect

func (x *ListMcpToolsResponse) ProtoReflect() protoreflect.Message

func (*ListMcpToolsResponse) Reset

func (x *ListMcpToolsResponse) Reset()

func (*ListMcpToolsResponse) String

func (x *ListMcpToolsResponse) String() string

type McpServer

type McpServer struct {

	// 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
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. A human readable name for the MCP server.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Optional. A human-readable description of the MCP Server's functionality.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// The base URL of the MCP server. Example: [geolocation.googleapis.com/mcp].
	Urls []string `protobuf:"bytes,4,rep,name=urls,proto3" json:"urls,omitempty"`
	// 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.
	Capabilities *structpb.Struct `protobuf:"bytes,6,opt,name=capabilities,proto3" json:"capabilities,omitempty"`
	// Output only. The state of the MCP Server.
	State State `protobuf:"varint,7,opt,name=state,proto3,enum=google.cloud.apiregistry.v1.State" json:"state,omitempty"`
	// contains filtered or unexported fields
}

Represents an MCP Server. MCP Servers act as endpoints that expose a collection of tools that can be invoked by agents.

func (*McpServer) Descriptor deprecated

func (*McpServer) Descriptor() ([]byte, []int)

Deprecated: Use McpServer.ProtoReflect.Descriptor instead.

func (*McpServer) GetCapabilities

func (x *McpServer) GetCapabilities() *structpb.Struct

func (*McpServer) GetDescription

func (x *McpServer) GetDescription() string

func (*McpServer) GetDisplayName

func (x *McpServer) GetDisplayName() string

func (*McpServer) GetName

func (x *McpServer) GetName() string

func (*McpServer) GetState

func (x *McpServer) GetState() State

func (*McpServer) GetUrls

func (x *McpServer) GetUrls() []string

func (*McpServer) ProtoMessage

func (*McpServer) ProtoMessage()

func (*McpServer) ProtoReflect

func (x *McpServer) ProtoReflect() protoreflect.Message

func (*McpServer) Reset

func (x *McpServer) Reset()

func (*McpServer) String

func (x *McpServer) String() string

type McpTool

type McpTool struct {

	// 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 string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. A human-readable name for the tool, suitable for display.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// A human-readable description of the tool's functionality.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Automatically populated reference to MCP Server. Helpful when multiple
	// tools are requested across different MCP Servers.
	McpServerUrls []string `protobuf:"bytes,4,rep,name=mcp_server_urls,json=mcpServerUrls,proto3" json:"mcp_server_urls,omitempty"`
	// A JSON Schema object defining the expected parameters for invoking the
	// tool.
	InputSchema *structpb.Struct `protobuf:"bytes,5,opt,name=input_schema,json=inputSchema,proto3" json:"input_schema,omitempty"`
	// Optional. A JSON Schema object defining the expected structure of the
	// tool's output.
	OutputSchema *structpb.Struct `protobuf:"bytes,6,opt,name=output_schema,json=outputSchema,proto3" json:"output_schema,omitempty"`
	// 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 *structpb.Struct `protobuf:"bytes,7,opt,name=annotations,proto3" json:"annotations,omitempty"`
	// contains filtered or unexported fields
}

Message describing McpTool object

func (*McpTool) Descriptor deprecated

func (*McpTool) Descriptor() ([]byte, []int)

Deprecated: Use McpTool.ProtoReflect.Descriptor instead.

func (*McpTool) GetAnnotations

func (x *McpTool) GetAnnotations() *structpb.Struct

func (*McpTool) GetDescription

func (x *McpTool) GetDescription() string

func (*McpTool) GetDisplayName

func (x *McpTool) GetDisplayName() string

func (*McpTool) GetInputSchema

func (x *McpTool) GetInputSchema() *structpb.Struct

func (*McpTool) GetMcpServerUrls

func (x *McpTool) GetMcpServerUrls() []string

func (*McpTool) GetName

func (x *McpTool) GetName() string

func (*McpTool) GetOutputSchema

func (x *McpTool) GetOutputSchema() *structpb.Struct

func (*McpTool) ProtoMessage

func (*McpTool) ProtoMessage()

func (*McpTool) ProtoReflect

func (x *McpTool) ProtoReflect() protoreflect.Message

func (*McpTool) Reset

func (x *McpTool) Reset()

func (*McpTool) String

func (x *McpTool) String() string

type State

type State int32

The state of McpServer resource.

const (
	// The McpServer state is unspecified.
	State_STATE_UNSPECIFIED State = 0
	// The McpServer is enabled.
	State_ENABLED State = 1
	// The McpServer is disabled.
	State_DISABLED State = 2
)

func (State) Descriptor

func (State) Descriptor() protoreflect.EnumDescriptor

func (State) Enum

func (x State) Enum() *State

func (State) EnumDescriptor deprecated

func (State) EnumDescriptor() ([]byte, []int)

Deprecated: Use State.Descriptor instead.

func (State) Number

func (x State) Number() protoreflect.EnumNumber

func (State) String

func (x State) String() string

func (State) Type

func (State) Type() protoreflect.EnumType

type UnimplementedCloudApiRegistryServer

type UnimplementedCloudApiRegistryServer struct {
}

UnimplementedCloudApiRegistryServer should be embedded to have forward compatible implementations.

func (UnimplementedCloudApiRegistryServer) GetMcpServer

func (UnimplementedCloudApiRegistryServer) GetMcpTool

func (UnimplementedCloudApiRegistryServer) ListMcpServers

func (UnimplementedCloudApiRegistryServer) ListMcpTools

type UnsafeCloudApiRegistryServer

type UnsafeCloudApiRegistryServer interface {
	// contains filtered or unexported methods
}

UnsafeCloudApiRegistryServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to CloudApiRegistryServer will result in compilation errors.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL