使用说明

项目简介

Descope MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在桥接 LLM 客户端和 Descope 管理 API。它允许 LLM 通过标准化的 MCP 协议调用 Descope 的功能，例如搜索用户、审计日志，以及管理用户，从而扩展 LLM 在 Descope 项目管理和身份验证服务方面的能力。

主要功能点

搜索审计日志 (search-audits): 允许 LLM 检索 Descope 项目的审计日志，以便分析和监控项目活动。
搜索用户 (search-users): 允许 LLM 在 Descope 项目中搜索用户，用于用户管理和信息查询。
创建用户 (create-user): 允许 LLM 在 Descope 项目中创建新用户，实现自动化用户注册或管理流程。
邀请用户 (invite-user): 允许 LLM 邀请用户加入 Descope 项目，简化用户 onboarding 过程。
标准 MCP 协议: 基于 MCP 协议开发，易于与支持 MCP 协议的 LLM 客户端集成。
多传输协议支持: 同时支持 Stdio 和 SSE 两种传输协议，可根据不同场景选择合适的通信方式。

安装步骤

环境准备: 确保已安装 Node.js (v18 或更高版本) 和 npm 包管理器。

克隆仓库: 在本地克隆 GitHub 仓库代码：

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

进入项目目录: 使用 'cd' 命令进入克隆下来的项目目录 'descope-mcp-server'。
```
cd descope-mcp-server
```
安装依赖: 运行 'npm install' 命令安装项目所需的依赖包。
```
npm install
```
构建项目: 运行 'npm run build' 命令编译 TypeScript 代码到 JavaScript。
```
npm run build
```

配置环境变量: 需要设置 'DESCOPE_PROJECT_ID' 和 'DESCOPE_MANAGEMENT_KEY' 环境变量。这两个值可以在 Descope 项目设置页面 (app.descope.com) 中找到。可以通过多种方式设置环境变量，例如：

在运行命令前，在终端中export：

export DESCOPE_PROJECT_ID="your-descope-project-id"
export DESCOPE_MANAGEMENT_KEY="your-descope-management-key"

或者在部署环境中配置。

服务器配置

为了让 MCP 客户端（例如 Claude Desktop）连接到 Descope MCP Server，需要在客户端的配置文件中添加服务器配置信息。以下是一个典型的 JSON 配置示例，你需要根据实际情况进行调整：

{
  "mcpServers": {
    "descope": { // 服务器名称，客户端配置时使用，可以自定义
      "command": "node", // 启动服务器的命令，这里使用 node.js 运行时
      "args": ["/path/to/descope-mcp-server/build/index.js"], // 命令参数，指向构建后的 index.js 文件路径。请将 "/path/to/descope-mcp-server" 替换为仓库在您电脑上的实际路径
      "env": { // 环境变量，传递 Descope 项目 ID 和管理密钥
        "DESCOPE_PROJECT_ID": "your-descope-project-id-here", // 替换为你的 Descope 项目 ID
        "DESCOPE_MANAGEMENT_KEY": "your-descope-management-key-here" // 替换为你的 Descope 管理密钥
      }
    }
  }
}

注意: 请将 '"/path/to/descope-mcp-server/build/index.js"' 替换为 'descope-mcp-server' 仓库在您电脑上的 绝对路径。例如 '/Users/yourname/descope-mcp-server/build/index.js'。

基本使用方法

启动服务器: 根据需要选择 Stdio 或 SSE 模式启动服务器。
- Stdio 模式: 运行命令 'npm run start:stdio' 启动基于标准输入输出的服务器。
- SSE 模式: 运行命令 'npm run start:sse' 启动基于 SSE 协议的服务器。 (需要先配置并启动 Express.js 服务，具体参考仓库中的 'src/sse.ts' 文件)
配置 MCP 客户端: 将上述 服务器配置 JSON 代码添加到 MCP 客户端的配置文件中。具体的配置文件位置和格式请参考 MCP 客户端的文档。对于 Claude Desktop，可以编辑 'claude_desktop_config.json' 文件。
连接和使用: 启动 MCP 客户端，客户端会自动连接到 Descope MCP Server。连接成功后，在 LLM 客户端中即可使用 'search-audits', 'search-users', 'create-user', 'invite-user' 等工具与 Descope 项目进行交互。例如，在 Claude Desktop 中，你可以在聊天对话中使用 '@descope.search-users' 工具并按照工具的参数描述进行调用。

关键词