pve_sdn_route_maps_list

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

Discloses read-only behavior, cluster scope, and output format (id-only summaries). Also highlights the asymmetric missing pending filter. Without annotations, the description covers key behavioral traits adequately.

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?

Four sentences, each adding value: purpose, scope, notable asymmetry, and creation alternative. No redundancy, front-loaded with key info.

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 output schema exists, description need not detail return values. It effectively covers purpose, scope, behavioral specifics, and usage context for a list tool with two parameters.

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?

Input schema has 100% coverage, so baseline is 3. The description does not add meaning beyond the schema's parameter descriptions; it only notes a missing parameter (pending) which is not in the 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?

The description clearly states it lists SDN route maps, specifies it is read-only, cluster-scoped, and returns id-only summaries. It distinguishes itself from siblings by noting the absence of a pending filter.

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 notes the missing pending filter (unlike other list tools) and directs to pve_sdn_route_map_entry_create for adding entries. Could be improved by mentioning alternatives for pending filtering, but still provides clear guidance.

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