workos-mcp
2025.02.26
3
TypeScriptMCP 服务器WorkOS API 交互开发效率交流协作
workos-mcp 是一个轻量级的 Model Control Protocol (MCP) 服务器，基于 [create-mcp](https://github.com/zueai/create-mcp) 构建，并部署在 Cloudflare Workers 上。该 MCP 服务器允许代理（如 Cursor Agents）与 [WorkOS API](https://workos.com/docs/reference) 进行交互。
### 核心功能
- 提供与 WorkOS API 交互的工具集。
- 支持动态添加新的 MCP 工具。
- 部署在 Cloudflare Workers 上，具有轻量级和高性能的特点。
### 适用场景
- 开发者在需要与 WorkOS API 交互时使用。
- 需要动态扩展工具集的代理程序。
- 需要轻量级和高性能的 MCP 服务器。
View on GitHub
Overview
基本能力
产品定位
workos-mcp 是一个轻量级的 Model Control Protocol (MCP) 服务器，用于与 WorkOS API 交互。
核心功能
- 提供与 WorkOS API 交互的工具集。
- 支持动态添加新的 MCP 工具。
- 部署在 Cloudflare Workers 上，具有轻量级和高性能的特点。
适用场景
- 开发者在需要与 WorkOS API 交互时使用。
- 需要动态扩展工具集的代理程序。
- 需要轻量级和高性能的 MCP 服务器。
工具列表
工具列表位于 src/index.ts 文件中，每个类方法都是一个 MCP 工具。
常见问题解答
无明确常见问题解答，但提供了相关文档链接供参考。
使用教程
使用依赖
无明确前置依赖，但需要 Cloudflare 账户和 WorkOS API 密钥。
安装教程
- 运行自动化安装脚本克隆 MCP 服务器并部署到 Cloudflare 账户：
bun create mcp --clone https://github.com/zueai/workos-mcp
- 打开
Cursor Settings -> MCP -> Add new MCP server并粘贴剪贴板中的命令。 - 上传 WorkOS API 密钥和客户端 ID 作为密钥：
bunx wrangler secret put WORKOS_API_KEY
bunx wrangler secret put WORKOS_CLIENT_ID
调试方式
- 运行部署脚本：
bun run deploy
- 重新加载 Cursor 窗口以使用更新的工具。
创建新的 MCP 工具
在 src/index.ts 中的 MyWorker 类中添加方法，每个函数将自动成为一个 MCP 工具。
示例：
/**
* A warm, friendly greeting from your MCP server.
* @param name {string} the name of the person we are greeting.
* @return {string} the contents of our greeting.
*/
sayHello(name: string) {
return `Hello from an MCP Worker, ${name}!`;
}
JSDoc 注释非常重要：
- 第一行成为工具的描述。
- @param 标签定义工具的参数及其类型和描述。
- @return 标签指定返回值和类型。