pbs_node_network_revert

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

With no annotations, description fully covers mutation type, low severity, safety, dry-run behavior, execution effect (DELETE endpoint), return format, and config requirement.

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?

3-4 sentences with no fluff. Front-loads key info: mutation, safety, dry-run, execution. Every sentence earns its place.

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?

Covers purpose, behavior, parameters, prerequisites, and return format. Output schema exists, so return values explained. Complete for a revert tool.

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%, so baseline 3. Description adds meaning for 'confirm' (dry-run vs execute) and notes the DELETE endpoint. Adds value beyond schema.

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 verb 'discard' and resource 'staged network configuration changes on a PBS node', distinguishing from siblings like pbs_node_network_reload and pbs_node_network_iface_*. Includes scope and safety note.

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?

Explicitly describes dry-run default and confirm=True execution. Implies usage for reverting staged changes, but lacks explicit when-not-to-use or alternative tools. Sibling context helps.

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