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。