What is Keycloak Model Context Protocol

Keycloak MCP Server is a server designed to facilitate the administration of Keycloak by providing a Model Context Protocol interface. It allows for effective management of users and realms, streamlining the process of user administration within Keycloak environments.

Use cases

Keycloak MCP Server can be used by system administrators and developers to automate user management tasks within Keycloak realms. This includes creating and deleting users, listing realms, and managing user information across different environments, which enhances productivity and reduces manual effort.

How to use

To use the Keycloak MCP Server, you can install it either via Smithery or NPM. Configuration is done by adding the server command and environment variables to your Claude Desktop configuration file. After configuration, you can utilize available tools to manage users and realms through simple command inputs.

Key features

Key features of the Keycloak MCP Server include the ability to create and delete users in specific realms, list all available realms, and view users within those realms. These functions provide a comprehensive toolkit for managing user identities and realm configurations.

Where to use

The Keycloak MCP Server is ideal for environments where Keycloak is deployed for identity and access management. It is particularly useful in development environments, as well as production systems needing streamlined user management capabilities across multiple realms.

Keycloak MCP Server

A Model Context Protocol server for Keycloak administration, providing tools to manage users and realms.

Features

• Create new users in specific realms
• Delete users from realms
• List available realms
• List users in specific realms

Installation

Installing via Smithery

To install Keycloak for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install keycloak-model-context-protocol --client claude

Via NPM (Recommended)

The server is available as an NPM package:

# Direct usage with npx
npx -y keycloak-model-context-protocol

# Or global installation
npm install -g keycloak-model-context-protocol

Local Development Setup

If you want to develop or modify the server:

git clone <repository-url>
cd keycloak-model-context-protocol
npm install
npm run build

Configuration

Using NPM Package (Recommended)

Configure the server in your Claude Desktop configuration file:

{
  "mcpServers": {
    "keycloak": {
      "command": "npx",
      "args": [
        "-y",
        "keycloak-model-context-protocol"
      ],
      "env": {
        "KEYCLOAK_URL": "http://localhost:8080",
        "KEYCLOAK_ADMIN": "admin",
        "KEYCLOAK_ADMIN_PASSWORD": "admin"
      }
    }
  }
}

For Local Development

{
  "mcpServers": {
    "keycloak": {
      "command": "node",
      "args": [
        "path/to/dist/index.js"
      ],
      "env": {
        "KEYCLOAK_URL": "http://localhost:8080",
        "KEYCLOAK_ADMIN": "admin",
        "KEYCLOAK_ADMIN_PASSWORD": "admin"
      }
    }
  }
}

Available Tools

create-user

Creates a new user in a specified realm.

Inputs:

• realm: The realm name
• username: Username for the new user
• email: Email address for the user
• firstName: User’s first name
• lastName: User’s last name

delete-user

Deletes a user from a specified realm.

Inputs:

• realm: The realm name
• userId: The ID of the user to delete

list-realms

Lists all available realms.

list-users

Lists all users in a specified realm.

Inputs:

• realm: The realm name

Development

npm run watch

Testing

To test the server using MCP Inspector:

npx -y @modelcontextprotocol/inspector npx -y keycloak-model-context-protocol

Deployment

NPM Package

This project is automatically published to NPM via GitHub Actions when a new release is published on GitHub.

Setup Requirements for Deployment

1. Create NPM account and get access token
2. Add NPM_TOKEN secret to GitHub repository
   • Go to repository Settings > Secrets
   • Add new secret named NPM_TOKEN
   • Paste your NPM access token as the value

Prerequisites

• Node.js 18 or higher
• Running Keycloak instance