keycloak-mcp

Delete protocol mapper

delete_protocol_mapper

Delete a protocol mapper for a client by specifying the mapper UUID. Use dry run mode to preview the deletion before applying.

Instructions

Delete one of a client's protocol mappers by mapper UUID. With write=false (default) it reports which mapper would be deleted; write=true performs the deletion.

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": {
      "host": "<host>",
      "realm": "<realm>",
      "clientId": "<clientId>",
      "mapperId": "<mapperId>"
    },
    "name": "delete_protocol_mapper"
  }
}

Input Schema

Name	Required	Description
`host`	Yes	Target Keycloak host key, as configured in the config file's "hosts" map (or the KC_<HOST>_* env fallback). A host whose "production" flag is true, or absent, is treated as PRODUCTION and its writes are gated by "allowProdWrite".
`realm`	Yes	Target realm name for the operation.
`write`	No	false (default) = dry run: report what would happen without changing anything. true = apply the change. Production hosts additionally require KC_ALLOW_PROD_WRITE=true in the server environment.
`clientId`	Yes	The client's clientId (the human-readable OAuth client id, not the UUID).
`mapperId`	Yes	UUID of the protocol mapper (see list_protocol_mappers).

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Jul 9, 2026

TDQS

A4.4/5.0

Behavior4/5

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

The description discloses that the tool can perform a dry run (write=false) or actual deletion (write=true), and mentions production safeguards via the 'host' parameter. It does not discuss irreversibility or post-deletion effects, but given no annotations, it carries the burden well.

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 extremely concise: two sentences that cover the action, scope, and key parameter behavior. No unnecessary words, and the most important information is front-loaded.

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

Completeness4/5

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

Given the complexity (5 params, no output schema), the description covers the operation and parameter behavior adequately. It lacks details about the return value, but for a deletion tool this is acceptable. The reference to list_protocol_mappers aids completeness.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 100% schema coverage, the baseline is 3. The description adds value by explaining the dry-run concept for 'write' and where to obtain 'mapperId' (from list_protocol_mappers), which goes beyond the schema descriptions.

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 clearly states the action: 'Delete one of a client's protocol mappers by mapper UUID'. It includes the key dry-run vs actual deletion distinction via the 'write' parameter, and the tool's purpose is distinct from siblings like list_protocol_mappers, which are for listing mappers.

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

Usage Guidelines4/5

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

The description explains the dry-run mode and the 'write' parameter, giving guidance on how to safely use the tool. It does not explicitly state when not to use it or mention alternatives, but the purpose is clear and the context (sibling tools) provides some implicit guidance.

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

Deploy Server