How to Use the UKG Pro MCP in Mastra AI

Q: What happens if a job code is invalid when using UKG Pro and Mastra AI?

Your workflow can detect this failure. The jobs tool fails gracefully, allowing your agent to execute alternative paths—like notifying an admin instead of failing the whole process.

Q: Can I build a multi-step process with UKG Pro and Mastra AI?

Absolutely. You can chain tools like employees into workflows that require multiple steps, ensuring every action is managed by the built-in workflow engine.

Build Reliable UKG Pro Workflows with Mastra AI.

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 Mastra AI

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

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Handling Complex Payroll Logic

When you need to process payroll data, the `payroll` tool gets records for the current pay period. You can wrap this call in a multi-step workflow that handles retries if the initial fetch fails. This reliability means your complex operations won't fail just because of a temporary network blip; Mastra AI manages the backoff and retry logic.

Conditional Job Configuration Checks

The `jobs` tool fetches specific job configurations using a job code. You can use this in your workflow engine to check conditions—for example, if the job config requires manager approval. This allows for conditional branching: *if* the job code matches X, *then* send a notification; otherwise, proceed.

Multi-step Employee Data Retrieval

You can use the `employees` tool to get an employee by ID. This initial step feeds into subsequent actions in your workflow. You might first fetch the employee profile, then check their organization via the `organizations` tool, all within one self-healing process.

Setup guide

Set up UKG Pro MCP in Mastra AI

Prerequisites

Node.js 18+ and a TypeScript project
@mastra/mcp + @mastra/core packages
Active Vinkius subscription with a valid endpoint token

1

Install dependencies
Run npm install @mastra/mcp @mastra/core plus your preferred model provider (e.g. @ai-sdk/openai).
2

Configure the MCPClient
Create an MCPClient with your Vinkius endpoint as a URL object. Replace [YOUR_TOKEN_HERE] with your token from cloud.vinkius.com.
3

Discover and inject tools
Call mcpClient.listTools() and spread the result into your agent's tools object. All UKG Pro tools become native Mastra tools.
4

Run with any model
Swap openai("gpt-4o") for any AI SDK-compatible provider. Call agent.generate() and the agent routes tool calls through MCP automatically.

agent.ts

import { MCPClient } from "@mastra/mcp";
import { Agent } from "@mastra/core/agent";
import { openai } from "@ai-sdk/openai";

const mcpClient = new MCPClient({
  id: "ukg-pro-mcp-client",
  servers: {
    "ukg-pro-mcp": {
      url: new URL(
        "https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp"
      ),
    },
  },
});

const agent = new Agent({
  name: "UKG Pro Agent",
  model: openai("gpt-4o"),
  instructions: "You have access to UKG Pro tools.",
  tools: {
    ...(await mcpClient.listTools()),
  },
});

const result = await agent.generate(
  "List recent UKG Pro transactions"
);
console.log(result.text);

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 Mastra AI

Mastra AI supports automatic retries with exponential backoff. If the initial `payroll` tool call fails, it won't just stop—it will automatically try again until the operation succeeds.

Your workflow can detect this failure. The `jobs` tool fails gracefully, allowing your agent to execute alternative paths—like notifying an admin instead of failing the whole process.

Absolutely. You can chain tools like `employees` into workflows that require multiple steps, ensuring every action is managed by the built-in workflow engine.

Yes. The framework is designed for handling failure gracefully through conditional branching and retries, making your process robust against temporary errors in the MCP Server.

The server exposes employee records, job configurations, organizational components, and current payroll records. Your workflows can handle these structured types reliably.

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