sr_list

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

Despite no annotations, the description discloses return format including pagination behavior (truncated field) and the list of fields. It confirms it's a read operation. Does not mention auth or rate limits, but low risk for a read-only listing.

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, front-loaded with purpose, then returns format, then parameter details. No extraneous text. Every sentence adds value.

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 no output schema, description covers return structure and pagination. Parameters fully explained. Could add more context about pool filter behavior, but sufficient for a listing tool.

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?

With 0% schema coverage, the description explains all three parameters: pool (optional uuid filter), limit (default 200), target (optional XO target). Adds meaning beyond schema which only specifies types and defaults.

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?

Description explicitly states it's a read operation for listing SRs with specific attributes (capacity, physical usage, virtual allocation). It clearly distinguishes from sibling tools like sr_get (individual SR) and sr_usage_rca (usage explanation).

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?

Description implies it's for listing multiple SRs and provides optional filters, but does not explicitly state when to use this tool vs alternatives like sr_get or vdi_list. No guidance on prerequisites or limitations.

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