关键词

Descope用户管理身份验证审计日志LLM工具

Descope MCP Server 使用说明

项目简介

Descope MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为 LLM 客户端（如 Claude Desktop）提供与 Descope 身份验证和用户管理服务交互的能力。它通过预定义的工具，允许 LLM 应用安全地查询用户、审计日志，以及进行用户创建和邀请等操作。

主要功能点

  • 用户查询工具 (search-users): 允许 LLM 客户端根据多种条件搜索 Descope 项目中的用户，例如邮箱、电话、状态、角色等。
  • 审计日志查询工具 (search-audits): 允许 LLM 客户端检索 Descope 项目的审计日志，支持按时间范围、用户、行为等条件过滤。
  • 创建用户工具 (create-user): 允许 LLM 客户端在 Descope 项目中创建新用户，并支持设置用户的各种属性，如邮箱、电话、角色等。
  • 邀请用户工具 (invite-user): 允许 LLM 客户端邀请新用户加入 Descope 项目，并可自定义邀请链接和邮件/短信发送选项。
  • 标准 MCP 服务器: 遵循 Model Context Protocol 规范，易于集成到支持 MCP 协议的 LLM 客户端。
  • 支持 Stdio 和 SSE 传输协议: 提供灵活的服务器运行方式，适应不同的部署环境。

安装步骤

手动安装 (推荐 Claude Desktop 用户使用手动安装)

  1. 克隆仓库:

    git clone https://github.com/descope-sample-apps/descope-mcp-server.git
cd descope-mcp-server

  2. 安装依赖:

    npm install

  3. 构建项目:

    npm run build

服务器配置

要将 Descope MCP Server 集成到 MCP 客户端（例如 Claude Desktop），您需要配置客户端以识别并连接到此服务器。以下是 Claude Desktop 的配置示例，您需要编辑 'claude_desktop_config.json' 文件。

配置信息 (JSON 格式):

{
  "mcpServers": {
    "descope": {
      "command": "node",
      "args": ["/path/to/descope-mcp-server/build/index.js"],
      "env": {
        "DESCOPE_PROJECT_ID": "your-descope-project-id-here",
        "DESCOPE_MANAGEMENT_KEY": "your-descope-management-key-here"
      }
    }
  }
}

参数注释:

  • '"descope"': 服务器名称，可以自定义，用于在客户端中标识该服务器。
  • '"command": "node"': 启动服务器的命令，这里使用 Node.js 运行环境。
  • '"args": ["/path/to/descope-mcp-server/build/index.js"]': 启动命令的参数，指向构建后的服务器入口文件 'index.js' 的路径。 请将 '/path/to/descope-mcp-server' 替换为您的 'descope-mcp-server' 仓库的实际本地路径。
  • '"env"': 环境变量配置。
    • '"DESCOPE_PROJECT_ID": "your-descope-project-id-here"': 必须配置，您的 Descope 项目 ID，可以在 Descope 控制台 获取。 请替换 '"your-descope-project-id-here"' 为您的实际项目 ID。
    • '"DESCOPE_MANAGEMENT_KEY": "your-descope-management-key-here"': 必须配置，您的 Descope 管理密钥，可以在 Descope 控制台 获取。 请替换 '"your-descope-management-key-here"' 为您的实际管理密钥。 请务必妥善保管您的管理密钥，避免泄露。

配置步骤 (以 Claude Desktop 为例):

  1. 启用开发者模式: 在 Claude Desktop 应用中，从左上角菜单栏启用开发者模式。
  2. 编辑配置文件: 进入设置 (Settings)，导航到开发者 (Developer) 部分，点击 "Edit Config" 按钮打开 'claude_desktop_config.json' 文件。
  3. 添加服务器配置: 将上述 JSON 配置代码添加到 'claude_desktop_config.json' 文件的 '"mcpServers"' 字段中。 确保替换占位符为您实际的项目 ID、管理密钥和仓库路径。
  4. 重启 Claude Desktop: 完全退出并重新启动 Claude Desktop 应用。
  5. 检查连接状态: 启动后，检查 Claude Desktop 界面中是否出现 🔌 图标，以确认 Descope MCP Server 已成功连接。

基本使用方法

成功配置并启动 Descope MCP Server 后，您可以在支持 MCP 协议的 LLM 客户端中使用以下工具：

  • 'search-audits': 查询审计日志。例如，在 Claude 中可以这样提问：'@descope search-audits actions=["login", "logout"] limit=5' （查询最近 5 条登录和登出的审计日志）。
  • 'search-users': 查询用户。例如：'@descope search-users text="example.com" limit=3' （搜索邮箱包含 "example.com" 的前 3 个用户）。
  • 'create-user': 创建用户。例如：'@descope create-user loginId="[email protected]" email="[email protected]"' （创建一个 loginId 和 email 均为 "[email protected]" 的新用户）。
  • 'invite-user': 邀请用户。例如：'@descope invite-user loginId="[email protected]" email="[email protected]"' （邀请邮箱为 "[email protected]" 的用户）。

注意: 工具的具体参数和使用方式请参考 'src/descope.ts' 文件中每个 'server.tool()' 方法的参数定义和描述。您可以在 LLM 客户端的指令中直接使用 '@服务器名称 工具名称 参数名=参数值' 的格式来调用工具。

运行服务器

在完成安装和配置后，您可以选择以下方式运行 Descope MCP Server：

1. Stdio 模式 (默认):

npm run start:stdio

这种模式通过标准输入输出 (stdio) 与 MCP 客户端通信，适用于大多数情况。

2. SSE 模式:

npm run start:sse

这种模式通过 Server-Sent Events (SSE) 协议与 MCP 客户端通信，可能适用于需要长连接和服务器推送的场景。 运行 SSE 模式前，请确保您已安装依赖 'npm install express'。

请根据您的 MCP 客户端和部署环境选择合适的运行模式。

信息

分类

开发者工具

访问项目