suspend_vm

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

No annotations are provided, so the description must disclose behavioral traits. It explains the todisk parameter differentiating suspend-to-RAM vs suspend-to-disk, but does not mention reversibility, prerequisites (e.g., VM must be running), or potential side effects. Some transparency is present but incomplete.

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 very concise: two sentences followed by a parameter list. The purpose is front-loaded, and every sentence adds value without redundancy or waste.

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?

For a VM operation with two modes and no annotations, the description is adequate but lacks details on the return value, prerequisites, and when to use each mode. The output schema exists but is not shown; however, the description doesn't reference it. More context would improve 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?

The input schema has 0% description coverage (no parameter descriptions). The description adds explanations for all three parameters: node, vmid, and todisk. While the explanations are minimal (e.g., 'The node name'), they provide meaning beyond the schema titles. This compensates for the missing schema descriptions to a moderate degree.

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 suspends a VM with two modes: pause execution or hibernate to disk. It uses a specific verb ('Suspend') and identifies the resource ('VM'), distinguishing it from sibling tools like shutdown_vm, stop_vm, or reset_vm.

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 explains the two suspension modes (pause vs hibernate) but does not provide explicit guidance on when to use this tool over alternatives like shutdown_vm or stop_vm. No when-to-use or when-not-to-use context is given.

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