explain_resource
Read-only
Retrieve documentation for a Kubernetes resource or field by specifying the name or field path, with optional API version and recursive field details.
Instructions
Get documentation for a Kubernetes resource or field
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| resource | Yes | Resource name or field path (e.g. 'pods' or 'pods.spec.containers') | |
| apiVersion | No | API version to use (e.g. 'apps/v1') | |
| recursive | No | Print the fields of fields recursively | |
| context | No | Kubeconfig Context to use for the command (optional - defaults to null) | |
| output | No | Output format (plaintext or plaintext-openapiv2) | plaintext |
Implementation Reference
- src/models/kubectl-models.ts:12-18 (helper)TypeScript interface for ExplainResourceParams. Defines the shape of parameters accepted by explainResource handler: resource (required string), apiVersion (optional string), recursive (optional boolean), output (optional 'plaintext'|'plaintext-openapiv2'), context (optional string).
export interface ExplainResourceParams { resource: string; apiVersion?: string; recursive?: boolean; output?: "plaintext" | "plaintext-openapiv2"; context?: string; }