Keycloak MCP

🚀 Keycloak MCP

Keycloak MCP 是一個針對 Keycloak 的模型上下文協議（MCP）服務器實現，它提供了一個標準化接口，用於管理 Keycloak 的用戶和領域。

🚀 快速開始

本項目實現了一個與 Keycloak 集成的 MCP 服務器，允許你通過標準化協議管理 Keycloak 的用戶和領域。它使用官方的 Keycloak 管理客戶端與 Keycloak 的 API 進行交互。

✨ 主要特性

功能演示

點擊查看功能演示

可用工具

• 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

📦 安裝指南

先決條件

• Node.js（建議使用最新的 LTS 版本）
• npm
• 正在運行的 Keycloak 實例

通過 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 管理客戶端
• @modelcontextprotocol/sdk - 用於標準化協議實現的 MCP SDK
• zod - 基於 TypeScript 的模式驗證庫

開發依賴項

• typescript - 支持 TypeScript
• @types/node - Node.js 的 TypeScript 定義
• shx - 跨平臺的 shell 命令

📄 許可證

本項目採用 MIT 許可證。

作者

OUMERZOUG Haitham