Assign a realm role to a group

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

The description reveals the inheritance behavior (members inherit the role) beyond the annotations, which only indicate idempotence. No contradictions with annotations; the write nature (grant) aligns with readOnlyHint=false.

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, front-loaded sentence of 11 words that efficiently conveys the essential action and inheritance side-effect.

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 simple two-parameter tool and the presence of annotations, the description covers the core action and inheritance but omits prerequisites, return behavior, and that it handles only realm roles (not client roles). Adequate but not thorough.

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 description does not explain what groupId and role represent despite 0% schema description coverage. The agent must infer from parameter names, but no details like role type (realm vs. client) or group identification are given.

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: 'Grant a realm role to a group' and adds the key detail 'inherited by its members,' which distinguishes it from sibling tools like keycloak_user_role_assign (for users) or keycloak_group_member_add (adds 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?

The description implies usage context (assigning a realm role to a group) but does not explicitly state when to use this tool versus alternatives like keycloak_user_role_assign for users. No when-not-to-use or prerequisite information is provided.

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