add_client_realm_scope_mappings

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

With no annotations, the description should disclose behavioral traits like idempotency, permissions, or effects. It only states the basic action, leaving the agent unaware of important behaviors such as whether existing mappings are overwritten.

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 a single concise sentence that front-loads the action. No wasted words, but it may be too brief, sacrificing clarity for brevity.

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 complexity (3 params including a nested object, no output schema), the description is insufficient. It does not explain what 'realm-level roles' means, how to structure the roles object, or what the response indicates. Falls short of providing a complete picture.

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 descriptions exist for all parameters, but the 'roles' parameter is described vaguely as 'List of role representations'. The description adds no further meaning about the expected structure or content, which is a gap since schema coverage is high but not sufficiently clear on the nested object.

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 action (add) and the resource (realm-level roles to a client's scope). It distinguishes from siblings like add_client_default_scope which adds scopes, not roles. However, 'realm-level roles' is a bit vague without context.

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 guidance is provided on when to use this tool vs alternatives such as add_client_default_scope or add_client_role_composites. There is no mention of prerequisites or when not to use it.

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