MCPRemoteServer

MCPRemoteServer is the Schema for the mcpremoteservers API. It defines an MCP server accessible via HTTP or SSE at a remote URL.

Spec

FieldDescriptionDefaultValidation
apiVersion stringmcp-gateway.ohcs.io/v1alpha1
kind stringMCPRemoteServer
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec MCPRemoteServerSpecspec defines the desired state of MCPRemoteServer.Required
status MCPRemoteServerStatusstatus defines the observed state of MCPRemoteServer.

MCPRemoteServerSpec

FieldDescriptionDefaultValidation
gatewayRef GatewayRefgatewayRef references the MCPGateway that will route traffic to this server.Required
path stringpath is the URL path on the gateway domain for this MCP server. Defaults to “/<name>” if not specified.
url stringurl is the upstream URL of the remote MCP server.Pattern: ^https?://.*$, Required
transport Transporttransport specifies the transport protocol to use when communicating with the upstream.sseEnum: [http sse]
headers Header arrayheaders specifies headers to include in requests to the upstream server. Each header can have a static value or reference a secret.

MCPRemoteServerStatus

FieldDescriptionDefaultValidation
phase stringphase represents the current phase of the MCPRemoteServer.
conditions Condition arrayconditions represent the current state of the MCPRemoteServer resource.
endpoint stringendpoint is the full URL where this MCP server is accessible via the gateway (e.g., “https://mcp.example.com/cloudflare").
ready booleanready indicates whether the server is configured and ready to receive traffic.
gatewayName stringgatewayName is the name of the MCPGateway this server is attached to.

Supporting Types

GatewayRef

GatewayRef references an MCPGateway resource in the same namespace. Cross-namespace gateway references are not supported for security reasons.

FieldDescriptionDefaultValidation
name stringname is the name of the MCPGateway resource in the same namespace.MinLength: 1, Required

Header defines a header to include in requests to the upstream server. Similar to corev1.EnvVar, it supports both static values and values from secrets.

FieldDescriptionDefaultValidation
name stringname is the header name.MinLength: 1, Required
value stringvalue is the static header value.
valueFrom HeaderValueSourcevalueFrom specifies a source for the header value.

HeaderValueSource

HeaderValueSource defines a source for obtaining header values.

FieldDescriptionDefaultValidation
secretKeyRef SecretKeySelectorsecretKeyRef references a key in a Secret.

Transport

Transport defines the transport protocol for MCP communication.

FieldDescription
httpTransportHTTP uses HTTP for MCP communication.
sseTransportSSE uses Server-Sent Events for MCP communication.