stop_vm

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

Analogizes to pulling power plug, indicating abruptness. No annotations, so description carries full burden; it accurately describes forceful stop but lacks detail on side effects (e.g., potential data loss) or state implications.

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 plus a clean parameter list. Purpose and alternative are front-loaded. Every word serves a purpose, no redundancy.

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 output schema exists, description doesn't need to detail return values. Covers purpose, usage, and parameters sufficiently for a simple action. Lacks error or task reference, but overall complete for scope.

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?

No schema descriptions (0% coverage), so description adds minimal value for each parameter: node and vmid are obvious, timeout explained as 'Wait timeout in seconds' but default behavior unclear, skiplock adds permission context. Adequate but not detailed.

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?

Clearly states 'Hard-stop a VM (like pulling the power plug)' which precisely defines the action. Explicitly distinguishes from shutdown_vm for graceful stop.

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?

Gives clear alternative ('Prefer shutdown_vm for graceful stop') and implies emergency use. Mentions root requirement for skiplock, but could be more explicit about when to use this tool.

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