Connect your AI Agents to UKG Pro WFM in minutes

Merge lets you securely connect your agents to UKG Pro WFM and thousands of tools instantly

Available tools

list_leave_cases

List leave cases (extended absences) for a date range. Returns leave type, dates, and status. Use cursor from page_info for the next page.

get_leave_case

Get a single leave case by ID. Returns leave type, dates, status, and notes. Use list_leave_cases to find valid leave case IDs.

create_leave_case

Create a new leave case for an employee. Use list_persons for employee IDs. Provide leave_type_id, start_date, and optionally end_date.

list_accrual_balances

List accrual/PTO balances for employees as of a given date. Returns current and projected balances per accrual code (VACATION, SICK, etc.). Use cursor from page_info for the next page.

list_persons

List persons (employees) in UKG Pro WFM for a date range. Returns person details including name, job, and location. Use cursor from page_info for next page.

get_person

Get a single person's details by person ID. Returns name, job, location, hire date, and employment status. Use list_persons to find valid IDs.

create_person

Create a new person (employee) in UKG Pro WFM. Use list_jobs and list_locations to find valid job and location IDs.

update_persons

Update one or more persons in UKG Pro WFM. Each update object must include 'id' and the fields to change. Use list_persons to find valid person IDs.

list_jobs

List jobs (work roles) defined in UKG Pro WFM. Returns job ID, name, and status. Use these IDs when creating or updating persons and schedules.

list_locations

List work locations defined in UKG Pro WFM. Returns location ID, name, and address. Use these IDs when creating persons and schedules.

list_hyperfinds

List saved hyperfind employee queries in UKG Pro WFM. Returns query ID and name. Use execute_hyperfind to run a query and get the matching employees.

execute_hyperfind

Execute a saved hyperfind query to get the matching employees. Returns a list of person references. Use list_hyperfinds to find valid hyperfind IDs.

list_schedules

List scheduled shifts for a date range. Returns shift start/end times, employee, job, and location. Use cursor from page_info for the next page.

create_schedule

Create a scheduled shift for an employee. Use list_persons, list_jobs, and list_locations to find valid IDs.

delete_schedules

Delete one or more scheduled shifts by shift ID. Use list_schedules to find valid shift IDs.

list_shift_swap_requests

List shift swap requests for a date range. Returns requestor, recipient, shift details, and approval status. Use cursor from page_info for the next page.

list_timecards

List timecards for a date range. Returns timecard summaries with hour totals and status. Use cursor from page_info for the next page.

get_timecard

Get the timecard for a specific employee and pay period. Returns daily entries, totals, and approval status. Use list_persons to find valid employee IDs.

update_timecard

Update a timecard for an employee in a pay period. Supply timecard_data with the fields to change per the API spec. Use get_timecard to review the current state first.

list_punches

List time punches (clock-in/out events) for a date range. Returns punch type, timestamp, and labor account. Use cursor from page_info for the next page.

import_punches

Import time punches into UKG Pro WFM. Each punch must include employeeId, punchDateTime (ISO 8601), and punchType (IN, OUT, TRANSFER).

validate_credential

Validate UKG Pro WFM credentials by verifying hostname, client credentials, and user account. Returns success or a specific error message.

View all tools by creating a free accountSee more tools

How to set up Merge Agent Handler

In an mcp.json file, add the configuration below, and restart Cursor.

Learn more in the official documentation ↗

1{
2  "mcpServers": {
3    "agent-handler": {
4      "url": "https://ah-api-develop.merge.dev/api/v1/tool-packs/{TOOL_PACK_ID}/registered-users/{REGISTERED_USER_ID}/mcp",
5      "headers": {
6        "Authorization": "Bearer yMt*****"
7      }
8    }
9  }
10}
11
Copy Code

Open your Claude Desktop configuration file and add the server configuration below. You'll also need to restart the application for the changes to take effect.

Make sure Claude is using the Node v20+.

Learn more in the official documentation ↗

1{
2  "mcpServers": {
3    "agent-handler": {
4      "command": "npx",
5      "args": [
6        "-y",
7        "mcp-remote@latest",
8        "https://ah-api-develop.merge.dev/api/v1/tool-packs/{TOOL_PACK_ID}/registered-users/{REGISTERED_USER_ID}/mcp",
9        "--header",
10        "Authorization: Bearer ${AUTH_TOKEN}"
11      ],
12      "env": {
13        "AUTH_TOKEN": "yMt*****"
14      }
15    }
16  }
17}
Copy Code
Copied!

