Suspend VM

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

There are no annotations, so the description carries the full behavioral disclosure burden. It does disclose a key trait (state is saved to disk) and a concrete risk (encrypted VMs may not resume via vmrun), but it omits mode semantics, reversibility, and what happens to the VM after suspension beyond the warning.

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?

Two sentences with no filler; the action is stated first and the warning is a meaningful, necessary addition. Every sentence earns its place.

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?

The core purpose and a critical caveat are present, and no parameters are required, so a default invocation is feasible. But mode semantics are unexplained and there is no guidance distinguishing suspend from vm_pause, leaving the definition only 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 description coverage is only 50%: the vm parameter is documented, but mode is just an enum without explanation. The description adds no meaning for soft vs hard modes, so the agent has to guess which mode to use or what the difference is.

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 names a specific operation and resource — suspending a virtual machine — and clarifies the defining behavior: preserving current state to disk. The warning also explicitly positions it against vm_stop, helping distinguish it from power-off and other VM-state-changing 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?

The warning gives an explicit when-not-to-use condition (encrypted VMs) and names vm_stop as the safer alternative, which is strong routing guidance. However, it does not contrast with vm_pause or describe when suspend should be preferred over pause or reset.

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