Keycloak Model Context Protocol

🚀 Keycloak MCP サーバー

Keycloak 管理ユーザーを管理するためのモデルコンテキストプロトコル（Model Context Protocol）サーバーです。ユーザーの作成、削除、ドメインの表示などの機能を提供します。

✨ 主な機能

• 特定のドメインに新しいユーザーを作成する
• ドメインからユーザーを削除する
• 利用可能なドメインを一覧表示する
• 指定されたドメイン内のユーザーを一覧表示する

📦 インストール

Smithery を使用したインストール

Smithery を通じて、Keycloak の Model Context Protocol を自動的にインストールします。

npx -y @smithery/cli install keycloak-model-context-protocol --client claude

NPM を使用したインストール（推奨）

このサーバーは NPM パッケージとして提供されています。

# 直接 npx を使用する
npx -y keycloak-model-context-protocol

# またはグローバルにインストールする
npm install -g keycloak-model-context-protocol

ローカル開発環境のセットアップ

サーバーを開発または修正する場合：

git clone <repository-url>
cd keycloak-model-context-protocol
npm install
npm run build

📚 ドキュメント

設定方法

NPM パッケージを使用する場合（推奨）

Claude Desktop の設定ファイルにサーバーを設定します。

{
  "mcpServers": {
    "keycloak": {
      "command": "npx",
      "args": ["-y", "keycloak-model-context-protocol"],
      "env": {
        "KEYCLOAK_URL": "http://localhost:8080",
        "KEYCLOAK_ADMIN": "admin",
        "KEYCLOAK_ADMIN_PASSWORD": "admin"
      }
    }
  }
}

ローカル開発の場合

{
  "mcpServers": {
    "keycloak": {
      "command": "node",
      "args": ["path/to/dist/index.js"],
      "env": {
        "KEYCLOAK_URL": "http://localhost:8080",
        "KEYCLOAK_ADMIN": "admin",
        "KEYCLOAK_ADMIN_PASSWORD": "admin"
      }
    }
  }
}

利用可能なツール

create - user

指定されたドメインに新しいユーザーを作成します。

入力パラメータ：

• realm：ドメイン名
• username：ユーザーのユーザー名
• email：ユーザーのメールアドレス
• firstName：ユーザーの姓
• lastName：ユーザーの名

delete - user

指定されたドメインからユーザーを削除します。

入力パラメータ：

• realm：ドメイン名
• userId：削除するユーザーの ID

list - realms

すべての利用可能なドメインを一覧表示します。

list - users

指定されたドメイン内のすべてのユーザーを一覧表示します。

入力パラメータ：

• realm：ドメイン名

開発

npm run watch

テスト

MCP Inspector を使用してサーバーをテストします。

npx -y @modelcontextprotocol/inspector npx -y keycloak-model-context-protocol

デプロイ

NPM パッケージ

このプロジェクトは、GitHub Actions を通じて GitHub で新しいバージョンがリリースされると自動的に NPM に公開されます。

デプロイ前の準備

1. NPM アカウントを作成し、アクセストークンを取得します。
2. NPM_TOKEN を GitHub リポジトリのシークレットとして追加します。
   • リポジトリの設定 > シークレットにアクセスします。
   • 新しいシークレットを追加し、名前を NPM_TOKEN とします。
   • あなたの NPM アクセストークンを値として貼り付けます。

前提条件

• Node.js 18 以上
• 動作中の Keycloak インスタンス