使用说明

项目简介

WorkOS MCP Server 是一个基于 Model Context Protocol (MCP) 构建的轻量级后端服务，部署在 Cloudflare Workers 平台。它作为一个 MCP 服务器，主要功能是为 LLM 客户端（如 Cursor Agent）提供访问 WorkOS API 的能力。WorkOS API 主要用于用户和组织管理，此 MCP 服务器将其功能封装成一系列易于 LLM 调用的工具。

主要功能点

组织管理工具：
- 列出、创建、删除、获取和更新 WorkOS 组织信息。
- 列出组织的角色信息。
用户管理工具：
- 列出、创建、删除、获取和更新 WorkOS 用户信息。
- 列出用户的身份信息。
组织成员管理工具：
- 获取、列出、创建、更新、删除、激活和停用组织成员关系。
事件查询工具：
- 根据事件类型、时间范围和组织ID等条件查询 WorkOS 事件。

这些工具允许 LLM 客户端通过 MCP 协议与 WorkOS API 交互，实现用户和组织数据的查询和管理。

安装步骤

安装 'create-mcp' CLI: 如果还没有安装 'create-mcp'，请先全局安装：

npm install -g create-mcp

或者使用 bun:

bun add -g create-mcp

克隆并部署 MCP 服务器: 运行以下命令，根据提示完成 Cloudflare 账号的关联和部署：

bun create mcp --clone https://github.com/zueai/workos-mcp

或者使用 npm:

npm create mcp --clone https://github.com/zueai/workos-mcp

这个命令会自动克隆仓库代码，并配置 Cloudflare Workers 的部署环境。部署成功后，命令会复制一个配置命令到你的剪贴板，用于添加到 MCP 客户端。

配置 WorkOS API 密钥: 在 Cloudflare Workers 的 Secrets 中添加 'WORKOS_API_KEY' 和 'WORKOS_CLIENT_ID' 两个 secret，分别设置为你的 WorkOS API 密钥和 Client ID。

bunx wrangler secret put WORKOS_API_KEY
bunx wrangler secret put WORKOS_CLIENT_ID

将 MCP 服务器添加到 MCP 客户端: 打开你的 MCP 客户端（例如 Cursor），进入 MCP 服务器配置页面，粘贴之前复制到剪贴板的命令以添加 WorkOS MCP Server。

服务器配置

MCP 服务器配置 (JSON 格式，用于 MCP 客户端):

{
  "serverName": "WorkOS MCP Server",
  "command": "<Cloudflare Workers 的 URL>",
  "args": []
}

'serverName': MCP 服务器的名称，可以自定义，方便在客户端中识别。
'command': 请替换为 在 Cloudflare Workers 部署成功后，Cloudflare Dashboard 或 'wrangler deploy' 命令输出的 Workers 服务 URL。这是 MCP 客户端连接到 WorkOS MCP Server 的地址。
'args': 参数列表，本 WorkOS MCP Server 不需要 额外的启动参数，因此为空数组 '[]'。

基本使用方法

在支持 MCP 协议的 LLM 客户端（如 Cursor Agent）中，成功添加并连接 WorkOS MCP Server 后，即可使用预定义的工具。
通过客户端的界面或指令，可以调用 WorkOS MCP Server 提供的各种工具，例如 'listOrganizations', 'createUser', 'getOrganizationMembership' 等。
工具的具体参数和返回值类型，请参考 'src/index.ts' 文件中每个工具方法的 JSDoc 注释。在客户端中，通常也会有工具的描述和参数提示。
例如，在 Cursor Agent 中，你可以通过自然语言指令，指示 Agent 使用 'listUsers' 工具来获取 WorkOS 中的用户列表，或者使用 'createOrganization' 工具来创建一个新的 WorkOS 组织。

注意: 使用 WorkOS MCP Server 前，请确保你拥有有效的 WorkOS 账号和 API 密钥，并在 Cloudflare Workers 中正确配置。

关键词