Serveur Keycloak Mcp

Qu'est-ce que le Protocole de Contexte de Modèle Keycloak ?

Le Protocole de Contexte de Modèle Keycloak (MCP) est une implémentation serveur innovante conçue pour gérer efficacement les utilisateurs de Keycloak. Il exploite une administration alimentée par l'IA pour rationaliser la gestion des utilisateurs et des royaumes, facilitant ainsi la gestion des besoins d'identité et d'accès des organisations. Le MCP facilite l'intégration transparente avec divers clients, y compris Claude Desktop, permettant des opérations utilisateur automatisées et des capacités administratives améliorées.

Fonctionnalités du Protocole de Contexte de Modèle Keycloak

• Administration Alimentée par l'IA : Utilise l'intelligence artificielle pour automatiser les tâches de gestion des utilisateurs, réduisant l'effort manuel et augmentant l'efficacité.
• Intégration Transparente : Fonctionne sans effort avec Claude Desktop et d'autres clients MCP, permettant des opérations automatisées pour la gestion des utilisateurs.
• Gestion des Utilisateurs et des Royaumes : Simplifie l'administration des utilisateurs et des royaumes au sein de Keycloak, offrant une interface conviviale pour les administrateurs.
• Répertoire Public : Le projet est open-source et disponible publiquement, permettant aux développeurs de contribuer et d'améliorer sa fonctionnalité.
• Communauté Active : Avec un nombre croissant d'étoiles et de forks, le MCP dispose d'une communauté active qui soutient son développement et son utilisation.

Comment Utiliser le Protocole de Contexte de Modèle Keycloak

1. Installation : Commencez par cloner le dépôt depuis GitHub. Vous pouvez utiliser la commande :

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

2. Configuration : Suivez les instructions d'installation fournies dans le fichier README du dépôt pour configurer le serveur.
3. Configuration : Configurez le MCP pour se connecter à votre instance Keycloak. Cela peut impliquer la configuration des clés API et l'ajustement des paramètres pour convenir à votre environnement.
4. Intégration : Intégrez-vous avec des clients comme Claude Desktop pour commencer à automatiser les tâches de gestion des utilisateurs.
5. Utilisation : Utilisez les fonctionnalités du MCP pour gérer efficacement les utilisateurs et les royaumes. Explorez la documentation pour des instructions d'utilisation détaillées et des exemples.

Questions Fréquemment Posées

Q1 : Quel est le principal objectif du Protocole de Contexte de Modèle Keycloak ?

R1 : L'objectif principal du MCP est d'améliorer la gestion des utilisateurs et l'administration des royaumes dans Keycloak grâce à l'automatisation alimentée par l'IA.

Q2 : Le Protocole de Contexte de Modèle Keycloak est-il gratuit à utiliser ?

R2 : Oui, le MCP est un projet open-source disponible gratuitement. Vous pouvez contribuer à son développement ou l'utiliser dans vos projets sans aucun coût.

Q3 : Comment puis-je contribuer au Protocole de Contexte de Modèle Keycloak ?

R3 : Vous pouvez contribuer en forkant le dépôt, en apportant des améliorations et en soumettant une demande de tirage. La communauté accueille les contributions qui améliorent la fonctionnalité et l'utilisabilité du MCP.

Q4 : Puis-je intégrer le Protocole de Contexte de Modèle Keycloak avec d'autres applications ?

R4 : Oui, le MCP est conçu pour s'intégrer à diverses applications et clients, le rendant polyvalent pour différents cas d'utilisation dans la gestion des utilisateurs.

Q5 : Où puis-je trouver plus d'informations sur le Protocole de Contexte de Modèle Keycloak ?

R5 : Des informations supplémentaires, y compris la documentation et des exemples d'utilisation, peuvent être trouvées dans le dépôt GitHub du projet.

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