vm_shutdown

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

No annotations provided, so description carries full burden. It discloses graceful shutdown behavior and dry_run option, but does not detail side effects like whether the VM fully powers off or remains in a stop state. Adequate but not thorough.

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?

Front-loaded with key purpose and distinction. The Args section lists parameters efficiently, though it lengthens the description. Good structure but could be slightly more terse.

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?

Covers core function and parameter usage. Lacks details on expected output or behavior when VM is already off, but given no output schema and sibling tools, it is minimally complete.

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 0%, so description must compensate. It explains each parameter's meaning (vmid as numeric ID, dry_run as preview, target as config name, node as auto-locatable). Adds value beyond the schema types.

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 it performs a graceful ACPI shutdown, distinguishes from 'hard vm_stop', and notes the inverse operation 'vm_start'. The purpose is specific and easily understood.

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?

Provides comparative guidance against vm_stop and mentions dry_run for testing. Could be more explicit about when not to use (e.g., for emergency stops), but the sibling reference gives clear context.

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