使用说明

项目简介

该项目是一个轻量级的Model Control Protocol (MCP) 服务器实现，专门用于将WorkOS API提供的各项功能（如用户管理、组织管理、事件日志等）封装成标准的MCP工具。这使得支持MCP协议的LLM客户端（如Cursor代理）能够通过调用这些工具与WorkOS服务进行交互，从而扩展LLM的应用能力。

主要功能点

该MCP服务器通过注册和执行工具，提供以下核心功能（通过WorkOS API实现）：

用户管理: 列出、创建、获取、更新、删除WorkOS中的用户，以及查看用户关联的身份信息。
组织管理: 列出、创建、获取、更新、删除WorkOS中的组织，以及管理组织关联的域名和属性。
成员管理: 获取、列出、创建、更新、删除、激活/停用组织成员身份，管理用户在组织中的角色。
事件访问: 列出WorkOS中发生的各类事件，支持按类型、时间范围、组织等进行筛选。

安装步骤

该服务器主要设计部署在Cloudflare Workers环境中。以下是基本的设置和部署流程：

环境准备: 确保已安装bun和wrangler (Cloudflare Workers CLI)。

项目初始化: 运行以下命令克隆项目并进行初始化（具体步骤可能因'create-mcp'工具版本略有差异）：

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

按照提示完成初始化过程。

配置密钥: 将你的WorkOS API Key和Client ID配置为Cloudflare Workers的secrets。同时，根据MCP服务器的需要，配置一个用于客户端认证的'SHARED_SECRET'。运行以下命令并按提示输入对应的值：

bunx wrangler secret put WORKOS_API_KEY
bunx wrangler secret put WORKOS_CLIENT_ID
bunx wrangler secret put SHARED_SECRET

部署到Cloudflare Workers: 运行项目的部署脚本：
```
bun run deploy
```
部署成功后，你将获得一个可访问的Cloudflare Worker URL。

服务器配置 (针对MCP客户端)

将WorkOS MCP服务器连接到你的MCP客户端（如支持MCP的AI编码助手或LLM平台）通常需要提供以下配置信息：

服务器名称: 一个标识该MCP服务器的名称（例如："WorkOS集成"）。
连接方式: 指明客户端如何连接服务器。对于部署在Cloudflare Workers的服务器，这通常是一个网络地址（URL），可能是通过HTTP/S或WebSocket协议连接。
认证信息: 为了安全连接，需要提供部署时配置的'SHARED_SECRET'。客户端将使用此密钥进行认证。

请参考你的MCP客户端的具体文档，了解如何添加服务器配置，并填入上述信息。某些客户端（如Cursor）可能提供简化的导入流程，例如通过特定的命令字符串自动配置。

基本使用方法

一旦MCP服务器在客户端成功配置并连接，LLM代理将能够发现并了解该服务器提供的所有工具（通过服务器的能力声明）。

发现工具: LLM代理会通过协议查询服务器，获取可用工具的列表及其描述、参数和返回值信息。
调用工具: 当需要执行与WorkOS相关的任务时（例如，“列出我们组织的所有用户”），LLM代理会根据其理解和可用的工具信息，构造一个JSON-RPC请求，调用相应的工具（例如'listUsers'），并提供必要的参数（例如组织ID）。
处理响应: 服务器执行工具方法后，会将结果通过JSON-RPC响应返回给客户端。LLM代理会解析响应，并根据需要利用返回的数据完成任务。

例如，要让代理列出用户，你可能会在客户端界面中提出相应的请求，代理则会调用服务器上的'listUsers'工具来获取数据并呈现给你。

关键词