Octodet Keycloak

Keycloak MCP server

javascript

3

GitHub Stars

javascript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "octodet-keycloak-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@octodet/keycloak-mcp"
      ],
      "env": {
        "KEYCLOAK_URL": "http://localhost:8080",
        "KEYCLOAK_ADMIN": "admin",
        "KEYCLOAK_REALM": "master",
        "KEYCLOAK_ADMIN_PASSWORD": "admin"
      }
    }
  }
}

You can run an MCP server that exposes Keycloak administration capabilities to AI assistants. This server lets you manage users, realms, and roles through dialogue or prompts, with secure admin authentication and simple environment-based configuration.

How to use

Start the MCP server using your preferred method and connect your MCP client (such as an IDE extension or an AI assistant) to perform actions like creating users, listing realms, or updating user roles. Use the available tools to perform common administration tasks across your Keycloak instance. You can authenticate with admin credentials for secure access and rely on the built-in error messages to troubleshoot permissions or invalid parameters.

Available tools

create-user

Create a new user in a specified realm with attributes like username, email, firstName, lastName, and optional credentials such as a password.

delete-user

Permanently remove a user from a specified realm using the userId. This action is irreversible.

list-users

Retrieve a list of all users in a specified realm with basic information.

list-realms

List all available realms in the Keycloak instance.

list-roles

List all roles for a specific client within a realm, using either the clientId or its UUID.

update-user-roles

Add or remove client roles for a user in a single operation, with an atomic approach per role list.