How to Use the WorkOS MCP in Vercel AI SDK

Q: Can I list all active directory sync instances with WorkOS and Vercel AI SDK?

Yes. You can use listdirectories to pull every running Directory Sync instance. Since you're using the Vercel AI SDK, this whole list streams directly into your React component as soon as it’s ready.

Q: How does WorkOS manage users for the Vercel AI SDK?

The server exposes listdirectoryusers, letting you pull all synced user records. You can then stream this list directly into your application's interface, giving your user immediate access to directory personnel.

Q: Does WorkOS support multiple SSO connections with Vercel AI SDK?

Absolutely. Use listssoconnections to retrieve details for every active Single Sign-On connection. This information streams live, letting your application manage complex enterprise identity setups.

Real-time WorkOS IT data streams directly into your Next.js and React frontends with Vercel AI SDK.

See Vinkius in Action

Works with every AI agent you already use

…and any MCP-compatible client

MCP Servers - Free for Subscribers

Connect WorkOS MCP to Vercel AI SDK

Create your Vinkius account to connect WorkOS to Vercel AI SDK and route execution through our secure gateway. The platform manages server hosting, runtime updates, and security layers. Configuration requires no manual server provisioning.

GDPR Free for Subscribers

Setup WorkOS with Vercel AI SDK

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Get Directory Sync Details

You can call `get_directory_details` to pull metadata for a specific directory instance, showing the name and type. This data appears in real-time on your web page as soon as the API resolves. Building user-facing products means the end user sees this information appear live, without waiting behind a loading spinner.

List All Organizations

Need to check which companies are connected? Use `list_workos_organizations` to pull every organization name in the WorkOS account. The results stream into your UI instantly, giving users immediate visibility across all managed entities. This makes it simple for developers building internal tools; they get a live list of available organizations right on the dashboard.

Check Audit Log Events

`get_audit_log_events` returns every event tracked in an organization's history. This stream provides continuous updates, letting your client display real-time activity logs to the user. It’s perfect for building admin panels where users need immediate confirmation of who did what and when it happened.

Setup guide

Set up WorkOS MCP in Vercel AI SDK

Prerequisites

Node.js 18+ and a TypeScript project
ai + @modelcontextprotocol/sdk packages
Active Vinkius subscription with a valid endpoint token

1

Install dependencies

Run npm install ai @modelcontextprotocol/sdk plus your preferred model provider (e.g. @ai-sdk/openai).
2

Create the Streamable HTTP transport

Use StreamableHTTPClientTransport with your Vinkius endpoint URL. Replace [YOUR_TOKEN_HERE] with your token from cloud.vinkius.com.
3

Discover and use tools

Call mcpClient.tools() to auto-discover all WorkOS tools. Pass them directly to generateText() or streamText() — no manual schema definitions needed.
4

Works with any model provider

Swap openai("gpt-4o") for any AI SDK provider — Anthropic, Google, Mistral. The MCP tools work identically across all supported models.

index.ts

import { experimental_createMCPClient as createMCPClient } from "ai";
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp";
import { generateText } from "ai";
import { openai } from "@ai-sdk/openai";

const transport = new StreamableHTTPClientTransport(
  new URL("https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp")
);

const mcpClient = await createMCPClient({ transport });
const tools = await mcpClient.tools();

const { text } = await generateText({
  model: openai("gpt-4o"),
  tools,
  prompt: "List recent WorkOS transactions",
});

console.log(text);
await mcpClient.close();

Get your connection token →

Independent Platform Disclaimer: Vinkius is an independent platform and is not affiliated with, endorsed by, sponsored by, verified by, or otherwise authorized by WorkOS. All third-party trademarks, logos, and brand names are the property of their respective owners. Their use on this website is strictly for informational purposes to identify service compatibility and interoperability.

Why Choose Vinkius

Vinkius connects your tools to AI with real-time monitoring and automatic cost savings — all from one dashboard.

Connect WorkOS now

Real-time monitoring

Live

visibility into every interaction

Connect your favorite tools to your AI and see exactly what's happening — every request, every response, in real time.

Built-in savings

60%

lower AI costs

Vinkius compresses data between your apps and your AI automatically. Lower bills every month — no configuration required.

Single dashboard

One

place for every integration

Every tool your AI connects to, managed from a single screen. One account, complete control.

Common questions about WorkOS MCP in Vercel AI SDK

The Vercel AI SDK consumes the MCP tool results directly. When you call a function like `get_sso_connection_details`, your front end streams that data live, making the process feel instantaneous for the user.

Yes. You can use `list_directories` to pull every running Directory Sync instance. Since you're using the Vercel AI SDK, this whole list streams directly into your React component as soon as it’s ready.

This server primarily handles directory synchronization metadata, user lists, and organization details. When using the Vercel AI SDK, you're streaming structured IT configuration data to your UI.

The server exposes `list_directory_users`, letting you pull all synced user records. You can then stream this list directly into your application's interface, giving your user immediate access to directory personnel.

Absolutely. Use `list_sso_connections` to retrieve details for every active Single Sign-On connection. This information streams live, letting your application manage complex enterprise identity setups.

Use it with your favorite AI tools

Connect this server to Cursor, Claude, VS Code, and more.

OpenAI Agents SDK sdk-python

Google ADK sdk-python

Pydantic AI sdk-python

Vercel AI SDK sdk-typescript