pve_node_stopall

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

With no annotations, the description carries full burden. It discloses the mutation (MUTATION), high risk (RISK_HIGH, fleet-wide outage), dry-run behavior (returns PLAN), and execution response format. It also notes reversibility and the need for guest restarts.

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 concise: two sentences plus a risk warning. It front-loads the most critical information (mutation, risk) and efficiently covers usage, behavior, and return values. Every sentence adds value.

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 the complexity (4 parameters, high risk, output schema present), the description is complete. It covers dry-run vs. execution, filtering with vms, the node parameter, reversibility, and the response format. The presence of an output schema supports completeness.

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 has 100% coverage, so descriptions exist for all parameters. The tool description adds operational context by explaining the vms filter (limit scope), node default, confirm flag (dry-run vs. execute), and return format. This goes beyond the schema's basic descriptions.

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 clearly states the tool stops ALL (or filtered) running guests on a PVE node. It uses a specific verb and resource, and distinguishes itself from sibling tools like pve_guest_power (for single guests) and pve_node_startall (reversal).

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 explicitly states when to use this tool versus alternatives: 'For a single guest instead of the whole node use pve_guest_power.' It also mentions reversal via pve_node_startall and explains the dry-run default and confirm parameter.

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