keycloak-mcp-server

update-role-by-id

Update an existing Keycloak role by its unique role ID and realm, enabling changes to name, description, attributes, and role flags.

Instructions

Update role by ID

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": {
      "realm": "<realm>",
      "roleId": "<roleId>"
    },
    "name": "update-role-by-id"
  }
}

Input Schema

Name	Required	Description
`name`	No	Role name
`realm`	Yes	Realm name
`roleId`	Yes	Role ID
`composite`	No	Is composite role
`attributes`	No	Role attributes
`clientRole`	No	Is client role
`containerId`	No	Container ID
`description`	No	Role description

Schema Changelog

Changes observed during successful MCP inspections.

First observedv2.0.0Aug 14, 2026

TDQS

C2.7/5.0

Behavior2/5

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

With no annotations, the description carries the full burden of behavioral disclosure. It only says 'update', with no information about side effects, idempotency, required permissions, handling of omitted fields, or success/failure responses. For a mutating tool, this is a significant gap.

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

Conciseness2/5

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

The description is extremely concise with no fluff, but it is under-specified rather than efficiently informative. It provides no more value than repeating the tool name and is too minimal to be useful for an agent, similar to the 'Process' example in calibration.

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

Completeness2/5

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

For a mutation tool with 8 parameters, no annotations, no output schema, and no usage context, the description is incomplete. It lacks details about what fields are updatable, how omitted fields behave, error scenarios, or any prerequisites. The schema's full parameter documentation mitigates some gaps but cannot substitute for operational context.

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?

The input schema provides descriptions for all 8 parameters (100% coverage), so the schema carries the parameter semantics. The description itself adds no parameter-level information, but per the guidelines, a baseline of 3 is appropriate when schema coverage is high.

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 clearly states the verb 'update' and the resource 'role by ID', indicating the operation's core purpose. However, it doesn't explicitly differentiate from the sibling tool 'update-role', which likely updates a role by name or other key, leaving some ambiguity for an agent selecting between them.

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?

No guidance is provided on when to use this tool versus alternatives like 'update-role', 'delete-role-by-id', or 'create-role'. The description does not mention prerequisites, such as the role existing or the relevance of the 'realm' and 'roleId' required parameters, nor does it suggest conditions for choosing this tool.

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

Deploy Server