Keycloak Admin

🚀 Keycloak MCP サーバー

Keycloak で管理されるモデルコンテキストプロトコル（Model Context Protocol）サーバーを管理するためのツールで、ユーザーとドメインの管理機能を提供します。

🚀 クイックスタート

このサーバーは、Keycloak で管理されるモデルコンテキストプロトコルを管理するためのもので、ユーザーとドメインの管理に役立ちます。以下に、インストール、設定、使用方法などの詳細を説明します。

✨ 主な機能

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

📦 インストール

Smithery を通じたインストール

Smithery を通じて Keycloak を自動インストールするには、以下のコマンドを実行します。

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 インスペクターを使用してサーバーをテストします。

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

デプロイ

NPM パッケージ

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

デプロイの前提条件

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

前提条件

• Node.js 18 以上
• 実行中の Keycloak インスタンス