Skip to main content
Glama
Sign In
@mgcrea/mcp-keycloak

@mgcrea/mcp-keycloak

by mgcrea
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

keycloak_list_protocol_mappers

Read-only

List protocol mappers on a Keycloak client or client scope to inspect how token claims are configured, such as user attributes, group membership, or audiences.

Instructions

List the protocol mappers on a client or on a client scope. Mappers are what put claims into a token (a user attribute, group membership, an audience, a hardcoded value).

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "keycloak_list_protocol_mappers"
  }
}

Input Schema

NameRequiredDescriptionDefault
realmNoRealm to operate on. Defaults to the server's configured realm (KEYCLOAK_REALM).
scopeIdNoClient scope UUID. Pass this OR `clientUuid`.
clientUuidNoClient UUID. Pass this OR `scopeId`.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.9/5.0
Behavior3/5

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

The readOnlyHint annotation already signals that this is a safe read-only operation. The description adds useful conceptual context about what a protocol mapper is, but does not disclose additional behavioral aspects such as return format or pagination. With annotation coverage, this sits at a solid baseline.

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?

Two sentences with no filler; the first sentence states the operation and target, and the second briefly explains why mappers matter. The definition is front-loaded and every sentence earns its place.

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

Completeness5/5

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

For a simple read-only list tool with fully documented parameters and a readOnlyHint annotation, the description is complete enough for an agent to select and invoke the tool. The target (client or client scope), the purpose, and the relevant parameter relationships are all represented either in the description or the input schema. The absence of an output schema is not critical because the result is naturally the list of mappers.

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?

All three parameters have schema descriptions, including the OR relationship between scopId and clientUuid, so the schema carries the operational meaning. The description's 'client or client scope' phrase roughly mirrors those parameters but adds no new detail about realm defaults, UUID formats, or mutual exclusivity beyond what the schema already states.

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

Purpose5/5

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

The description uses a specific verb resource pairs: 'List the protocol mappers on a client or on a client scope.' It states exactly what the tool returns and explains the domain concept (mappers add claims to a token), which makes the purpose unambiguous. The word 'protocol' also distinguishes it from the sibling keycloak_list_identity_provider_mappers.

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?

The usage context is implied by describing the resource and target ('on a client or on a client scope'), but there is no explicit when-to-use or when-not-to-use guidance and no mention of alternatives such as identity provider mappers. An agent can infer when to call it, but the definition does not explicitly route the decision.

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