Keycloak MCP 服务器

一个用于 Keycloak 管理的模型上下文协议服务器，提供管理用户和域的工具。

功能

• 在特定域中创建新用户
• 从域中删除用户
• 列出可用的域
• 列出特定域中的用户

安装

通过 Smithery 安装

要通过 Smithery 自动为 Claude Desktop 安装 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 Inspector 测试服务器：

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

部署

NPM 包

当在 GitHub 上发布新版本时，此项目会自动通过 GitHub Actions 发布到 NPM。

部署的设置要求

1. 创建 NPM 帐户并获取访问令牌
2. 将 NPM_TOKEN 密钥添加到 GitHub 存储库
   • 转到存储库设置 > 密钥
   • 添加名为 NPM_TOKEN 的新密钥
   • 将您的 NPM 访问令牌粘贴为值

前提条件

• Node.js 18 或更高版本
• 运行中的 Keycloak 实例