pve_sdn_route_map_entries_list_all

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

Declares 'READ-ONLY' upfront, indicating no side effects. With no annotations, this is sufficient disclosure for a read operation. Output schema documents return values, so no further detail needed.

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?

Two concise sentences: first states purpose and read-only nature, second provides usage guidance. No wasted words, excellent structure.

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?

Complete for a listing tool with output schema: covers purpose, scope, alternative, and safety. No gaps given the available structured data.

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 description coverage is 100%, so the description does not need to add parameter semantics. It adds no extra context beyond what the schema provides, earning baseline score of 3.

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 the action ('list'), the resource ('EVERY route-map entry across ALL route-maps'), and distinguishes from the sibling tool that scopes to one route-map id.

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 tells when to use this tool (for all entries) and when to use the sibling (pve_sdn_route_map_entries_list for one route-map id), providing clear alternatives.

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