upgrade_packages

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

Addes behavioral context beyond annotations: omitting packages upgrades all, and dry run is implied. The destructiveHint annotation is confirmed, and description provides additional constraints.

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?

Two concise sentences with front-loaded purpose. Every phrase adds value, no fluff.

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?

Despite having an output schema, the description is too brief for a destructive 5-parameter tool. Missing explanations for query matching, confirm token, and wait timeout reduce completeness.

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?

Only two of five parameters (packages and wait) are explained. Critical parameters like query, wait_timeout, confirm_token are ignored, and schema descriptions are absent. This leaves significant gaps.

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 clearly states the verb 'Upgrade' and resource 'packages on matched machines', and distinguishes from sibling tools like install_packages and remove_packages.

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?

Describes a workflow instruction ('Dry run first') and a polling option ('Set wait=true to poll to completion'). However, it does not explicitly compare with alternatives or state when not to use.

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