Integrate Live UKG Pro HCM Data in the Windsurf IDE via CData Connect AI

Windsurf is an AI-native IDE built around Cascade, an autonomous coding agent that understands project context and executes multi-step tasks directly inside the editor. Cascade supports the Model Context Protocol (MCP), allowing the agent to discover and call external tools and data sources without leaving the development environment.

By integrating Windsurf with CData Connect AI through the built-in MCP server, the Cascade agent gains governed, real-time access to live UKG Pro HCM data. This enables developers to list catalogs, inspect schemas, and query records from UKG Pro HCM data within the IDE using natural language prompts.

This article explains how to configure UKG Pro HCM connectivity in Connect AI, generate the required personal access token, configure the Connect AI MCP Server in Windsurf, and verify the integration by querying live UKG Pro HCM data from the Cascade chat.

Step 1: Configure UKG Pro HCM connectivity for Windsurf

Connectivity to UKG Pro HCM from Windsurf is made possible through Connect AI's Remote MCP Server. To interact with UKG Pro HCM data from Windsurf, 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 Windsurf. 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, Windsurf can now connect to UKG Pro HCM data.

Step 2: Configure Connect AI MCP in Windsurf

Next, configure the Connect AI Remote MCP Server in Windsurf so that the Cascade agent can discover and call live data tools through Connect AI.

1. Download and install the Windsurf IDE
2. Open Windsurf, click your profile icon in the top right, and select Windsurf Settings
3. Under the Cascade section, locate MCP Servers and click Open MCP Registry
4. In the MCP Marketplace, click Add custom MCP in the top right
5. This opens the mcp_config.json file. Paste the following JSON:

   {
       "mcpServers": {
           "cdata-mcp": {
               "serverUrl": "https://mcp.cloud.cdata.com/mcp",
               "headers": {
                   "Authorization": "Basic your_base64_encoded_email_PAT",
                   "Content-Type": "application/json"
               }
           }
       }
   }
   		

   Note: Windsurf will use Basic authentication with Connect AI. Combine your Connect AI user email and the PAT you created earlier in the format email:PAT, base64 encode the combined string, and prefix it with Basic. For example, given [email protected]:ABC123...XYZ789, the Authorization header value becomes something like: Basic dXNlckBkb21haW4uY29tOkFCQzEyMy4uLlhZWjc4OQ==

   
6. Save the mcp_config.json file and return to the MCP Registry
7. Under Installed, confirm that cdata-mcp is listed and marked as Enabled

With the MCP server registered and enabled, Windsurf is ready to query live UKG Pro HCM data through Connect AI.

Step 3: Query live UKG Pro HCM data from Windsurf

With the integration complete, use the Cascade chat panel in Windsurf to interact with live UKG Pro HCM data through natural language prompts.

1. On the top bar of Windsurf, switch from Editor to Agent to open a new Cascade chat
2. At the bottom of the chat panel, confirm that the cdata-mcp server is listed and the toggle is enabled
3. Start interacting with the agent by entering prompts like:
   • List all catalogs in my cdata-mcp connection
   • Show the available schemas and tables for UKG Pro HCM
   • Query the top 5 records from a table in UKG Pro HCM data
4. The Cascade agent calls the Connect AI MCP Server and returns live results from UKG Pro HCM data

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

Get CData Connect AI

To access hundreds of SaaS, Big Data, and NoSQL sources directly from your cloud applications, try CData Connect AI today! Download a free 14-day trial of CData Connect AI today, and as always, our Support Team is available to assist you with any questions you may have.