Keycloak Admin MCP server

The Keycloak MCP Server provides a Model Context Protocol interface for Keycloak administration, allowing you to manage users and realms through a standardized protocol that AI assistants can interact with.

Installation Options

Via NPM (Recommended)

The server can be installed and run directly with npx:

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

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

Via Smithery

For Claude Desktop users, you can install automatically using Smithery:

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

Configuration

Setting Up in Claude Desktop

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"
      }
    }
  }
}

Make sure to update the environment variables with your Keycloak server details:

• KEYCLOAK_URL: The URL of your Keycloak server
• KEYCLOAK_ADMIN: Your admin username
• KEYCLOAK_ADMIN_PASSWORD: Your admin password

Available Tools

Creating Users

The create-user tool allows you to create new users in a specified realm.

Required 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

Deleting Users

The delete-user tool removes a user from a specified realm.

Required inputs:

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

Listing Realms

The list-realms tool displays all available realms in your Keycloak instance.

Listing Users

The list-users tool shows all users in a specified realm.

Required inputs:

• realm: The realm name

Testing the Server

To verify your installation and test the server functionality using MCP Inspector:

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

Prerequisites

Before using the Keycloak MCP Server, ensure you have:

• Node.js 18 or higher installed
• A running Keycloak instance with admin credentials

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

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

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

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

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json
• Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your 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"
            }
        }
    }
}

3. Restart Claude Desktop for the changes to take effect