vm_suspend

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

With no annotations, the description carries the full burden of behavioral disclosure. 'Suspend the VM to disk' does reveal that the VM's state is persisted to disk, which is useful, but it does not mention side effects like pausing execution, whether the operation is reversible, or whether it requires a subsequent vm_resume to restore operation.

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 a single five-word sentence with no filler. It front-loads the action and the persistence detail, making it easy to parse and scan.

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 one-parameter lifecycle tool, the description is minimally adequate: it names the operation and the persistence behavior, and the schema supplies the parameter meaning. However, with no annotations, no output schema, and no mention of postconditions or consequences, it leaves some gaps that an agent must infer from the tool name and siblings.

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 already documents the only parameter, 'vm', as a name registered in vms.yaml, giving 100% schema description coverage. The tool description adds no extra parameter-level meaning, such as whether the VM must be in a particular state, so the baseline score of 3 applies.

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 action ('Suspend') and the target ('the VM'), and 'to disk' adds meaningful specificity about persistence. It does not explicitly differentiate from vm_stop or vm_reboot by naming them, but 'suspend' is a well-defined lifecycle verb that separates it from those siblings.

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?

There is no guidance about when to use this tool versus alternatives like vm_stop, vm_reboot, or vm_resume. The description also omits prerequisites, such as whether the VM must currently be running, so an agent has to infer the proper usage context.

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