keycloak_get_realm

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

The annotations already declare readOnlyHint=true, and the description's 'Get' is consistent with that. The description adds useful scope context by enumerating the configuration areas returned, but it does not disclose additional behavioral details such as response shape or potential error conditions; with the annotation covering safety, this is adequate but not rich.

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 with no filler. It immediately states the operation and resource, then uses a colon-delimited list to efficiently convey scope without redundancy.

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?

For a read-only getter with one optional parameter and no output schema, the description provides enough context about what the result covers. It names several key configuration areas, making the tool's purpose clear for selection and invocation, though it does not describe the exact return format.

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?

There is only one parameter, 'realm', and the schema already fully describes it with a clear description and a default behavior. The tool description adds no additional parameter semantics, but the baseline of 3 applies because the schema carries the complete burden.

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 opens with a specific verb and resource: 'Get a realm's full configuration,' and it lists concrete configuration categories such as token lifespans, login/registration settings, password policy, SSO session timeouts, and flow bindings. The word 'full' helps distinguish it from narrower sibling tools like keycloak_get_realm_flow_bindings, though it does not explicitly name that alternative.

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 this tool is the broad getter for an entire realm's configuration, which is useful context when deciding among the many get_* sibling tools. However, it does not explicitly state when to use this tool versus a more specific tool like keycloak_get_realm_flow_bindings or keycloak_get_realm_session_stats, leaving the routing to inference.

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