workos-mcp

workos-mcp

site icon
2025.05.01 2
TypeScript模型控制协议API 代理开发效率
workos-mcp 是一个轻量级的模型控制协议(MCP)服务器,基于 [create-mcp](https://github.com/zueai/create-mcp) 构建,并部署在 Cloudflare Workers 上。该服务器允许代理(如 Cursor Agents)与 [WorkOS API](https://workos.com/docs/reference) 进行交互。
View on GitHub

Overview

基本能力

产品定位

workos-mcp 是一个轻量级的模型控制协议(MCP)服务器,旨在为代理(如 Cursor Agents)提供与 WorkOS API 交互的能力。

核心功能

  1. 工具扩展:通过向 MyWorker 类添加方法,可以轻松创建新的 MCP 工具。
  2. 自动化部署:支持通过脚本快速部署到 Cloudflare Workers。
  3. API 集成:与 WorkOS API 集成,提供丰富的功能扩展。

适用场景

  1. 开发工具集成:为开发工具(如 Cursor)提供扩展功能。
  2. 自动化工作流:通过 MCP 工具实现自动化任务。
  3. API 代理:作为 WorkOS API 的代理服务器,简化 API 调用。

工具列表

工具列表位于 src/index.ts 文件中,每个 MyWorker 类的方法都是一个 MCP 工具。工具的具体功能由方法的实现决定。

常见问题解答

  1. 如何创建新工具?:在 src/index.tsMyWorker 类中添加方法,并确保有正确的 JSDoc 注释。
  2. 如何部署更改?:运行 bun run deploy 并重新加载 Cursor 窗口。
  3. 如何上传 API 密钥?:使用 bunx wrangler secret put 命令上传 WorkOS API 密钥和客户端 ID。

使用教程

使用依赖

  1. 确保已安装 Bun 运行时环境。
  2. 确保已安装 Wrangler CLI 工具。

安装教程

  1. 运行以下命令克隆并部署 MCP 服务器:
bun create mcp --clone https://github.com/zueai/workos-mcp
  1. 在 Cursor 设置中添加新的 MCP 服务器,并粘贴复制的命令。
  2. 上传 WorkOS API 密钥和客户端 ID:
bunx wrangler secret put WORKOS_API_KEY
bunx wrangler secret put WORKOS_CLIENT_ID

调试方式

  1. 部署更改后,运行以下命令:
bun run deploy
  1. 重新加载 Cursor 窗口以使用更新的工具。

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。