> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ruby.ad/llms.txt
> Use this file to discover all available pages before exploring further.

# UKG Ready

## Admin Setup

This integration requires read access to your UKG Ready account facilitated via an OAuth Application.

### Creating a New UKG Ready Application

1. Login to UKG Ready and navigate to the "Settings" page > then "Global Setup" and then click "Company Setup":
2. Find the OAuth Applications widget. Create a new one.
3. Choose the "Interactive" Application type. You will see that the OAuth client ID was autogenerated.
4. You will be prompted to add a redirect URL: this url should be [https://app.ruby.ad/oauth/ukg\_ready/finalize](https://app.ruby.ad/oauth/ukg_ready/finalize)

### Setup in Ruby

1. Go to Spaces > Tools in your Ruby workspace, click Add Tools, and select UKG Ready.
2. Provide in the configuration form:
   1. UKG Ready instance URL (e.g: [https://secure.saashr.com](https://secure.saashr.com))
   2. UGK Ready Company ID (e.g '1234567MYUKG00', you can find it in the URL here [https://secure.saashr.com/ta/**1234567MYUKG00**.home](https://secure.saashr.com/ta/**1234567MYUKG00**.home)...)
   3. Client ID from your generated OAuth application

## Available Tools

| **Name** | **Description** |
| :- | :- |
| Get My Info | Retrieve your own employee information including employee ID, name, and username |
| View PTO Requests | List your time-off requests with optional date range filtering. You will be able to view PTO requests submitted by yourself or any of your reports. |
| Create PTO Request | Submit new PTO requests |
| Delete PTO Request | Cancel one or more pending PTO requests. |
| View PTO Request Notes | Read comments/notes attached to a specific PTO request |
| Get Accrual Balances | View available time-off balances (vacation, sick, etc.) for yourself or a specific employee, optionally as of a specific date. |
| Get Schedules | View work schedules for yourself or a specific employee within a date range |
| Get Employees | Retrieve a list of all employees you have permission to view in UKG |

## Limitations

* This MCP server **only supports PTO workflows**. You will not be able to perform the full suite of UKG Ready functionality in Ruby. Please reach out to our support team for any future tool requests.
* Other platforms in the UKG suite, such as UKG Pro, are not supported.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.