List roles

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

With no annotations, the description carries the burden. It discloses the scope (basic list only) and explicitly points to another tool for deeper data, implying a read-only operation. This provides useful behavioral context beyond a simple listing statement.

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 sentences convey the purpose and a navigation hint with no redundant words. The description is front-loaded with the core function and keeps the alternative instruction brief.

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?

The tool lacks annotations and output schema, and the description fails to explain the two parameters. While the return fields are stated, the absence of parameter semantics makes correct invocation for anything beyond a default listing unclear.

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?

The schema defines two parameters (search, organization) with no descriptions and 0% coverage. The description offers no explanation of these parameters, leaving the agent to guess their purpose and formatting.

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 tool lists roles in an organization, including id, name, and description. It distinguishes itself from sibling tools by pointing to wflow_request for one role's rights & members.

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 instructs to use wflow_request GET roles/{id} to get one role's rights & members, providing clear guidance on when this tool is insufficient and directing to an alternative.

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