Keycloak MCP

🚀 Keycloak MCP

Keycloak用のModel Context Protocol (MCP)サーバー実装で、Keycloakユーザーとリームの管理を標準化されたインターフェースで行えます。

🚀 クイックスタート

このプロジェクトはKeycloakと統合するMCPサーバーを実装しており、標準化されたプロトコルを通じてKeycloakのユーザーとリームを管理できます。公式のKeycloak Admin Clientを使用してKeycloakのAPIとやり取りします。

✨ 主な機能

機能デモ

https://github.com/user-attachments/assets/4b02a049-b8d6-4cc5-a7b4-564a0e758dd8

利用可能なツール

create-user

指定されたリームに新しいユーザーを作成します。 入力項目:

• realm: リーム名
• username: 新しいユーザーのユーザー名
• email: ユーザーのメールアドレス
• firstName: ユーザーの名
• lastName: ユーザーの姓

delete-user

指定されたリームからユーザーを削除します。 入力項目:

• realm: リーム名
• userId: 削除するユーザーのID

list-realms

利用可能なすべてのリームをリストします。

list-users

指定されたリーム内のすべてのユーザーをリストします。 入力項目:

• realm: リーム名

list-clients

指定されたリーム内のすべてのクライアントをリストします。 入力項目:

• realm: リーム名

list-groups

指定されたリーム内のすべてのグループをリストします。 入力項目:

• realm: リーム名

list-client-roles

リーム内の特定のクライアントのすべてのロールをリストします。 入力項目:

• realm: リーム名
• clientUniqueId: クライアントの一意のID

assign-client-role-to-user

特定のユーザーにクライアントロールを割り当てます。 入力項目:

• realm: リーム名
• userId: ユーザーのID
• clientUniqueId: クライアントの一意のID
• roleName: 割り当てるロールの名前

add-user-to-group

特定のグループにユーザーを追加します。 入力項目:

• realm: リーム名
• userId: ユーザーのID
• groupId: グループのID

📦 インストール

Smitheryを通じたインストール

Smitheryを通じてClaude Desktop用のkeycloak - mcpを自動的にインストールするには、以下のコマンドを実行します。

npx -y @smithery/cli install @HaithamOumerzoug/keycloak-mcp --client claude

NPMを通じたインストール

このサーバーはNPMパッケージとして利用可能です。

# npxで直接使用
npx -y keycloak-mcp

# またはグローバルインストール
npm install -g keycloak-mcp

📚 ドキュメント

NPMパッケージの使用

Cursor IDE、ClineまたはClaude DesktopのMCP設定ファイルでサーバーを設定します。

{
  "mcpServers": {
    "keycloak": {
      "command": "npx",
      "args": ["-y", "keycloak-mcp"],
      "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"
      }
    }
  }
}

🔧 技術詳細

開発環境のセットアップ

1. リポジトリをクローンします。
2. 依存関係をインストールします。

   npm install
   

3. プロジェクトをビルドします。

   npm run build
   

4. プロジェクトを起動します。

   npm run watch
   

利用可能なスクリプト

• npm run build - プロジェクトをビルドし、CLIを実行可能にします。
• npm run prepare - ビルドスクリプトを実行します（パッケージインストール時に使用）。
• npm run watch - 変更を監視し、自動的に再ビルドします。

依存関係

主な依存関係

• @keycloak/keycloak-admin-client - 公式のKeycloak Admin Client
• @modelcontextprotocol/sdk - 標準化されたプロトコル実装のためのMCP SDK
• zod - TypeScript第一のスキーマ検証

開発用依存関係

• typescript - TypeScriptのサポート
• @types/node - Node.jsのTypeScript定義
• shx - クロスプラットフォームのシェルコマンド

📄 ライセンス

MIT

作者

OUMERZOUG Haitham