How to Use the UKG Pro MCP in Vercel AI SDK

Q: How does Vercel AI SDK handle UKG Pro payroll data fetching?

The payroll tool fetches records for the current pay period. Your AI client streams this payload directly to your front end. You get the data right when you need it, without delays.

Q: If I use UKG Pro with Vercel AI SDK, what does the employees tool do?

The employees tool gets a specific employee by their ID. You can call this through your client to fetch and display individual profiles live in the UI.

Show Users Live Data Streams from UKG Pro using 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 UKG Pro MCP to Vercel AI SDK

Create your Vinkius account to connect UKG Pro 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 UKG Pro with Vercel AI SDK

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Displaying Employee Records in Real Time

The `employees` tool lets you fetch a specific employee record just by ID. Your client calls this, and the data streams right into your Next.js or Svelte component. Don't wait for a loading spinner. This real-time stream makes it look like the AI is pulling that employee data live on screen.

Live Payroll Data Streams with Vercel AI SDK

Need to show current pay period records? The `payroll` tool gets those details. Your agent calls this, and the results appear instantly in your frontend UI. This streaming approach means users see the payroll data appearing as it's retrieved, giving a much slicker experience than traditional API loading.

Visualizing Organizational Structure Live

The `organizations` tool lists all organizational components and structures. Stream this structural data directly into your client-side app. This lets you build interactive dashboards where changes in the company structure appear live, without needing a full page refresh.

Setup guide

Set up UKG Pro 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 UKG Pro 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 UKG Pro 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 UKG Pro. 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 UKG Pro 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 UKG Pro MCP in Vercel AI SDK

The `payroll` tool fetches records for the current pay period. Your AI client streams this payload directly to your front end. You get the data right when you need it, without delays.

The `employees` tool gets a specific employee by their ID. You can call this through your client to fetch and display individual profiles live in the UI.

You'll be working with structured records, including employee IDs, job codes, organizational components, and payroll details. The results are streamed as standard JSON payloads.

Yes. Since it uses HTTP transport compatible with Edge Functions, you get fast, reliable data streams from the MCP Server directly into your client-side application.

The server exposes employee records, job configurations, organizational components, and current payroll records. You can pull any of these structured datasets into your application.

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