Keycloak Admin

io.github.mrz1880Published by GitHub account mrz1880v0.2.3Updated Oct 24, 2026

Administer Keycloak via its Admin REST API: users, roles, clients, groups, IdP, events.

Overview

AI-generated overview

Local MCP server that lets an assistant administer a Keycloak 26.x realm through its Admin REST API: users, roles, clients, groups, IdPs and events.

What you can do
  • Search, read, create, update, enable/disable and delete realm users, list their sessions, send action emails, reset passwords and revoke sessions
  • List, assign and revoke realm roles and client roles for users and groups
  • List, create, update and delete clients, read or regenerate client secrets, and manage default scopes and protocol mappers
  • List, create and delete groups, add or remove members, and grant roles to groups
  • List, create and delete identity providers and their mappers, list user federation providers and trigger syncs
  • Read authentication flows, required actions, authorization resources, policies and permissions, login and admin events, realm config and server version
When to use it
Useful when an assistant or IDE agent needs to do routine Keycloak administration — looking up users, managing roles, clients and groups, or reading events — without handing over the raw admin console. Best for teams that want guardrails such as read-only mode and realm allow-lists around those operations.
Requirements
Node.js 20 or newer and a reachable Keycloak 26.x server. Required environment variables: KEYCLOAK_BASE_URL, KEYCLOAK_REALM and AUTH_MODE. In service_account mode, KC_CLIENT_ID and KC_CLIENT_SECRET; in password mode, KC_ADMIN_USERNAME and KC_ADMIN_PASSWORD, with optional KC_ADMIN_REALM. Optional READ_ONLY and ALLOWED_REALMS. Runs locally over stdio, typically via npx.
Before you install
The server holds admin credentials: KC_CLIENT_SECRET or KC_ADMIN_PASSWORD, which grant broad control of the realm. Write and destructive tools change real data — deleting users, clients, groups and IdPs, resetting passwords, revoking sessions, regenerating client secrets (the old secret stops working) and triggering federation syncs. Destructive tools ask for confirmation, but set READ_ONLY and ALLOWED_REALMS, especially for production, and grant the client least-privilege roles.

Installation

In SourceWeft

  1. Open Keycloak Admin in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Desktop only via STDIO. STDIO servers start a local process, so they need the SourceWeft desktop host.

Other MCP clients

Follow the launch instructions in the repository.

README

mcp-keycloak-admin

[npm version] [CI] [CodeQL] [License: MIT]

A Model Context Protocol (MCP) server to administer a Keycloak instance through its Admin REST API. Safe by default, configurable, and built with a clean, test-driven architecture.

Compatible with Keycloak 26.x (validated against 26.0.5).

Install

No install needed — run it straight from npm with npx:

bash
npx -y mcp-keycloak-admin

The server speaks MCP over stdio, so you normally wire it into an MCP client rather than running it by hand — see Usage with an MCP client. New to it? The Quickstart spins up a local Keycloak and a client config in a couple of minutes.

Why

Administering Keycloak from an MCP client (an assistant, an IDE, a custom agent) means exposing day-to-day operations — searching users, managing roles, reading events — as MCP tools, without handing over a raw admin console. This server does that with strong guardrails so destructive actions never happen silently.

Features

  • Two authentication modes, selectable by configuration:
    • service_account — a confidential client with a service account (recommended; no admin password stored).
    • password — the admin-cli client with an admin username/password.
  • Safe by default:
    • READ_ONLY mode hides every write/destructive tool.
    • ALLOWED_REALMS restricts which realms the server may operate on.
    • Destructive operations require explicit confirmation (native MCP elicitation, with a confirm: true parameter fallback for clients that do not support elicitation).
  • Clean Architecture: a framework-free domain, application use cases, and infrastructure adapters. No business concept travels as a raw string or number — every one is a validated value object.

Requirements

  • Node.js >= 20
  • A reachable Keycloak 26.x server

