This page is auto-generated by scripts/generate-schema-docs.ts. Do not edit manually.
- Kind:
MCPTool
- API Group:
kubemcp.io
- Version:
v1alpha1
- apiVersion:
kubemcp.io/v1alpha1
- Reference Slug:
/reference/mcptool/
| Field | Type | Required | Description | Default |
|---|
spec | unknown | unknown | Yes | — | — |
status | object | No | — | — |
| Field | Type | Required | Description | Default |
|---|
name | string | No | MCP tool name (must be unique within server) | — |
description | string | No | Human-readable description of the tool | — |
service | object | Yes | — | — |
inputSchema | object | No | JSON Schema for tool input validation | — |
method | string ("GET", "POST", "PUT", "DELETE", "PATCH") | No | HTTP method for tool invocation | ”POST” |
ingressPath | string | No | Optional path to expose tool via ingress | — |
tools | array<object> | No | Multiple tool definitions sharing this service. Use instead of single-tool name/inputSchema fields. | — |
| Field | Type | Required | Description | Default |
|---|
name | string | Yes | Kubernetes service name | — |
namespace | string | No | Service namespace (defaults to same as MCPTool) | — |
port | integer | Yes | Service port number | — |
path | string | No | HTTP path for tool endpoint | ”/“ |
| Field | Type | Required | Description | Default |
|---|
name | string | Yes | MCP tool name (must be unique within server) | — |
path | string | Yes | HTTP path for this tool endpoint | — |
description | string | No | Human-readable description of the tool | — |
inputSchema | object | No | JSON Schema for tool input validation | — |
method | string ("GET", "POST", "PUT", "DELETE", "PATCH") | No | HTTP method for tool invocation | ”POST” |
| Field | Type | Required | Description | Default |
|---|
ready | boolean | No | Whether tool is ready for use | — |
resolvedEndpoint | string | No | Fully resolved endpoint URL | — |
lastSyncTime | string [date-time] | No | Last time tool was synced | — |
conditions | array<object> | No | — | — |
| 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 MCPTool - points to the echo-backend service
apiVersion: kubemcp.io/v1alpha1
description: Echoes back the input for testing
description: Message to echo back
| Condition | Reason | Status | Description |
|---|
Ready | ServiceResolved | True | Named Service found; status.resolvedEndpoint contains the full URL |
Ready | ServiceNotFound | False | Named Service does not exist in the namespace |
See the Observability guide for diagnostic patterns using these conditions.