getRoles

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

With no annotations, the description carries the full burden, but it only says 'List roles'. It does not disclose output format, pagination, sorting, or whether roles are returned in a specific format (despite the required 'format' parameter). The read-only nature is implied but not explicit.

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?

The description is extremely terse, consisting only of 'List roles'. While it is front-loaded and free of filler, it is under-specified to the point of being a fragment, offering no structural guidance or additional context.

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 the required format parameter and the presence of a similar getRole tool, the description is incomplete. It fails to explain the purpose of the format parameter, the response structure, or how this tool differs from others in the same domain.

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 has 0% description coverage and the description does not compensate. The required 'pathParams.format' parameter is not mentioned at all, leaving the agent to infer its meaning from the enum values 'json' and 'xml', which is not aided by the tool description.

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 'List roles' uses a specific verb and resource, clearly indicating a read operation to retrieve roles. However, it does not explicitly distinguish from the sibling tool 'getRole', which retrieves a single role, or mention whether this returns all roles.

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?

No usage guidance is provided. The description does not explain when to use this tool versus alternatives like 'getRole', nor does it mention any filtering or condition for listing roles.

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