suspend_vm

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

No annotations exist, so the description must fully disclose behavior. It only states 'Suspend a VM to disk' with no mention of VM state requirements, operation duration, side effects (e.g., VM becomes unavailable), or reversibility via resume_vm. This is insufficient for safe agent use.

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?

Extremely concise (5 words) but dangerously under-specified. Conciseness requires effective communication, not just brevity. Critical operational context is missing.

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?

Despite low complexity (1 param, no output schema), the description omits important context like required VM state (e.g., must be running), output (e.g., no return value), and interaction with sibling tools like resume_vm. Not complete for reliable agent use.

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?

Input schema has 100% coverage with a clear parameter description. The tool description adds no additional meaning beyond the schema, so baseline 3 applies. No extra details like format or constraints are provided.

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 uses the verb 'suspend' and resource 'VM', with 'to disk' specifying the mechanism. It clearly indicates the action but does not differentiate from similar tools like pause_vm or stop_vm, which could confuse the agent on which to use.

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?

No guidance on when to use suspend_vm instead of pause_vm, stop_vm, or force_stop_vm. No prerequisites or context provided for correct invocation.

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