vm_guest_shutdown

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

With no annotations, the description carries the full burden. It includes a [WRITE][risk=medium] flag and explains that the shutdown is reversible and that dry_run triggers a self-lockout guard without shutting down. This provides good behavioral context beyond a basic description.

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 succinct with a one-line summary and bullet-like parameter explanations. Every sentence adds value; no extraneous content.

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 lack of annotations and output schema, the description covers purpose, parameters, and key behavioral traits (reversible, dry_run). It does not detail return values or error conditions, but for a simple shutdown tool this is adequate.

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?

Description adds significant meaning beyond the schema: it explains vm_ext_id is returned by vm_list, dry_run is a preview that runs the self-lockout guard, and target is optional uses default. This compensates for the 0% schema description coverage.

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 'Graceful in-guest shutdown' and indicates it is reversible via power-on. It uses specific verb+resource and distinguishes from sibling tools like vm_power_off and vm_reboot by noting it is graceful and in-guest.

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 provides usage notes for dry_run and target parameters but does not explicitly state when to use this tool versus alternatives like vm_power_off or vm_reboot. The term 'graceful' implies a soft shutdown but lacks explicit guidance.

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