Open your Windsurf MCP configuration file and add the server configuration below.
Click on the refresh button in the top right of the Manage MCP server page or in the top right of the chat box in the box icon.

Learn more in the official documentation ↗

1{
2    "mcpServers": {
3      "agent-handler": {
4        "command": "npx",
5        "args": [
6          "-y",
7          "mcp-remote@latest",
8          "https://ah-api.merge.dev/api/v1/tool-packs/<tool-pack-id>/registered-users/<registered-user-id>/mcp",
9          "--header",
10          "Authorization: Bearer ${AUTH_TOKEN}"
11        ],
12        "env": {
13          "AUTH_TOKEN": "<ah-production-access-key>"
14        }
15      }
16    }
17  }
Copy Code

In Command Palette (Cmd+Shift+P on macOS, Ctrl+Shift+P on Windows), run "MCP: Open User Configuration".

You can then add the configuration below and press "start" right under servers. Enter the auth token when prompted.

Learn more in the official documentation ↗

1{
2  "inputs": [
3    {
4      "type": "promptString",
5      "id": "agent-handler-auth",
6      "description": "Agent Handler AUTH_TOKEN", // "yMt*****" when prompt
7      "password": true
8    }
9  ],
10  "servers": {
11    "agent-handler": {
12      "type": "stdio",
13      "command": "npx",
14      "args": [
15        "-y",
16        "mcp-remote@latest",
17        "https://ah-api-develop.merge.dev/api/v1/tool-packs/{TOOL_PACK_ID}/registered-users/{REGISTERED_USER_ID}/mcp",
18        "--header",
19        "Authorization: Bearer ${input:agent-handler-auth}"
20      ]
21    }
22  }
23}
Copy Code

FAQs on using Merge's UKG Pro WFM  MCP server

FAQs on using Merge's UKG Pro WFM  MCP server

What is a UKG Pro WFM MCP?

It's an MCP server that connects your agents to workforce management data and functionality in UKG Pro WFM via tools. Your agents can invoke these tools to retrieve employee schedules, query timecard data, track shift assignments, manage time-off requests, and more.

UKG doesn't offer an MCP server purpose built for UKG Pro WFM, but you can use one from a third-party platform, like Merge Agent Handler.

How can I use the UKG Pro WFM MCP server?

The use cases naturally depend on the agent you've built, but here are a few common ones:

  • Shift coverage alerts: When an employee calls out sick via a messaging tool, an agent queries UKG Pro WFM for open shifts on that day, identifies available employees based on schedule and labor rules, and sends targeted coverage requests, reducing the time managers spend manually finding replacements
  • Timecard exception reporting: On a scheduled basis, an agent pulls timecard data from UKG Pro WFM, flags exceptions such as missed punches or overtime thresholds, and posts a structured summary to a manager's Slack channel so issues get resolved before payroll closes
  • Cross-system schedule sync: When a new shift template is created in UKG Pro WFM, an agent retrieves the updated schedule and pushes it to a project management tool or external calendar, keeping operational plans aligned without manual exports
  • Labor cost summaries for operations leaders: An agent aggregates hours worked and pay category data from UKG Pro WFM across departments, then delivers a weekly labor cost digest to operations leadership, giving them current figures without requiring direct system access

What are popular tools for UKG Pro WFM's MCP server?

Here are some of the most commonly used tools:

  • list_employee_schedules: retrieves scheduled shifts for employees across a defined date range and location. Useful for agents that need to assess coverage levels or detect gaps before taking an action in another system
  • get_timecard_data: fetches timecard records including punch times, pay categories, and hours worked for a given employee and period. Call this when an agent needs to verify hours before generating a report or flagging an exception
  • list_shift_assignments: returns shift assignment records tied to specific employees, job codes, or departments. Good for workflows that need to match open shifts with available workers or validate staffing against demand forecasts
  • list_time_off_requests: pulls pending and approved time-off requests from UKG Pro WFM. Helpful when an agent needs to factor leave into scheduling decisions or surface upcoming coverage gaps to a manager
  • get_labor_categories: retrieves the labor category definitions configured in UKG Pro WFM, such as pay codes and job classifications. Use this when an agent needs to label or route work records accurately before posting to a downstream system
  • list_employee_availability: returns employee availability preferences and constraints. Call this when an agent is filling an open shift and needs to filter candidates by who is eligible to work before sending a coverage request

