resume_vm

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

Annotations already declare destructiveHint: false, so the description does not need to restate that. However, it does not add behavioral details beyond the basic action, such as whether the VM must be in a specific state, required permissions, or potential side effects. For a simple operation, the description is adequate but not enriched.

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 sentence with no redundancy or unnecessary words. Every word is essential, making it efficient and easy to parse.

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 simple action with no output schema and straightforward parameters, the description is adequate. It tells the agent exactly what the tool does. However, it could be more complete by noting that the VM must be currently suspended, but this is implied by the verb 'resume'.

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 covers 100% of the two parameters (node and vmid) with clear descriptions. The tool description does not add extra meaning beyond what the schema provides, which is acceptable given the high coverage.

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 'Resume a suspended VM' uses a specific verb and resource, clearly indicating the action and target. It naturally distinguishes this tool from siblings like 'suspend_vm', 'start_vm', 'stop_vm', etc., as it specifically addresses resuming a VM that is in suspended state.

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 implies usage when a VM is suspended, but it does not explicitly state when to use this tool versus alternatives like 'start_vm' for stopped VMs, or any prerequisites (e.g., VM must be suspended, not running). No exclusions or contextual pointers are provided.

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