suspend_vm

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

Annotations indicate destructiveHint=false, but the description adds no behavioral details beyond that. It fails to disclose effects like VM state transitions, whether the operation is reversible, or any side effects such as saving memory state.

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 at 3 words, which is efficient but lacks structure to include necessary usage and behavioral information. It is appropriately sized for a purpose statement but insufficient overall.

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, minimal annotations, and a simple input schema, the description should provide more context about the suspended state, prerequisites (e.g., VM must be running), and relationship to resume_vm. It is incomplete for an agent to use confidently.

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 coverage is 100% with descriptions for both parameters (node and vmid). The description adds no additional semantic value beyond what the schema already provides, meeting the baseline.

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 'Suspend a VM' clearly states the action (suspend) and resource (VM). Among sibling tools with similar VM operations like start_vm, stop_vm, shutdown_vm, reset_vm, resume_vm, the purpose is distinct and unambiguous.

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 vs other VM state-changing tools (e.g., stop, shutdown, reset). No prerequisites or context for invocation are provided, leaving the agent without decision support.

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