What makes Merge Agent Handler's UKG Pro WFM MCP server better than alternative UKG Pro WFM MCP servers?

There are several reasons to choose Merge Agent Handler's UKG Pro WFM MCP server over building or relying on an alternative:

  • Enterprise-grade security and DLP: Merge Agent Handler includes built-in data loss prevention controls that let you block or redact sensitive fields before they reach an agent. For UKG Pro WFM, this means you can prevent employee pay rates, personal identifiers, or disciplinary flags from being surfaced to agents that have no reason to see that data
  • Managed authentication and credentials: Merge stores and refreshes your UKG Pro WFM credentials on your behalf. You never expose raw API keys or OAuth tokens to an agent, and you don't need to build token rotation logic yourself
  • Real-time observability and audit trail: Every tool call made against UKG Pro WFM is logged with timestamp, tool name, input parameters, and response metadata. You know exactly which schedule records or timecard entries an agent read, without adding any custom instrumentation to your pipeline
  • Tool Packs and controlled access: Tool Packs let you bundle specific UKG Pro WFM tools with tools from other connectors into a single MCP endpoint, scoped to a particular workflow. A scheduling agent gets exactly the shift and availability tools it needs, with no access to payroll or compensation data it shouldn't touch

How can I start using Merge Agent Handler's UKG Pro WFM MCP server?

You can take the following steps (assuming you use Claude Code):

1. Create or log into your Merge Agent Handler account.

2. Install the Merge CLI by running pipx install merge-api, then run merge configure to link the CLI to your Merge account and merge login to authenticate your session.

3. Register the Agent Handler MCP server with Claude Code by running claude mcp add --transport http agent-handler https://ah-api.merge.dev/mcp, then open Claude Code and run /mcp to confirm agent-handler appears with a connected status.

4. Select agent-handler from the MCP list. This opens a browser window where you select which integrations to authenticate. Choose UKG Pro WFM and complete the auth flow. Merge stores and manages the credentials going forward.

5. Open a Claude Code session and start querying UKG Pro WFM data directly. The first time you use a UKG Pro WFM tool, a Magic Link may appear to complete connector authentication.

If you want to connect Merge Agent Handler's UKG Pro WFM MCP with internal or customer-facing agentic products, you can follow the steps in our docs.

Can employees use Merge Agent Handler to connect their AI tools to UKG Pro WFM?

Yes, Agent Handler for Employees lets your employees connect Claude, ChatGPT, Microsoft Copilot, Cursor, and other MCP-compatible AI tools to UKG Pro WFM without bypassing IT governance.

Instead of setting up direct connections with personal credentials that IT can't monitor or revoke, each employee authenticates through Agent Handler and gets individual credentials tied to their identity. A frontline operations manager can ask their AI to pull up the week's schedule, flag timecard exceptions, or check staffing levels, all within the permissions IT has defined.

IT also provisions access by role or group via SCIM. A workforce planner, for example, gets UKG Pro WFM access to manage schedules and labor forecasts, Slack to coordinate with team leads, and Google Sheets to track headcount metrics; while a payroll analyst gets UKG Pro WFM access to pull timecard and pay category data, ADP to process payroll runs, and Workday to reconcile compensation records.

Every tool call an employee's AI makes to UKG Pro WFM is also inspected against your DLP rules and logged to a searchable audit trail, giving security teams full visibility into what data was accessed and by whom.

Explore other MCP servers built and managed by Merge

sharepoint
SharePoint
sharepoint_gcc
SharePoint GCC High
shopify
Shopify
slack
Slack
smartrecruiters
SmartRecruiters
smartsheet
Smartsheet
snowflake
Snowflake
spotify
Spotify
square
Square
straker
Straker
strava
Strava
stripe
Stripe
supabase
Supabase
teamwork
Teamwork.com
trello
Trello
tripadvisor
TripAdvisor
ukg_pro
UKG Pro
ukg_pro_hcm_recruit
UKG Pro HCM Recruitment & Onboarding
vercel
Vercel
vestaboard
Vestaboard
visualping
VisualPing
weather
Weather
webflow
Webflow
whoop
WHOOP

Ready to try it out?

Whether you're an engineer experimenting with agents or a product manager looking to add tools, you can get started for free now