Keycloak MCP 服务器

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

功能特性

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

安装方式

通过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 <仓库地址>
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实例