MCPResource

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

• Kind: MCPResource
• API Group: kubemcp.io
• Version: v1alpha1
• apiVersion: kubemcp.io/v1alpha1
• Reference Slug: /reference/mcpresource/

Schema

Root

Field	Type	Required	Description	Default
spec	unknown | unknown	Yes	—	—
status	object	No	—	—

spec

Field	Type	Required	Description	Default
name	string	Yes	MCP resource name (must be unique within server)	—
description	string	No	Human-readable description of the resource	—
operations	array<object>	No	HTTP operations for service-backed resources	—
content	object	No	Inline content for simple static resources	—

spec.operations[]

Field	Type	Required	Description	Default
method	string ("GET", "POST", "PUT", "DELETE", "PATCH")	Yes	HTTP method for this operation	—
ingressPath	string	Yes	Ingress path with optional {param} placeholders	—
service	object	Yes	—	—
parameters	array<object>	No	Parameters for this operation	—

spec.operations[].service

Field	Type	Required	Description	Default
name	string	Yes	Kubernetes service name	—
namespace	string	No	Service namespace (defaults to same as MCPResource)	—
port	integer	Yes	Service port number	—
path	string	Yes	Service path with optional {param} placeholders	—

spec.operations[].parameters[]

Field	Type	Required	Description	Default
name	string	Yes	Parameter name	—
in	string ("path", "query", "header")	Yes	Parameter location	—
required	boolean	No	Whether parameter is required	false
description	string	No	Parameter description	—

spec.content

Inline content for simple static resources

Field	Type	Required	Description	Default
uri	string	No	Resource URI identifier	—
mimeType	string	No	MIME type of the content	”text/plain”
text	string	No	Text content of the resource	—
blob	string [byte]	No	Base64-encoded binary content	—

status

Field	Type	Required	Description	Default
ready	boolean	No	Whether resource is ready for use	—
operationCount	integer	No	Number of operations configured	—
lastSyncTime	string [date-time]	No	Last time resource was synced	—
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 MCPResource - inline configuration
apiVersion: kubemcp.io/v1alpha1
kind: MCPResource
metadata:
  name: sample-config
  namespace: mcp-test
  labels:
    mcp-server: echo
spec:
  name: sample-config
  description: Sample configuration resource
  content:
    uri: "config://sample/settings"
    mimeType: "application/json"
    text: |
      {
        "debug": true,
        "log_level": "info",
        "features": {
          "echo": true,
          "calculator": true
        }
      }

Condition reference

Condition	Reason	Status	Description
Ready	ContentValid	True	Inline spec.content validated successfully
Ready	OperationsValid	True	All spec.operations validated and service endpoints resolved
Ready	InvalidSpec	False	Neither spec.operations nor spec.content is defined
Ready	EmptyContent	False	spec.content has neither text nor blob
Ready	ServiceNotFound	False	A Service referenced in spec.operations does not exist in the namespace

See the Observability guide for diagnostic patterns using these conditions.