Interact with Live UKG Pro HCM Data in Meta Muse via CData Connect AI

Muse is Meta's personal AI agent for iOS, Android, and the web, built on the Muse Spark models. It connects to remote model context protocol (MCP) servers, so you can point Muse at a governed data source and let it discover and call live data tools.

Connect Muse to CData Connect AI through its Remote MCP Server, and Muse gains governed, real-time access to live UKG Pro HCM data. You can explore data, fetch records, and interact with objects using natural language prompts, with every request running against authorized sources.

This article shows you how to configure UKG Pro HCM connectivity in Connect AI, generate a personal access token, create a custom connector to the Connect AI Remote MCP Server in Muse, and interact with live UKG Pro HCM data from Muse.

Step 1: Configure UKG Pro HCM connectivity for Meta Muse

Connectivity to UKG Pro HCM from Muse is made possible through Connect AI's Remote MCP Server. To interact with UKG Pro HCM data from Muse, start by creating and configuring a UKG Pro HCM connection in Connect AI.

1. Log into Connect AI, click Sources, and then click Add Connection

2. Select UKG Pro HCM from the Add Connection panel

3. Enter the necessary authentication properties to connect to UKG Pro HCM.

   Start by setting the Profile connection property to the location of the UKGProHCM Profile on disk (e.g. C:\profiles\UKGProHCM.apip). Next, set the ProfileSettings connection property to the connection string for UKGProHCM (see below).

   UKGProHCM API Profile Settings

   UKG Pro HCM uses Basic authentication combined with a customer API key to authorize access to the API. To connect, you will need your UKG Pro HCM credentials and a customer API key issued by UKG.

   Set the following connection properties to authenticate:

   • AuthScheme: Set this to Basic.
   • User: Set this to your UKG Pro HCM username.
   • Password: Set this to your UKG Pro HCM password.
   • ProfileSettings: Set this to a semicolon-separated list containing:
     • Host: Your UKG Pro HCM tenant hostname (e.g., yourcompany.ultipro.com).
     • CustomerAPIKey: Your UKG customer API key. This is passed as the US-CUSTOMER-API-KEY request header on each API call.

   To obtain your customer API key, contact your UKG Pro HCM administrator or refer to the UKG Developer Portal at https://developer.ukg.com.

   
4. Click Save & Test
5. Navigate to the Permissions tab and update user-based permissions

Add a Personal Access Token

A Personal Access Token (PAT) is used to authenticate the connection to Connect AI from Muse. It is best practice to create a separate PAT for each integration to maintain granular access control.

1. Click the gear icon () at the top right of the Connect AI app to open Settings
2. On the Settings page, go to the Access Tokens section and click Create PAT
3. Give the PAT a descriptive name and click Create

4. Copy the token when displayed and store it securely. It will not be shown again

With the UKG Pro HCM connection configured and a PAT generated, Muse can now connect to UKG Pro HCM data through Connect AI.

Step 2: Create a custom connector to the Connect AI MCP Server in Meta Muse

Muse has no manual "add MCP server" form. Instead, you ask Muse in plain language to build a custom connector that points at the Connect AI Remote MCP Server, a hosted, public HTTPS endpoint that speaks streamable HTTP. Muse builds the connector on its secure VM using the official MCP SDK, then discovers and calls the available Connect AI data tools.

1. Open Muse on iOS, Android, or the web and start a new chat
2. Ask Muse to build a custom connector to the Connect AI Remote MCP Server, giving it the server URL and noting that the endpoint is a hosted MCP server over streamable HTTP, for example:
   Create a custom connector to CData Connect AI. It is a hosted MCP server over streamable HTTP at https://mcp.cloud.cdata.com/mcp and it requires an Authorization header.
3. When Muse prompts for credentials, it opens a secure entry flow, separate from the chat, that saves the value in its Secure Credentials Store. Enter the Authorization header value in the format Basic your_base64_encoded_email_PAT

   Note: For the Authorization value, base64 encode email:PAT and prefix it with Basic. Enter it only in Muse's secure credential prompt, never in the chat.

4. Muse connects to the Connect AI MCP Server and lists the available data tools. Review the custom connector confirmation, then click Continue. When Muse offers to save the integration as a skill, choose yes so the connector is available in every future chat

With the custom connector saved, the Connect AI tools are available to Muse in any chat.

Step 3: Interact with live UKG Pro HCM data from Meta Muse

With the integration complete, interact with live UKG Pro HCM data directly from Muse through natural language prompts.

1. In a Muse chat, type a prompt that uses the Connect AI connector, for example:
   • Use the CData Connect AI connector to list all available connections
   • Show the available objects and fields for UKG Pro HCM
   • Fetch the top 5 records from UKG Pro HCM
2. Approve the tool call in the Sentinel dialog when prompted
3. Muse calls the Connect AI MCP Server and returns live results from UKG Pro HCM data

At this point, Muse communicates with the Connect AI MCP Server and retrieves live UKG Pro HCM data through remote MCP tools directly from your chats.

Get started with CData Connect AI

With CData Connect AI, interact with hundreds of SaaS, big data, and NoSQL sources directly from your AI agents, models, and cloud applications. To explore more download a free 14-day trial today. Our Support Team is available to help with any questions you have.