vm_stop

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

Despite no annotations, the description discloses the destructive nature (hard stop, dirty filesystem), audit trail, and dry-run capability. It does not explicitly mention permission requirements, but the behavioral disclosure is strong.

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, well-structured with a summary paragraph and an Args section. No redundant sentences; every line adds value.

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 no output schema, the description explains the return value (UPID) and effectively differentiates from sibling tools like vm_shutdown. It fully addresses the tool's purpose, usage, and behavior with no gaps.

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?

With 0% schema description coverage, the description adds essential meaning for all four parameters: vmid is numeric, dry_run is for preview, target from config, node auto-located if omitted. This compensates well.

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 tool performs a hard-stop (power off) of a VM and returns the task UPID, distinguishing it from the inverse vm_start and from graceful shutdown via vm_shutdown.

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?

It explicitly notes that this is an immediate power-off, not a graceful shutdown, and warns about possible filesystem issues, guiding the agent on when to use this vs alternative tools. It also mentions the dry_run option for preview.

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