keycloak-mcp

Regenerate client secret to a file

regenerate_client_secret

Rotate a Keycloak confidential client's secret, writing the new value to a local file for secure retrieval; perform a dry run or apply with write=true.

Instructions

Rotate a confidential client's secret and write ONLY the NEW value to a local file (mode 0600, no trailing newline). The secret value is never returned to the caller or logged — the tool returns only metadata. This mutates Keycloak: with write=false (default) it returns a dry-run plan and rotates nothing; with write=true it rotates. Production hosts (us/za) additionally require allowProdWrite in the config.

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

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.
`outPath`	Yes	Absolute local file path the secret VALUE is written to (mode 0600). The value is written to this file by the server and is never returned to the caller.
`clientId`	Yes	The client's clientId (the human-readable OAuth client id, not the UUID).

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Jul 9, 2026

TDQS

A4.8/5.0

Behavior5/5

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

Fully discloses that the secret is never returned or logged, only metadata is returned; mutates Keycloak; is a write operation; production gating; file mode 0600 and no trailing newline; all behavioral traits are explained beyond what annotations would provide (none exist).

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?

Compact single paragraph with no wasted words. All critical information is front-loaded and each sentence contributes unique value.

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 mutation tool with no output schema, the description covers return value (metadata), side effects, production guard, dry-run capability, file writing details, and parameter semantics. Nothing essential is missing.

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

Parameters5/5

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

Schema has 100% coverage, but description adds significant value: explains host's production flag, dry-run vs. apply for write, file path specifics (mode 0600, server-side write), and clientId as human-readable OAuth id. Each parameter gets richer context.

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?

Clearly states the tool rotates a confidential client's secret and writes the new value to a local file. Distinguishes itself from siblings by explicitly noting 'ONLY the NEW value' and write-to-file behavior.

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?

Explains the write parameter for dry-run vs. actual rotation and mentions production hosts require allowProdWrite. Does not compare to dump_client_secret or other siblings, but provides clear context for when to use each mode.

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

Deploy Server