Servidor Keycloak Mcp

O que é o Protocolo de Contexto do Modelo Keycloak?

O Protocolo de Contexto do Modelo Keycloak (MCP) é uma implementação inovadora de servidor projetada para gerenciar usuários do Keycloak de forma eficaz. Ele utiliza administração impulsionada por IA para simplificar a gestão de usuários e reinos, facilitando para as organizações lidarem com suas necessidades de gerenciamento de identidade e acesso. O MCP facilita a integração perfeita com vários clientes, incluindo o Claude Desktop, permitindo operações automatizadas de usuários e capacidades administrativas aprimoradas.

Recursos do Protocolo de Contexto do Modelo Keycloak

• Administração Impulsionada por IA: Utiliza inteligência artificial para automatizar tarefas de gerenciamento de usuários, reduzindo o esforço manual e aumentando a eficiência.
• Integração Sem Costura: Funciona sem esforço com o Claude Desktop e outros clientes MCP, permitindo operações automatizadas para gerenciamento de usuários.
• Gerenciamento de Usuários e Reinos: Simplifica a administração de usuários e reinos dentro do Keycloak, fornecendo uma interface amigável para administradores.
• Repositório Público: O projeto é de código aberto e disponível publicamente, permitindo que desenvolvedores contribuam e aprimorem sua funcionalidade.
• Comunidade Ativa: Com um número crescente de estrelas e forks, o MCP possui uma comunidade ativa que apoia seu desenvolvimento e uso.

Como Usar o Protocolo de Contexto do Modelo Keycloak

1. Instalação: Comece clonando o repositório do GitHub. Você pode usar o comando:

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

2. Configuração: Siga as instruções de instalação fornecidas no arquivo README do repositório para configurar o servidor.
3. Configuração: Configure o MCP para se conectar à sua instância do Keycloak. Isso pode envolver a configuração de chaves de API e ajustes nas configurações para se adequar ao seu ambiente.
4. Integração: Integre-se com clientes como o Claude Desktop para começar a automatizar tarefas de gerenciamento de usuários.
5. Uso: Utilize os recursos do MCP para gerenciar usuários e reinos de forma eficiente. Explore a documentação para instruções detalhadas de uso e exemplos.

Perguntas Frequentes

Q1: Qual é o principal objetivo do Protocolo de Contexto do Modelo Keycloak?

A1: O principal objetivo do MCP é aprimorar o gerenciamento de usuários e a administração de reinos no Keycloak por meio de automação impulsionada por IA.

Q2: O Protocolo de Contexto do Modelo Keycloak é gratuito para usar?

A2: Sim, o MCP é um projeto de código aberto disponível gratuitamente. Você pode contribuir para seu desenvolvimento ou usá-lo em seus projetos sem custo algum.

Q3: Como posso contribuir para o Protocolo de Contexto do Modelo Keycloak?

A3: Você pode contribuir fazendo um fork do repositório, realizando melhorias e enviando um pull request. A comunidade acolhe contribuições que aprimorem a funcionalidade e usabilidade do MCP.

Q4: Posso integrar o Protocolo de Contexto do Modelo Keycloak com outros aplicativos?

A4: Sim, o MCP é projetado para se integrar a vários aplicativos e clientes, tornando-o versátil para diferentes casos de uso em gerenciamento de usuários.

Q5: Onde posso encontrar mais informações sobre o Protocolo de Contexto do Modelo Keycloak?

A5: Informações adicionais, incluindo documentação e exemplos de uso, podem ser encontradas no repositório do projeto no GitHub.

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