helm_diff

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

No annotations are provided, so the description must convey behavioral traits. It states 'Preview' but does not disclose prerequisites (e.g., cluster access), side effects, or output format. Returns nothing about whether changes are shown as diff or summary.

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 a single concise phrase with no wasted words. It is front-loaded and clear, though it could benefit from a sentence structure.

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?

As a preview tool with no output schema, the description is too minimal. It does not explain what the preview shows, how to use the result, or any limitations. Sibling tools like terraform_plan typically provide more context.

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?

The input schema provides 100% description coverage for all 4 parameters. The description does not add additional meaning beyond the schema, so it meets the baseline of 3.

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?

The description 'Preview Helm upgrade changes' uses a specific verb 'Preview' and clearly identifies the resource as 'Helm upgrade changes'. It distinguishes this tool from siblings like helm_list (which lists releases) and terraform_plan (which plans Terraform changes).

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 implies usage before a Helm upgrade but does not provide explicit guidance on when to use or alternatives. It lacks context compared to siblings like terraform_plan, which often have more detailed usage instructions.

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