Workos MCP

🚀 WorkOS-MCP

A lightweight Model Control Protocol (MCP) server created with the create-mcp script and deployed on Cloudflare Workers.

This MCP server enables agents (such as Cursor agents) to interact with the WorkOS API.

✨ Features

📦 Available Tools

Refer to src/index.ts for the current list of tools. Each method in the MyWorker class is an MCP tool.

📦 Installation

1. Run the automated installation script to clone this MCP server and deploy it to your Cloudflare account:

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

2. Open Cursor Settings -> MCP -> Add new MCP server, then paste the command copied from the command-line interface.
3. Upload your WorkOS API key and client ID as secrets:

bunx wrangler secret put WORKOS_API_KEY
bunx wrangler secret put WORKOS_CLIENT_ID

🚀 Deployment of Changes

1. Run the deployment script:

bun run deploy

2. Then reload your Cursor window to use the updated tools.

💻 Usage Examples

🛠️ How to Create New MCP Tools

To create a new MCP tool, add a method to the MyWorker class in src/index.ts. Each function will automatically become an MCP tool that the agent can use.

Basic Usage

/**
 * A warm and friendly greeting from your MCP worker.
 * @param name {string} The name of the person we're greeting.
 * @return {string} The content of the greeting.
 */
sayHello(name: string) {
    return `Hello from an MCP Worker, ${name}!`;
}

JSDoc comments are important:

• The first line becomes the tool's description.
• The @param tag defines the tool's parameters, types, and descriptions.
• The @return tag specifies the return value and type.

📚 Documentation

Refer to the following resources for more information:

• create-mcp Documentation - Learn about the create-mcp CLI.
• Model Control Protocol Documentation - Understand the Model Control Protocol.
• workers-mcp - The Cloudflare Workers package implementing the MCP protocol.
• Cloudflare Workers Documentation - Learn about the Cloudflare Workers platform.
• WorkOS Documentation - Understand the WorkOS API.