Servidor Keycloak Mcp

¿Qué es el Protocolo de Contexto del Modelo de Keycloak?

El Protocolo de Contexto del Modelo de Keycloak (MCP) es una implementación innovadora del servidor diseñada para gestionar usuarios de Keycloak de manera efectiva. Aprovecha la administración impulsada por inteligencia artificial para optimizar la gestión de usuarios y reinos, facilitando a las organizaciones el manejo de sus necesidades de gestión de identidad y acceso. El MCP facilita la integración sin problemas con varios clientes, incluyendo Claude Desktop, permitiendo operaciones automatizadas de usuarios y capacidades administrativas mejoradas.

Características del Protocolo de Contexto del Modelo de Keycloak

• Administración Impulsada por IA: Utiliza inteligencia artificial para automatizar tareas de gestión de usuarios, reduciendo el esfuerzo manual y aumentando la eficiencia.
• Integración Sin Problemas: Funciona sin esfuerzo con Claude Desktop y otros clientes de MCP, habilitando operaciones automatizadas para la gestión de usuarios.
• Gestión de Usuarios y Reinos: Simplifica la administración de usuarios y reinos dentro de Keycloak, proporcionando una interfaz amigable para los administradores.
• Repositorio Público: El proyecto es de código abierto y está disponible públicamente, permitiendo a los desarrolladores contribuir y mejorar su funcionalidad.
• Comunidad Activa: Con un número creciente de estrellas y bifurcaciones, el MCP tiene una comunidad activa que apoya su desarrollo y uso.

Cómo Usar el Protocolo de Contexto del Modelo de Keycloak

1. Instalación: Comienza clonando el repositorio desde GitHub. Puedes usar el comando:

   git clone https://github.com/ChristophEnglisch/keycloak-model-context-protocol.git
   

2. Configuración: Sigue las instrucciones de instalación proporcionadas en el archivo README del repositorio para configurar el servidor.
3. Configuración: Configura el MCP para conectarse con tu instancia de Keycloak. Esto puede implicar configurar claves API y ajustar configuraciones para adaptarse a tu entorno.
4. Integración: Integra con clientes como Claude Desktop para comenzar a automatizar tareas de gestión de usuarios.
5. Uso: Utiliza las características del MCP para gestionar usuarios y reinos de manera eficiente. Explora la documentación para obtener instrucciones de uso detalladas y ejemplos.

Preguntas Frecuentes

P1: ¿Cuál es el propósito principal del Protocolo de Contexto del Modelo de Keycloak?

R1: El propósito principal del MCP es mejorar la gestión de usuarios y la administración de reinos en Keycloak a través de la automatización impulsada por IA.

P2: ¿Es gratuito el uso del Protocolo de Contexto del Modelo de Keycloak?

R2: Sí, el MCP es un proyecto de código abierto disponible de forma gratuita. Puedes contribuir a su desarrollo o usarlo en tus proyectos sin ningún costo.

P3: ¿Cómo puedo contribuir al Protocolo de Contexto del Modelo de Keycloak?

R3: Puedes contribuir bifurcando el repositorio, realizando mejoras y enviando una solicitud de extracción. La comunidad da la bienvenida a las contribuciones que mejoren la funcionalidad y usabilidad del MCP.

P4: ¿Puedo integrar el Protocolo de Contexto del Modelo de Keycloak con otras aplicaciones?

R4: Sí, el MCP está diseñado para integrarse con varias aplicaciones y clientes, lo que lo hace versátil para diferentes casos de uso en la gestión de usuarios.

P5: ¿Dónde puedo encontrar más información sobre el Protocolo de Contexto del Modelo de Keycloak?

R5: Información adicional, incluyendo documentación y ejemplos de uso, se puede encontrar en el repositorio de GitHub del proyecto.

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