Workos MCP

🚀 工作os-mcp

这是一个轻量级的模型控制协议（MCP）服务器，借助 create-mcp 脚本创建，并部署于 Cloudflare Workers 之上。此 MCP 服务器可让代理（例如 Cursor 代理）与 WorkOS API 进行交互。

🚀 快速开始

安装步骤

1. 运行自动化安装脚本，克隆此 MCP 服务器并将其部署到您的 Cloudflare 账户：

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

2. 打开 Cursor Settings -> MCP -> Add new MCP server，然后粘贴命令行界面中复制的命令。
3. 上传您的 WorkOS API 密钥和客户 ID 作为机密：

bunx wrangler secret put WORKOS_API_KEY
bunx wrangler secret put WORKOS_CLIENT_ID

部署更改

1. 运行部署脚本：

bun run deploy

2. 重新加载您的 Cursor 窗口以使用更新的工具。

✨ 主要特性

• 轻量级的 MCP 服务器，便于部署和使用。
• 支持代理与 WorkOS API 交互。
• 可通过在 src/index.ts 中添加方法轻松创建新的 MCP 工具。

📦 安装指南

自动化安装

运行以下命令克隆并部署 MCP 服务器到您的 Cloudflare 账户：

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

配置 Cursor

打开 Cursor Settings -> MCP -> Add new MCP server，粘贴命令行界面中复制的命令。

上传机密信息

上传 WorkOS API 密钥和客户 ID 作为机密：

bunx wrangler secret put WORKOS_API_KEY
bunx wrangler secret put WORKOS_CLIENT_ID

💻 使用示例

查看可用工具

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

创建新的 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 - 实现 MCP 协议的 Cloudflare Workers 包。
• Cloudflare Workers 文档 - 了解 Cloudflare Workers 平台。
• WorkOS 文档 - 了解 WorkOS API。