README

workos-mcp

这是一个轻量级的模型控制协议 (MCP) 服务器，使用 create-mcp 引导，并部署在 Cloudflare Workers 上。

此 MCP 服务器允许代理（如 Cursor Agents）与 WorkOS API 交互。

可用工具

请参阅 src/index.ts 以获取当前工具列表。类中的每个方法都是一个 MCP 工具。

安装

运行自动安装脚本以克隆此 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 工具

要创建新的 MCP 工具，请将方法添加到 src/index.ts 中的 MyWorker 类。每个函数将自动成为您的代理可以使用的 MCP 工具。

示例：

/**
 * 来自您的 MCP 服务器的热情友好的问候。
 * @param name {string} 我们问候的人的名字。
 * @return {string} 我们问候的内容。
 */
sayHello(name: string) {
    return `Hello from an MCP Worker, ${name}!`;
}

JSDoc 注释很重要：

第一行成为工具的描述
@param 标签使用类型和描述定义工具的参数
@return 标签指定返回值和类型

了解更多

查看以下资源以了解更多信息：

create-mcp 文档 - 了解 create-mcp CLI
模型控制协议文档 - 了解模型控制协议
workers-mcp - 实现 Cloudflare Workers 的 MCP 协议的包
Cloudflare Workers 文档 - 了解 Cloudflare Workers 平台
WorkOS 文档 - 了解 WorkOS API

WorkOS MCP Server