pve_sdn_prefix_list_update

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

No annotations are provided, so the description carries full burden. It discloses that the tool is a MUTATION, dry-runs by default (returns a PLAN), and that confirm=True makes the change. It also notes the risk level and that the mutation is inert until pve_sdn_apply is called.

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 four sentences long, front-loaded with purpose and mutation tag. Every sentence contributes distinct information (purpose, siblings, dry-run behavior, risk scale). No superfluous text.

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 tool's complexity (7 parameters, mutation, dry-run semantics, need for subsequent apply), the description covers purpose, usage alternatives, behavioral details, and safety. The presence of an output schema relieves the need to describe return values.

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 parameters are well-documented in the schema. The description adds value by clarifying the delete field ('only entries is a valid value'), the confirm flag's behavior, and the entries field's replace-vs-merge ambiguity. Not all parameters are elaborated, but the added context is meaningful.

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 uses a specific verb ('update') and resource ('SDN prefix list'), clearly distinguishes from siblings by stating 'To create a new list use pve_sdn_prefix_list_create; to remove one use pve_sdn_prefix_list_delete.' It also notes the PENDING status, which adds precision.

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 create/delete alternatives. It also explains the dry-run default and confirm flag, guiding the agent on invocation strategy. The risk annotation (RISK_LOW) adds further contextual guidance.

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