Keycloak MCPサーバー

Keycloakモデルコンテキストプロトコルとは？

Keycloakモデルコンテキストプロトコル（MCP）は、Keycloakユーザーを効果的に管理するために設計された革新的なサーバー実装です。AI駆動の管理を活用して、ユーザーとレルムの管理を簡素化し、組織がアイデンティティとアクセス管理のニーズを扱いやすくします。MCPは、Claude Desktopなどのさまざまなクライアントとのシームレスな統合を促進し、自動化されたユーザー操作と強化された管理機能を提供します。

Keycloakモデルコンテキストプロトコルの特徴

• AI駆動の管理: 人工知能を利用してユーザー管理タスクを自動化し、手動の労力を削減し、効率を向上させます。
• シームレスな統合: Claude Desktopや他のMCPクライアントと簡単に連携し、ユーザー管理の自動操作を可能にします。
• ユーザーとレルムの管理: 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の機能を活用して、ユーザーとレルムを効率的に管理します。詳細な使用手順や例については、ドキュメントを参照してください。

よくある質問

Q1: Keycloakモデルコンテキストプロトコルの主な目的は何ですか？

A1: MCPの主な目的は、AI駆動の自動化を通じてKeycloakにおけるユーザー管理とレルム管理を強化することです。

Q2: Keycloakモデルコンテキストプロトコルは無料で使用できますか？

A2: はい、MCPはオープンソースプロジェクトであり、無料で利用できます。開発に貢献することも、プロジェクトで使用することもコストなしで可能です。

Q3: Keycloakモデルコンテキストプロトコルにどのように貢献できますか？

A3: リポジトリをフォークし、改善を行い、プルリクエストを提出することで貢献できます。コミュニティはMCPの機能と使いやすさを向上させる貢献を歓迎しています。

Q4: Keycloakモデルコンテキストプロトコルを他のアプリケーションと統合できますか？

A4: はい、MCPはさまざまなアプリケーションやクライアントと統合できるように設計されており、ユーザー管理のさまざまなユースケースに対応しています。

Q5: Keycloakモデルコンテキストプロトコルに関する詳細情報はどこで見つけられますか？

A5: プロジェクトの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