list_realm_roles

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

No annotations are provided, so the description must disclose behavior. It states 'List all realm roles' and describes parameters, but does not mention permissions, safety, error cases, or pagination behavior beyond the parameter names. This is adequate for a simple read operation but lacks depth.

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 concise: a single line for purpose, a parameter list, and a returns statement. No redundant text, and the key action is front-loaded. Every sentence earns its place.

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 4 parameters and no annotations, the description covers basic usage but misses context: it doesn't clarify whether 'all realm roles' is per-realm or across realms (despite the realm parameter), and lacks mentions of prerequisites, error cases, or default behavior for omitted parameters. The presence of an output schema partially offsets the need for return value details.

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 0%, so the description compensates by explaining each parameter: 'first: Pagination offset', 'max: Maximum results size', 'search: Search string', 'realm: Target realm (uses default if not specified)'. This adds meaningful context beyond the schema's minimal type info.

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 'List all realm roles,' providing a specific verb and resource. This distinguishes it from sibling tools like get_realm_role (single role) and create/update/delete_realm_role.

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 implies usage for listing all roles, but lacks explicit guidance on when to use this tool versus alternatives like list_client_roles or get_realm_role. No exclusions or context for search/pagination are provided.

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