Skip to main content
Glama

skycloak_update_realm_role

Idempotent

Rename a Keycloak realm role or change its description within a specified Skycloak cluster and realm.

Instructions

Rename a realm role or change its description.

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": "<name>"
    },
    "name": "skycloak_update_realm_role"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesthe current role name
realmYesthe Keycloak realm name
new_nameNorename the role to this
cluster_idYesthe cluster ID
descriptionNonew description

Output Schema

NameRequiredDescriptionDefault
nameYes
compositeYes
descriptionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true, and destructiveHint=false, so safety and repeatability are covered structurally. The description adds genuine scope information by enumerating the only two mutable fields (name, description), implying other role attributes are untouched, but says nothing about failure behavior for a missing role or whether specifying only new_name preserves the existing description.

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?

One short sentence that front-loads the two supported operations with no filler or repetition of the title. It is arguably over-terse for a five-parameter mutation, but nothing is wasted.

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?

An output schema and full annotation set reduce what the description must carry, and it correctly delimits the mutable surface. Still, for a five-parameter mutation with three required identifiers (cluster_id, realm, name), the description provides no context on lookup failures, partial updates, or role hierarchy implications, leaving it only minimally adequate.

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 each of the five parameters is already documented, including that 'name' is the current role name and 'new_name' the target. The description restates the same intent at tool level without adding syntax or constraint detail (e.g., whether the two optional fields can be combined), so 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 pair (rename / change description) and a specific resource (realm role), so an agent knows this mutates an existing role's name or description rather than creating, deleting, or assigning one. It stops short of explicitly contrasting with the near-identical sibling skycloak_update_application_role, so the realm-vs-application distinction has to be inferred from the tool name.

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

Usage Guidelines3/5

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

Usage is implied by the stated capability: call this to rename a realm role or edit its description. There is no explicit when-to-use/when-not guidance, no prerequisite statements (role must already exist), and no pointer to skycloak_create_realm_role or skycloak_update_application_role as alternatives for the adjacent cases.

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