v0.0.2

Release Notes

Version 0.0.2

Released on January 8, 2025

Changes

• Fixed binary name in package.json to match npm package name
• Enhanced installation and usage documentation
  • Added npm remote installation instructions
  • Improved configuration examples for both remote and local development
  • Added testing section with MCP Inspector instructions
• Updated documentation structure for better readability

Breaking Changes

None

Known Issues

None

Installation

npm install -g keycloak-model-context-protocol

Configuration in Claude Desktop

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

Full Changelog: v0.0.1...v0.0.2

v0.0.1

Keycloak MCP Server v0.0.1 - Initial Release

Overview

The Keycloak MCP Server provides a Model Context Protocol (MCP) interface for Keycloak administration, enabling AI-powered user and realm management in Keycloak installations.

Features

User Management

• Create new users in specific realms with required attributes (username, email, first name, last name)
• Delete existing users from realms
• List all users within a realm

Realm Management

• List all available realms in the Keycloak installation
• Cross-realm operations support

Security & Integration

• Secure authentication using environment variables
• Integration with Keycloak Admin Client
• Input validation using Zod schemas
• Proper error handling and validation messages

Tools

The server exposes the following MCP tools:

• create-user: Create new users with basic attributes
• delete-user: Remove users from specific realms
• list-realms: Get an overview of all available realms
• list-users: List all users in a specific realm

Configuration

Required environment variables:

• KEYCLOAK_URL: Keycloak server URL (defaults to http://localhost:8080)
• KEYCLOAK_ADMIN: Admin username (defaults to 'admin')
• KEYCLOAK_ADMIN_PASSWORD: Admin password (defaults to 'admin')

Known Limitations

• Initial release focuses on basic user management operations
• Additional Keycloak features like role management, group management, and client configuration will be added in future releases

Requirements

• Node.js environment
• Running Keycloak instance
• MCP-compatible client (e.g., Claude Desktop)