Keycloak Model Context Protocol

🚀 Keycloak MCP 服務器

一個用於管理 Keycloak 管理用戶的模型上下文協議（Model Context Protocol）服務器，提供創建、刪除用戶和查看領域等功能，助力高效管理 Keycloak 用戶。

🚀 快速開始

本服務器提供了創建、刪除用戶和查看領域等功能，幫助你高效管理 Keycloak 用戶。下面為你詳細介紹使用方法。

✨ 主要特性

• 在特定領域創建新用戶
• 從領域中刪除用戶
• 列出可用的領域
• 在指定領域中列出用戶

📦 安裝指南

使用 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：用戶的 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 實例