k8s_describe

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description fully carries the burden of behavioral disclosure. It clearly states the tool is read-only, idempotent, runs kubectl describe, never mutates the cluster, requires read access, and raises on kubectl failure (e.g., NotFound, Forbidden). It also notes the output is truncated text (~30 KB).

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise and well-structured. The first two lines state purpose and key characteristics, followed by a bullet list of arguments. Every sentence adds value, with no redundancy or unnecessary detail.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (4 parameters, output schema exists, sibling tools present), the description is complete. It covers when to use, behavioral traits, parameter semantics, and output format. No gaps are evident.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so baseline is 3. The description adds value beyond schema by explaining the kind parameter is the same set as k8s_get, the name is required with no glob/partial matching, and context/namespace can be omitted for current context or cluster-scoped kinds. This provides helpful usage context.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

Description begins with a clear statement of purpose: 'Describe a single K8s resource (text output from kubectl describe).' It then notes it is read-only and idempotent, distinguishing it from mutation tools. The sibling tools include k8s_get, and the description explicitly says 'Use when k8s_get isn't enough,' providing clear differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly states when to use this tool: 'Use when k8s_get isn't enough — describe shows events, conditions, container details, volume mounts, image pull state, etc.' It also notes it requires read access and raises on failure, guiding the agent on preconditions and errors.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.