How to Use the UKG Pro MCP in OpenAI Agents SDK

Q: What happens if I try to read employee data with UKG Pro and OpenAI Agents SDK?

If your agent calls employees but provides an ID that doesn't exist in UKG Pro, the server responds with a specific validation error. Your agent can catch this failure and adjust its plan accordingly.

Q: Does the UKG Pro data include organizational details when using OpenAI Agents SDK?

Yep. The organizations tool lets you list out all component units and structures available in UKG Pro. This helps your agent map complex relationships across departments.

Execute HR actions and payroll reads with your AI client using the OpenAI Agents 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 OpenAI Agents SDK

Create your Vinkius account to connect UKG Pro to OpenAI Agents 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 OpenAI Agents SDK

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Check employee details by ID.

When you need specific worker data, call `employees` to pull an individual's profile straight from UKG Pro. This gives your agent direct access to records without manual lookups. You can also query job configurations using `jobs`, pulling a full definition just based on the job code. It’s fast and keeps all that HR logic self-contained within the MCP Server.

Get organizational structure.

Use the `organizations` tool to map out how your company is structured in UKG Pro. This returns a list of component units, letting you understand reporting lines or departmental boundaries. Your agent can then use this structure knowledge to scope other calls. For instance, knowing which org unit holds records before running a payroll query.

Retrieve current pay period data.

The `payroll` tool grabs all the necessary payroll records for the active pay cycle in UKG Pro. It gives your agent immediate access to financial worker data, skipping manual reports. This capability works well when paired with other tools; you can check an employee's details and then immediately pull their associated payroll record via the same MCP Server.

Setup guide

Set up UKG Pro MCP in OpenAI Agents SDK

Prerequisites

Python 3.10+ installed
openai-agents package (pip install openai-agents)
Active Vinkius subscription with a valid endpoint token

1

Install the SDK

Run pip install openai-agents to install the OpenAI Agents SDK. The MCP integration is built-in — no extra dependencies needed.
2

Connect via SSE transport

Use MCPServerSse with your Vinkius endpoint URL. Replace [YOUR_TOKEN_HERE] with your token from cloud.vinkius.com. The SDK auto-discovers all UKG Pro tools at runtime.
3

Create your Agent

Pass the MCP to Agent(mcp_servers=[server]). The agent receives UKG Pro tools as native definitions — JSON schemas resolve automatically.
4

Run the agent

Call Runner.run(agent, prompt) to execute. The agent invokes the appropriate UKG Pro tools and returns structured results. Copy the full example on the right to get started.

agent.py

import asyncio
from agents import Agent, Runner
from agents.mcp import MCPServerSse

async def main():
    async with MCPServerSse(
        url="https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp"
    ) as server:
        agent = Agent(
            name="UKG Pro Agent",
            instructions="You have access to UKG Pro tools.",
            mcp_servers=[server],
        )
        result = await Runner.run(agent, "List recent transactions")
        print(result.final_output)

asyncio.run(main())

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 OpenAI Agents SDK

The MCP Server exposes four specific tools—employee data, job configurations, org structure, and payroll records. Your agent auto-discovers these functions via the OpenAI Agents SDK, letting it use them without needing custom coding.

If your agent calls `employees` but provides an ID that doesn't exist in UKG Pro, the server responds with a specific validation error. Your agent can catch this failure and adjust its plan accordingly.

Yes. The OpenAI Agents SDK includes built-in guardrails that validate the actions your agent takes before they actually run against the MCP Server, making it suitable for deployed products.

Yep. The `organizations` tool lets you list out all component units and structures available in UKG Pro. This helps your agent map complex relationships across departments.

This server handles sensitive HR data, including specific worker profiles (from `employees` and `payroll`) and organizational structures. You'll be dealing with PII and compensation metrics.

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