Skip to main content
Glama

skycloak_update_realm

Idempotent

Update a Keycloak realm's display name and enabled status to rename it or control whether users can sign in; requires a cluster ID and realm name.

Instructions

Update a realm's display name and enabled state.

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_update_realm"
  }
}

Input Schema

NameRequiredDescriptionDefault
realmYesthe Keycloak realm name
enabledNowhether users can sign in to the realm
cluster_idYesthe cluster ID
display_nameNonew display name

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

B3.3/5.0
Behavior3/5

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

Annotations already declare the safety profile (not read-only, idempotent, non-destructive, closed-world), so the description's burden is lighter. The one piece of added value is the scoping claim that only display name and enabled state are mutable, which constrains the agent's expectations. It says nothing about whether omitted fields are left unchanged, what happens to active sessions when enabled is flipped, or what permissions are required.

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

Conciseness5/5

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

A single nine-word sentence with the resource and the mutable fields front-loaded and no filler. Nothing is wasted and the key constraint arrives first.

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?

For a low-complexity tool with full schema coverage, an output schema, and complete annotations, the description is close to sufficient. However, it omits partial-update semantics (whether supplying only display_name leaves enabled untouched) and any permission or side-effect context for toggling the enabled flag, which are the remaining questions an agent would have before calling it.

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 the schema already documents all four parameters, including the meaning of enabled ('whether users can sign in to the realm'). The description merely restates the two optional fields without adding format, default, or partial-update semantics, so the baseline 3 applies.

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

Purpose4/5

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

The description names a specific verb (update) and resource (realm) and enumerates the two mutable fields, display name and enabled state, which separates it from the realm_group/role/user update siblings. It does not explicitly reference those siblings, so it falls short of the 5 bar.

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 when-to-use guidance, no mention of prerequisites or permissions, and no routing to alternatives such as skycloak_create_realm or skycloak_delete_realm. The agent must infer the usage context entirely from the tool name and schema.

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