Skip to main content
Glama
Sign In
keycloak-mcp-server

keycloak-mcp-server

by thebylito
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Remote

get-role-by-id

Retrieve role details from a Keycloak realm using the role ID. Access attributes, permissions, and metadata to simplify role management.

Instructions

Get role details 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": "get-role-by-id"
  }
}

Input Schema

NameRequiredDescriptionDefault
realmYesRealm name
roleIdYesRole ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

C2.9/5.0
Behavior2/5

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

With no annotations, the description must carry the full burden of behavioral disclosure. It only says 'Get role details' which implies read-only, but does not mention required permissions, realm-dependence, error handling, or response format. This is insufficient for a tool with no structured metadata.

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?

The description is a single, concise sentence with no redundant wording. It is front-loaded and communicates the essential purpose without unnecessary detail.

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?

Given the absence of annotations and output schema, the description is too minimal to be complete. It fails to explain how realm and roleId interact, what 'role details' includes, or any return behavior, making it hard for an agent to invoke correctly without additional assumptions.

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 fully describes both parameters ('realm' and 'roleId') with 100% coverage. The description adds no extra meaning beyond the schema, so baseline 3 is appropriate.

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 uses a specific verb ('Get') and resource ('role details') with identifier ('by ID'), clearly conveying the tool's function. It distinguishes from list-roles or update-role-by-id, though it omits the realm scoping which is a key part of the operation.

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 like list-roles or get-composite-roles. No exclusions or context are provided, leaving the agent without decision support.

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