MCPServer

This page is auto-generated by scripts/generate-schema-docs.ts. Do not edit manually.

Kind: MCPServer
API Group: kubemcp.io
Version: v1alpha1
apiVersion: kubemcp.io/v1alpha1
Reference Slug: /reference/mcpserver/

Schema

Root

Field	Type	Required	Description	Default
`spec`	`object`	Yes	—	—
`status`	`object`	No	—	—

spec

Field	Type	Required	Description	Default
`replicas`	`integer`	No	Number of MCP server replicas	1
`image`	`string`	No	Image for the MCP server container	”ghcr.io/atippey/mcp-echo-server:latest”
`command`	`array<string>`	No	Override the container entrypoint	—
`args`	`array<string>`	No	Arguments passed to the container entrypoint	—
`env`	`array<unknown \| unknown>`	No	Additional environment variables for the container	—
`redis`	`object`	Yes	—	—
`ingress`	`object`	No	—	—
`toolSelector`	`object`	Yes	Label selector for MCPTool, MCPPrompt, and MCPResource objects	—
`config`	`object`	No	—	—

spec.env[]

Field	Type	Required	Description	Default
`name`	`string`	Yes	—	—
`value`	`string`	No	—	—
`valueFrom`	`object`	No	—	—

spec.redis

Field	Type	Required	Description	Default
`serviceName`	`string`	Yes	Name of the Redis service for state storage	—

spec.ingress

Field	Type	Required	Description	Default
`host`	`string`	No	Ingress hostname	—
`tlsSecretName`	`string`	No	TLS secret name for HTTPS	—
`pathPrefix`	`string`	No	Base path prefix for all MCP endpoints	”/mcp”

spec.toolSelector

Label selector for MCPTool, MCPPrompt, and MCPResource objects

Field	Type	Required	Description	Default
`matchLabels`	`map<string, string>`	No	—	—
`matchExpressions`	`array<object>`	No	—	—

spec.toolSelector.matchExpressions[]

Field	Type	Required	Description	Default
`key`	`string`	Yes	—	—
`operator`	`string ("In", "NotIn", "Exists", "DoesNotExist")`	Yes	—	—
`values`	`array<string>`	No	—	—

spec.config

Field	Type	Required	Description	Default
`requestTimeout`	`string`	No	Request timeout duration	”30s”
`maxConcurrentRequests`	`integer`	No	Maximum concurrent requests per replica	100

status

Field	Type	Required	Description	Default
`readyReplicas`	`integer`	No	Number of ready replicas	—
`toolCount`	`integer`	No	Number of registered tools	—
`promptCount`	`integer`	No	Number of registered prompts	—
`resourceCount`	`integer`	No	Number of registered resources	—
`conditions`	`array<object>`	No	—	—

status.conditions[]

Field	Type	Required	Description	Default
`type`	`string`	Yes	—	—
`status`	`string ("True", "False", "Unknown")`	Yes	—	—
`lastTransitionTime`	`string [date-time]`	No	—	—
`reason`	`string`	No	—	—
`message`	`string`	No	—	—

Example

# Example MCP resources for testing
# All resources use the label "mcp-server: echo" to be selected by the MCPServer
---
apiVersion: kubemcp.io/v1alpha1
kind: MCPServer
metadata:
  name: echo
  namespace: mcp-test
spec:
  replicas: 1
  redis:
    serviceName: mcp-redis
  toolSelector:
    matchLabels:
      mcp-server: echo

Condition reference

The operator sets three conditions on every MCPServer during reconciliation.

Condition	Reason (True)	Reason (False)	Description
`ToolsDiscovered`	`ResourcesFound`	`NoResourcesFound`	At least one MCPTool, MCPPrompt, or MCPResource matched `spec.toolSelector`
`ConfigReady`	`ConfigMapCreated`	—	The generated ConfigMap containing tool/prompt/resource config was written successfully
`Ready`	`DeploymentReady`	`DeploymentNotReady`	The MCPServer Deployment has at least one ready replica

See the Observability guide for diagnostic patterns using these conditions.

Generated resources

For each MCPServer the operator creates the following resources (all named mcp-server-{name}-* and owned by the MCPServer for automatic cleanup):

Resource	Name	Notes
Deployment	`mcp-server-{name}`	Runs `spec.image` on port 8080
Service	`mcp-server-{name}`	ClusterIP on port 8080, named `http`
ConfigMap	`mcp-server-{name}-config`	Mounted read-only at `/etc/mcp/config` with `tools.json`, `prompts.json`, `resources.json`
NetworkPolicy	`mcp-server-{name}-egress`	Auto-generated egress to Redis, DNS, and discovered tool/resource services
Ingress	`mcp-server-{name}`	Only when `spec.ingress` is configured

The operator always injects two environment variables into the container before any user-provided spec.env entries:

Variable	Value
`REDIS_HOST`	`spec.redis.serviceName`
`MCP_CONFIG_DIR`	`/etc/mcp/config`

Note: spec.config.requestTimeout and spec.config.maxConcurrentRequests are accepted by the CRD schema but are not yet consumed by the operator. They are reserved for a future release.