keycloak-mcp

Dump client secret to a file

dump_client_secret

Fetch a confidential client's current secret and write its value to a local file. The secret is never exposed to the caller or logs.

Instructions

Fetch a confidential client's current secret and write ONLY the 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 (path, byte length). This is a read against Keycloak (no mutation), so it is not write-gated.

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": "dump_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.
`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.5/5.0

Behavior5/5

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

With no annotations, description fully covers behavioral traits: writes file with mode 0600, no trailing newline, secret never returned or logged, only metadata returned, read-only against Keycloak. No contradictions.

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?

Three sentences, each informative and necessary. Front-loaded with action, no unnecessary words. Appropriate length for the complexity.

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?

Given no annotations, no output schema, and 4 params, description explains purpose, behavioral details, return metadata, and security aspects. It is sufficient for an agent to understand and invoke correctly.

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?

Schema coverage is 100% and parameters are well-documented in schema. Description adds overall context but does not significantly enhance individual parameter meanings beyond what schema provides. Baseline 3.

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?

Description clearly states verb (fetch and write), resource (confidential client secret), and scope (write value to file, no return). Distinguishes from siblings by specifying it writes to file and does not return the secret, unlike regenerate_client_secret or get_client.

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?

Provides context on when to use (need secret written to file) and explains that it is a read operation not write-gated. However, does not explicitly state alternatives or when not to use, but implication is clear.

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

Deploy Server