Keycloak Admin

🚀 Keycloak MCP 服務器

Keycloak MCP 服務器用於管理 Keycloak 管理的模型上下文協議（Model Context Protocol），它提供了一系列工具，可高效管理用戶和域，提升管理效率。

🚀 快速開始

你可以通過以下步驟快速開始使用 Keycloak MCP 服務器：

1. 完成安裝（參考“📦 安裝指南”）。
2. 進行配置（參考“📚 詳細文檔”中的配置部分）。
3. 運用可用工具（參考“📚 詳細文檔”中的可用工具部分）。

✨ 主要特性

• 能夠在特定域中創建新用戶。
• 可從域中刪除用戶。
• 支持列出所有可用域。
• 可以列出特定域中的用戶。

📦 安裝指南

通過 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. 將 NPM_TOKEN 秘密添加到 GitHub 倉庫中：
   • 前往倉庫設置 > 秘密。
   • 添加新的秘密，名稱為 NPM_TOKEN。
   • 粘貼你的 NPM 訪問令牌作為值。

先決條件

• Node.js 18 或更高版本。
• 運行中的 Keycloak 實例。