Usage with an MCP client

Add the server to your MCP client configuration:

json
{  "mcpServers": {    "keycloak-admin": {      "command": "npx",      "args": ["-y", "mcp-keycloak-admin"],      "env": {        "KEYCLOAK_BASE_URL": "http://localhost:8080",        "KEYCLOAK_REALM": "demo-realm",        "AUTH_MODE": "service_account",        "KC_CLIENT_ID": "mcp-admin",        "KC_CLIENT_SECRET": "your-secret"      }    }  }}

See docs/setup-keycloak.md to create the mcp-admin client and grant it the least-privilege roles it needs.

Multiple Keycloak instances

Each server entry targets one Keycloak (one base URL + realm + auth). To manage several environments, add one entry per instance — each fully isolated, with its own credentials and guardrails:

json
{  "mcpServers": {    "kc-preprod": {      "command": "npx",      "args": ["-y", "mcp-keycloak-admin"],      "env": {        "KEYCLOAK_BASE_URL": "https://preprod.example.com",        "KEYCLOAK_REALM": "preprod-realm",        "AUTH_MODE": "service_account",        "KC_CLIENT_ID": "mcp-admin",        "KC_CLIENT_SECRET": "…",        "ALLOWED_REALMS": "preprod-realm"      }    },    "kc-prod": {      "command": "npx",      "args": ["-y", "mcp-keycloak-admin"],      "env": {        "KEYCLOAK_BASE_URL": "https://auth.example.com",        "KEYCLOAK_REALM": "prod-realm",        "AUTH_MODE": "service_account",        "KC_CLIENT_ID": "mcp-admin",        "KC_CLIENT_SECRET": "…",        "READ_ONLY": "true",        "ALLOWED_REALMS": "prod-realm"      }    }  }}

The client namespaces the tools per server (e.g. kc-prod:keycloak_user_delete), so there's no risk of running an operation against the wrong environment. This is the recommended pattern: you can, for example, keep production READ_ONLY while preprod stays writable.

Configuration

VariableRequiredDescription
KEYCLOAK_BASE_URLyesBase URL of the Keycloak server (no trailing slash).
KEYCLOAK_REALMyesRealm the server operates on.
AUTH_MODEyesservice_account or password.
KC_CLIENT_IDif service_accountConfidential client id (e.g. mcp-admin).
KC_CLIENT_SECRETif service_accountClient secret.
KC_ADMIN_USERNAMEif passwordAdmin username.
KC_ADMIN_PASSWORDif passwordAdmin password.
KC_ADMIN_REALMno (default master)Realm holding the admin user (password mode).
READ_ONLYno (default false)When true, write/destructive tools are not registered.
ALLOWED_REALMSnoComma-separated allow-list of realms. Empty = all.

A full example lives in .env.example.

Tools

Levels: [R] read-only · [W] write · [D] destructive (requires confirmation). Every tool carries the matching MCP annotations (readOnlyHint / destructiveHint / idempotentHint).

Currently implemented:

Note: this table tracks the main branch, which can run ahead of the latest npm release shown by the version badge above. To confirm what's available in your install, check npm view mcp-keycloak-admin version and pin mcp-keycloak-admin@latest.

