Ключевая точка Mcp Сервер

Что такое Протокол Контекста Модели Keycloak?

Протокол Контекста Модели Keycloak (MCP) — это инновационная серверная реализация, предназначенная для эффективного управления пользователями Keycloak. Он использует управление на основе искусственного интеллекта для упрощения управления пользователями иRealm, что облегчает организациям выполнение их потребностей в управлении идентификацией и доступом. MCP обеспечивает бесшовную интеграцию с различными клиентами, включая Claude Desktop, позволяя автоматизировать операции с пользователями и улучшать административные возможности.

Особенности Протокола Контекста Модели Keycloak

• Управление на основе ИИ: Использует искусственный интеллект для автоматизации задач управления пользователями, снижая ручные усилия и увеличивая эффективность.
• Бесшовная интеграция: Работает без усилий с Claude Desktop и другими клиентами MCP, позволяя автоматизировать операции по управлению пользователями.
• Управление пользователями и Realm: Упрощает администрирование пользователей и Realm в Keycloak, предоставляя удобный интерфейс для администраторов.
• Публичный репозиторий: Проект является открытым исходным кодом и доступен для общественности, позволяя разработчикам вносить свой вклад и улучшать его функциональность.
• Активное сообщество: С растущим числом звезд и форков, MCP имеет активное сообщество, поддерживающее его разработку и использование.

Как использовать Протокол Контекста Модели Keycloak

1. Установка: Начните с клонирования репозитория с GitHub. Вы можете использовать команду:

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

2. Настройка: Следуйте инструкциям по установке, предоставленным в файле README репозитория, чтобы настроить сервер.
3. Конфигурация: Настройте MCP для подключения к вашему экземпляру Keycloak. Это может включать настройку API-ключей и корректировку параметров в соответствии с вашей средой.
4. Интеграция: Интегрируйтесь с клиентами, такими как Claude Desktop, чтобы начать автоматизировать задачи управления пользователями.
5. Использование: Используйте функции MCP для эффективного управления пользователями и Realm. Изучите документацию для получения подробных инструкций по использованию и примеров.

Часто задаваемые вопросы

В1: Какова основная цель Протокола Контекста Модели Keycloak?

О1: Основная цель MCP — улучшить управление пользователями и администрирование Realm в Keycloak с помощью автоматизации на основе ИИ.

В2: Бесплатен ли Протокол Контекста Модели Keycloak для использования?

О2: Да, MCP — это проект с открытым исходным кодом, доступный бесплатно. Вы можете внести свой вклад в его разработку или использовать его в своих проектах без каких-либо затрат.

В3: Как я могу внести вклад в Протокол Контекста Модели Keycloak?

О3: Вы можете внести вклад, сделав форк репозитория, улучшив его и отправив запрос на слияние. Сообщество приветствует вклады, которые улучшают функциональность и удобство использования MCP.

В4: Могу ли я интегрировать Протокол Контекста Модели Keycloak с другими приложениями?

О4: Да, MCP разработан для интеграции с различными приложениями и клиентами, что делает его универсальным для различных случаев использования в управлении пользователями.

В5: Где я могу найти дополнительную информацию о Протоколе Контекста Модели Keycloak?

О5: Дополнительную информацию, включая документацию и примеры использования, можно найти в репозитории проекта на 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