Skip to main content
Glama

skycloak_get_realm

Read-only

Retrieve a Keycloak realm by name within a specified cluster. Use it to look up realm configuration details and confirm a realm exists before managing its settings.

Instructions

Get a realm by name.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "cluster_id": "<cluster_id>",
      "realm": "<realm>"
    },
    "name": "skycloak_get_realm"
  }
}

Input Schema

NameRequiredDescriptionDefault
realmYesthe Keycloak realm name
cluster_idYesthe cluster ID

Output Schema

NameRequiredDescriptionDefault
idNo
nameYes
enabledYes
display_nameNo
ssl_requiredNo
registration_allowedYes
default_branding_appliedNo
duplicate_emails_allowedYes
login_with_email_allowedYes
registration_email_as_usernameYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.7/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered structurally; the description adds nothing beyond that. It doesn't say what is returned on a missing realm, whether the lookup is cluster-scoped, or why the required cluster_id matters, which is notable given idempotentHint=false on an ostensibly read-only operation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single short sentence with no wasted words and the verb front-loaded. It is efficient, though the brevity comes at the cost of almost no substantive content.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The presence of an output schema means return values needn't be explained, and it is a simple two-parameter read. Still, the description should clarify the cluster-scoping prerequisite and the not-found behavior for an agent to call it reliably.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so both parameters are already documented in the schema, warranting the baseline 3. "By name" weakly reinforces the realm parameter but the description ignores the equally required cluster_id, adding no meaning beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a verb ("Get") and resource ("realm"), so the basic operation is clear, but it largely restates the tool name and title "Get realm". It offers no differentiation from the many realm-scoped siblings (get_realm_export, get_realm_group, etc.), and "by name" is the only detail not already in the name.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no guidance on when to use this tool versus alternatives, and none of the realm-scoped siblings are mentioned. The only implied usage is reading a single realm, which an agent must infer from the name alone.

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

Deploy Server

Other Tools