https://github.com/zueai/workos-mcp
Lightweight MCP server to give your Cursor Agent access to the WorkOS API.
https://github.com/zueai/workos-mcp
cursor mcp workos
Last synced: 5 months ago
JSON representation
Lightweight MCP server to give your Cursor Agent access to the WorkOS API.
- Host: GitHub
- URL: https://github.com/zueai/workos-mcp
- Owner: zueai
- License: mit
- Created: 2025-02-25T23:49:35.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-02-26T00:38:54.000Z (7 months ago)
- Last Synced: 2025-04-19T18:19:03.763Z (6 months ago)
- Topics: cursor, mcp, workos
- Language: TypeScript
- Homepage:
- Size: 56.6 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- mcp-index - WorkOS MCP Server - Facilitates interactions between agents and the WorkOS API, enabling functionalities like user management and organization handling. (Business Tools)
README
# workos-mcp
This is a lightweight Model Control Protocol (MCP) server bootstrapped with [create-mcp](https://github.com/zueai/create-mcp), and deployed on Cloudflare Workers.
This MCP Server allows agents (like Cursor Agents) to interact with the [WorkOS API](https://workos.com/docs/reference).
## Available Tools
See [src/index.ts](src/index.ts) for the current list of tools. Every method in the class is an MCP tool.
## Installation
1. Run the automated install script to clone this MCP server and deploy it to your Cloudflare account:
```bash
bun create mcp --clone https://github.com/zueai/workos-mcp
```
2. Open `Cursor Settings -> MCP -> Add new MCP server` and paste the command that was copied to your clipboard.
3. Upload your WorkOS API key and client ID as secrets:
```bash
bunx wrangler secret put WORKOS_API_KEY
bunx wrangler secret put WORKOS_CLIENT_ID
```
## Deploying Changes
1. Run the deploy script:
```bash
bun run deploy
```
2. Then reload your Cursor window to use the updated tools.
## How to create new MCP tools
To create new MCP tools, add methods to the `MyWorker` class in `src/index.ts`. Each function will automatically become an MCP tool that your agent can use.
Example:
```typescript
/**
* A warm, friendly greeting from your MCP server.
* @param name {string} the name of the person we are greeting.
* @return {string} the contents of our greeting.
*/
sayHello(name: string) {
return `Hello from an MCP Worker, ${name}!`;
}
```
The JSDoc comments are important:
- First line becomes the tool's description
- `@param` tags define the tool's parameters with types and descriptions
- `@return` tag specifies the return value and type
## Learn More
Check out the following resources to learn more:
- [create-mcp Documentation](https://github.com/zueai/create-mcp) - learn about the create-mcp CLI
- [Model Control Protocol Documentation](https://modelcontextprotocol.io) - learn about the model control protocol
- [workers-mcp](https://github.com/cloudflare/workers-mcp) - the package that implements the MCP protocol for Cloudflare Workers
- [Cloudflare Workers documentation](https://developers.cloudflare.com/workers/) - learn about the Cloudflare Workers platform
- [WorkOS Documentation](https://workos.com/docs) - learn about the WorkOS API