list_quick_roles

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

With no annotations provided, the description carries the behavioral disclosure burden. The verbs 'Lists' and 'shows' clearly imply a read-only operation, and the mention of providing indices indicates the tool surfaces data meant for the save_quick_roles workflow. However, it does not explicitly state there are no side effects, nor does it describe the output format or pagination if any.

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, each earning its place. The first sentence states the tool's output, and the second explains the workflow. No filler or repetition of schema information.

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 description is adequate for a parameterless, read-only list tool. It explains what will be shown and what the caller should do with the results. The only gap is not clarifying the difference from the similarly named list_eligible_roles sibling, which could lead an agent to pick the wrong 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?

The tool has zero parameters, so the schema leaves nothing ambiguous. The description adds relevant context about what the returned indices are used for (selecting quick roles), but with no parameters to document, the baseline of 4 is appropriate.

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 all eligible PIM roles with indices and shows your currently saved quick roles' – a specific verb and resource. It differentiates itself by mentioning both eligible roles and saved quick roles, but the existence of sibling list_eligible_roles creates some ambiguity about the exact boundary between the two tools.

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 gives explicit workflow guidance: 'Use this to see available roles, then call save_quick_roles with your selected indices to update your favorites.' This tells the agent when to invoke the tool and what to do next. However, it does not explicitly state when not to use it or how it compares to other siblings like list_eligible_roles or activate_quick_roles.

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