pve_firewall_ipset_entry_add

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

Discloses mutation nature, dry-run behavior, and the effect on referencing rules. With no annotations provided, this description compensates well by detailing the plan output and side effects.

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?

Concise two sentences, front-loaded with 'MUTATION' label. Efficient but could be slightly better structured with parameter hints.

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?

Missing critical setup information: ipset must exist, scope (cluster/node/VM), required parameters beyond cidr, and the role of 'confirm' parameter. With 10 parameters and no annotations, the description is incomplete for safe and correct invocation.

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?

Only explains 'cidr' and 'nomatch' (exclusion). Does not describe other important parameters like 'name' (ipset name), 'node', 'vmid', 'scope', 'comment', 'confirm', or 'kind'. Schema coverage is only 10%, so description adds insufficient meaning for most parameters.

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 it's a mutation that adds an IP/Network entry to an IP set. Verb 'add' and resource 'IP set entry' are specific, and it distinguishes itself from sibling tools like pve_firewall_ipset_create (create the set) or pve_firewall_ipset_entry_remove (remove an entry).

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?

Mentions dry-run default and nomatch exclusion, providing some guidance, but lacks explicit when-to-use vs alternatives (e.g., when to add vs remove, or prerequisites like ipset existence). Usage is implied but not fully directed.

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