ToolLevelDescription
keycloak_user_searchRSearch realm users by email, username or free text.
keycloak_user_getRFetch a single user by id.
keycloak_user_sessions_listRList a user's active sessions.
keycloak_user_createWCreate a realm user.
keycloak_user_updateWUpdate a user's email, name or enabled flag.
keycloak_user_set_enabledWEnable or disable a user.
keycloak_user_send_action_emailWSend a required-actions email.
keycloak_user_reset_passwordDSet a new password for a user.
keycloak_user_logoutDRevoke all of a user's sessions.
keycloak_user_deleteDPermanently delete a user (id + username must match).
keycloak_role_listRList realm roles.
keycloak_user_roles_getRList a user's realm roles.
keycloak_user_role_assignWGrant a realm role to a user.
keycloak_user_role_unassignDRevoke a realm role from a user.
keycloak_client_roles_listRList the roles defined on a client.
keycloak_user_client_roles_getRList a user's client roles.
keycloak_user_client_role_assignWGrant a client role to a user.
keycloak_user_client_role_unassignDRevoke a client role from a user.
keycloak_client_listRList the realm clients.
keycloak_client_createWCreate a realm client.
keycloak_client_updateWUpdate a client (enabled, public, redirect URIs, CORS web origins).
keycloak_client_deleteDDelete a client.
keycloak_client_getRFetch a client by its clientId.
keycloak_client_get_secretRRead a client secret (masked unless reveal).
keycloak_client_scopes_listRList the realm's client scopes.
keycloak_client_default_scopes_getRList a client's default scopes.
keycloak_client_mappers_listRList a client's protocol mappers.
keycloak_client_scope_assignWAdd a default scope to a client.
keycloak_client_scope_unassignDRemove a default scope from a client.
keycloak_client_regenerate_secretDRegenerate a client secret (old one stops working).
keycloak_group_listRList the realm's top-level groups.
keycloak_group_members_listRList the members of a group.
keycloak_user_groups_listRList the groups a user belongs to.
keycloak_group_createWCreate a top-level group.
keycloak_group_member_addWAdd a user to a group.
keycloak_group_role_assignWGrant a realm role to a group.
keycloak_group_member_removeDRemove a user from a group.
keycloak_group_deleteDDelete a group.
keycloak_idp_listRList identity providers.
keycloak_idp_getRFetch an identity provider by alias.
keycloak_idp_mappers_listRList an identity provider's mappers.
keycloak_idp_createWCreate an identity provider.
keycloak_idp_deleteDDelete an identity provider.
keycloak_federation_listRList user federation (LDAP/Kerberos) providers.
keycloak_federation_getRFetch a federation provider by id.
keycloak_federation_syncWTrigger a user sync (full or changed).
keycloak_auth_flows_listRList authentication flows.
keycloak_auth_required_actions_listRList required actions.
keycloak_auth_required_action_set_enabledWEnable/disable a required action.
keycloak_authz_resources_listRList a client's authorization resources.
keycloak_authz_policies_listRList a client's authorization policies.
keycloak_authz_permissions_listRList a client's authorization permissions.
keycloak_events_loginRRead recent login events (filterable).
keycloak_events_adminRRead recent admin events.
keycloak_realm_get_configRRead key realm configuration flags.
keycloak_server_infoRRead the Keycloak server version.

See docs/users.md, docs/roles.md, docs/clients.md, docs/groups.md and docs/events-realm.md for parameters and examples, and docs/security.md for the safety model.

Roadmap

The architecture is designed to keep growing as thin use cases + tools. Remaining candidates: authorization policy/permission CRUD and evaluation, authentication flow mutation (copy/add executions), and advanced federation and identity-provider configuration. See docs/development.md for how to add one.

Development

bash
npm installnpm test              # unit testsnpm run test:integration  # spins up a real Keycloak 26 via Testcontainers (needs Docker)npm run check         # typecheck + lint + format check + unit testsnpm run build         # bundle to dist/

Releases are automated — see docs/releasing.md.

Contributing

Contributions are welcome — please read CONTRIBUTING.md.

License

MIT

Source: README.md at commit 8f97751

Tools

0
SourceWeft has not started this package in its sandbox yet, so its tools are not known.

Version history

1
  1. v0.2.3LatestSep 16, 2026

Score

50% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 days25 pts

    Keep the endpoint answering the MCP handshake; SourceWeft probes it every 30 days.

  • Auth declared10 pts

    Declare the credential headers in the registry entry, or keep the endpoint answering the probe so its auth can be classified.

  • Tools listed15 pts

    Answer tools/list without a credential, or ship a package that starts in a sandbox without one.

  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts