pve_firewall_ipset_create

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

With no annotations, the description carries full burden. It discloses mutation, dry-run default (showing PLAN), and passive behavior until referenced. This covers key behavioral traits, though it omits specifics about permissions or reversibility.

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 extremely concise with two short sentences plus a header. Every piece of information is relevant and front-loaded, with no filler.

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 8 parameters and low schema coverage, the description is incomplete. It does not explain any parameters or return values (though output schema exists). The minimal information leaves agents without enough context to invoke correctly.

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 low (13%), yet the description adds no parameter explanations. It only mentions name and scope in the PLAN output but does not describe any of the 8 parameters, failing to compensate for schema gaps.

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 'create an empty IP set' with a specific verb and resource. It also distinguishes from siblings by noting the dry-run default and passive nature until referenced, which is unique among IP set operations.

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 implies usage (creating an empty IP set before adding entries and rules) but does not explicitly state when to use this tool versus alternatives like pve_firewall_ipset_delete or entry_add. No exclusions or alternatives are mentioned.

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