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

# MCP Tools

> What an AI assistant connected to Lucca can do: every MCP tool, the scopes it needs, and whether it is available yet.

> [!WARNING]
>
> The Lucca MCP server is in **beta** and may change without notice: tools may be added, renamed or removed,
> and their capabilities or required scopes may change.

Once [connected](https://developers.luccasoftware.com/documentation/mcp/setup.md), your AI assistant calls these tools to answer your questions. Every tool is read-only
and answers with what your Lucca account may see, nothing more.

* **Available**: you can use it today (54 tools).
* **Incoming**: built and on its way to production (20 tools).
* **Planned**: coming later (36 tools).

A tool shows up only when your client holds **all** the scopes in its row.
To add scopes later, see [Troubleshooting](https://developers.luccasoftware.com/documentation/mcp/setup.md#troubleshooting).

## Absences

Leaves, balances, public holidays and absence rates.

| Tool | What it does | Scopes | State |
| :- | :- | :- | :- |
| **Absence dates** | Shows the absence dates of one or more employees. | `leaves.readonly` | Available |
| **Absence reasons breakdown** | Shows a team's absence reasons over a period. | `leaves.readonly` | Available |
| **Absent employees on a day** | Shows the employees who are absent on a given day. | `leaves.readonly` | Available |
| **Daily calendar** | Shows an employee's day-by-day calendar: leave, public holidays and days off. | `leaves.readonly` | Available |
| **Days and hours worked** | Computes the days and hours worked over a period. | `leaves.readonly` | Available |
| **Employees by leave balance** | Finds the employees who have at least a given leave balance. | `leaves.readonly` | Available |
| **Leave accrual forecast** | Shows the leave an employee will accrue over the next 12 months. | `leaves.readonly` | Available |
| **Leave balances** | Shows an employee's leave balances. | `leaves.readonly` | Available |
| **Absence rate** | Computes the absence rate of a population over a period. | `departments.readonly` `employees.readonly` `leaves.readonly` | Incoming |
| **Public holidays** | Shows the public holidays that apply to an employee over a period. | `leaves.readonly` | Incoming |
| **Leave accounts** | Lists the leave accounts and their units. | `leaves.readonly` | Planned |
| **Leave accrual rules** | Shows the leave accrual rules that apply to an employee. | `leaves.readonly` | Planned |
| **Leave balance history** | Shows the history of leave balance movements. | `leaves.readonly` | Planned |
| **Leave policy** | Shows the leave policy that applies to an employee. | `leaves.readonly` | Planned |

## Employees

Who works here, their jobs, contracts, managers and headcount.

| Tool | What it does | Scopes | State |
| :- | :- | :- | :- |
| **Career history** | Lists an employee's successive job titles, qualifications and managers. | `employees.readonly` `job-positions.readonly` | Available |
| **Contract types** | Lists the company's contract types with their headcount. | `employment-templates.readonly` `employments.readonly` | Available |
| **Contracts ending** | Finds the employees whose contract ends within a date range. | `employees.readonly` `employment-templates.readonly` `employments.readonly` `job-positions.readonly` | Available |
| **Custom HR fields** | Lists the company's own custom HR fields. | `employee-attribute-definitions.readonly` | Available |
| **Editable HR file fields** | Lists the HR file fields and whether each one can be edited. | `employee-attribute-definitions.readonly` | Available |
| **Email addresses** | Lists employee email addresses. | `employees.readonly` | Available |
| **Employee HR file (sensitive data withheld)** | Shows an employee's HR file, without bank details, social security number, pay, personal contact details or custom fields. | `employees.readonly` | Available |
| **Employees by contract type** | Lists the employees on a given contract type. | `employees.readonly` `employments.readonly` | Available |
| **Employees without a photo** | Lists the employees with no profile picture. | `employees.readonly` | Available |
| **Find employees** | Finds employees by name, department or manager. | `employees.readonly` | Available |
| **Headcount by establishment** | Counts employees per establishment. | `business-establishments.readonly` `employees.readonly` | Available |
| **Headcount by legal unit** | Counts employees per legal unit. | `employees.readonly` `legal-entities.readonly` | Available |
| **HR file fields** | Lists every employee field. | `employee-attribute-definitions.readonly` | Available |
| **HR file link** | Gives the link to the HR file page for a given field. | `employees.readonly` | Available |
| **Job titles** | Lists employees with their job title, qualification, establishment and department. | `employees.readonly` | Available |
| **Manager's team history** | Lists the employees a manager manages, managed in the past or will manage. | `employees.readonly` `job-positions.readonly` | Available |
| **Number of supervised employees** | Counts the employees a manager supervises, per reporting level. | `employees.readonly` | Available |
| **Supervised employees** | Lists the employees a manager supervises, grouped by level. | `employees.readonly` | Available |
| **Upcoming birthdays** | Lists employee birthdays (day and month), soonest first. | `employees.readonly` | Available |
| **Work contract details** | Shows an employee's current work contract and trial period dates. | `employees.readonly` `employments.readonly` | Available |
| **Headcount by department** | Counts employees per department. | `departments.readonly` `employees.readonly` | Incoming |
| **HR file sections** | Lists the sections and keywords of the HR file page. | `employee-attribute-definitions.readonly` | Incoming |
| **Job changes** | Finds the employees who changed job or qualification over a period. | `employees.readonly` `job-positions.readonly` | Incoming |

## Organization

Departments, establishments, legal entities, job qualifications and roles.

| Tool | What it does | Scopes | State |
| :- | :- | :- | :- |
| **A person's teams** | Lists the teams a person belongs to. | `departments.readonly` `employees.readonly` | Available |
| **Departments** | Lists departments with their parent, head and level. | `departments.readonly` | Available |
| **Establishments** | Lists establishments and their country. | `business-establishments.readonly` | Available |
| **Find teams** | Finds establishments, departments and groups by name. | `business-establishments.readonly` `departments.readonly` | Available |
| **Job qualifications** | Lists the job qualifications. | `job-qualifications.readonly` | Available |
| **Legal units** | Lists legal units and their country. | `legal-entities.readonly` | Available |
| **Role details** | Shows a role's category, holders, establishments and modules. | `roles.readonly` | Incoming |
| **Role history** | Shows a person's role assignments over time. | `employees.readonly` `roles.readonly` | Incoming |
| **Role permissions** | Shows the detailed permissions and scopes of a role. | `employees.readonly` `roles.readonly` | Incoming |
| **User roles** | Shows the roles held by one or more people. | `employees.readonly` `roles.readonly` | Incoming |

## Employee groups

The groups employees belong to.

| Tool | What it does | Scopes | State |
| :- | :- | :- | :- |
| **User groups** | Lists user groups and their members. | `employee-groups.readonly` | Incoming |

## Working locations

Offices, remote work and who is where.

| Tool | What it does | Scopes | State |
| :- | :- | :- | :- |
| **Area occupancy** | Shows how the areas of a site are occupied on a date. | `working-locations.readonly` | Incoming |
| **My weekly work pattern** | Shows your usual work location for each day of the week. | `working-locations.readonly` | Incoming |
| **Offices** | Shows office details: address, capacity and access. | `working-locations.readonly` | Incoming |
| **People on site** | Shows who is in each area of a site on a date. | `working-locations.readonly` | Incoming |
| **Remote today** | Lists the people working remotely today. | `working-locations.readonly` | Incoming |
| **Remote work policy** | Shows the remote work policy and its current state. | `working-locations.readonly` | Incoming |
| **Site occupancy** | Shows a site's occupancy day by day. | `working-locations.readonly` | Incoming |
| **Work locations** | Lists the work locations. | `working-locations.readonly` | Incoming |
| **Work locations by person** | Shows where people work over a date range. | `employees.readonly` `working-locations.readonly` | Incoming |

## HR indicators

Headcount, turnover, seniority and other HR indicators, month by month.

| Tool | What it does | Scopes | State |
| :- | :- | :- | :- |
| **Absenteeism rate** | Shows the absenteeism rate. | `indicators.readonly` | Available |
| **Attrition rate** | Shows the overall attrition rate. | `indicators.readonly` | Available |
| **Average age** | Shows the average age of employees. | `indicators.readonly` | Available |
| **Average age at departure** | Shows the average age of employees when they leave. | `indicators.readonly` | Available |
| **Average seniority** | Shows the average seniority of employees. | `indicators.readonly` | Available |
| **Average seniority at departure** | Shows the average seniority of employees when they leave. | `indicators.readonly` | Available |
| **Departure reasons** | Shows the breakdown of contract end reasons. | `indicators.readonly` | Available |
| **Employees by occupation category** | Lists employees by occupation category. | `indicators.readonly` | Available |
| **Full-time equivalent headcount** | Shows the headcount in full-time equivalent. | `indicators.readonly` | Available |
| **Headcount** | Shows the total headcount for a given month. | `indicators.readonly` | Available |
| **Headcount by contract type** | Shows how the headcount changes over time by contract type. | `indicators.readonly` | Available |
| **Headcount by department** | Shows how the headcount changes over time by department. | `indicators.readonly` | Available |
| **Headcount by gender** | Shows the headcount broken down by gender. | `indicators.readonly` | Available |
| **Headcount by gender and age** | Shows the headcount broken down by gender and age. | `indicators.readonly` | Available |
| **Headcount by gender and seniority** | Shows the headcount broken down by gender and seniority. | `indicators.readonly` | Available |
| **Headcount by occupation category** | Shows the headcount broken down by occupation category. | `indicators.readonly` | Available |
| **Hiring reasons** | Shows the breakdown of hiring and contract start reasons. | `indicators.readonly` | Available |
| **Net attrition rate** | Shows the net attrition rate. | `indicators.readonly` | Available |
| **Retention rate** | Shows the employee retention rate. | `indicators.readonly` | Available |
| **Turnover rate** | Shows the turnover rate. | `indicators.readonly` | Available |

## Payslips

Where to find your payslips.

| Tool | What it does | Scopes | State |
| :- | :- | :- | :- |
| **Payslip link** | Gives the link to the payslip download page. | `payslips.readonly` | Incoming |

## Engagement surveys

Surveys, their questions, participants and settings.

| Tool | What it does | Scopes | State |
| :- | :- | :- | :- |
| **Survey details** | Shows information about a survey. | `surveys.readonly` | Planned |
| **Survey participants** | Lists the employees a survey was sent to, never who answered. | `employees.readonly` `surveys.readonly` | Planned |
| **Survey questions** | Lists the questions of a survey. | `surveys.readonly` | Planned |
| **Survey settings** | Shows a survey's full configuration and its questions. | `surveys.readonly` | Planned |
| **Survey template questions** | Lists the questions of a survey template. | `surveys.readonly` | Planned |
| **Survey templates** | Lists the ready-made survey templates provided by Lucca. | `surveys.readonly` | Planned |
| **Surveys** | Lists every survey, whatever its status. | `surveys.readonly` | Planned |

## Performance reviews

Review campaigns, reviews and peer feedback.

| Tool | What it does | Scopes | State |
| :- | :- | :- | :- |
| **Campaign overall ratings** | Lists the completed reviews of a campaign with each overall rating. | `performance-reviews.readonly` | Planned |
| **Campaign question analysis** | Analyzes the answers to one question of a review campaign. | `performance-reviews.readonly` | Planned |
| **Campaign results** | Shows a review campaign's questions with their response rate and distribution. | `performance-reviews.readonly` | Planned |
| **Draft campaign settings** | Shows the full configuration of a review campaign being prepared. | `performance-reviews.readonly` | Planned |
| **Draft campaigns** | Lists the review campaigns still being prepared. | `performance-reviews.readonly` | Planned |
| **Employee reviews** | Lists an employee's performance reviews. | `performance-reviews.readonly` | Planned |
| **Latest completed review** | Shows an employee's most recent review that was actually filled in. | `performance-reviews.readonly` | Planned |
| **My review campaigns** | Lists the launched review campaigns where you are a reviewer. | `performance-reviews.readonly` | Planned |
| **Peer feedback** | Shows the peer (360) feedback written about an employee for a review. | `performance-reviews.readonly` | Planned |
| **Review content** | Shows the full content of a performance review. | `performance-reviews.readonly` | Planned |

## Recruitment

Job candidates.

| Tool | What it does | Scopes | State |
| :- | :- | :- | :- |
| **Candidate profile** | Shows a candidate's evaluations, scorecards and applications. | `job-candidates.readonly` | Planned |

## Skills

Skill scales and the skills assessed for an employee.

| Tool | What it does | Scopes | State |
| :- | :- | :- | :- |
| **Assessed skills** | Shows an employee's assessed skills. | `skills.readonly` | Planned |
| **Skill levels** | Shows the assessment levels of one or more skills. | `skills.readonly` | Planned |

## Training

Training catalog, plans, sessions, participants, costs and evaluations.

| Tool | What it does | Scopes | State |
| :- | :- | :- | :- |
| **Completed trainings** | Lists completed trainings. | `courses.readonly` | Planned |
| **Employees' trainings** | Shows the trainings employees attended, with dates and duration. | `courses.readonly` | Planned |
| **Least trained teams** | Ranks departments or managers from the least to the most trained, with their share of trained employees. | `courses.readonly` | Planned |
| **Skill coverage gaps** | Shows how well the training catalog covers each company skill and which jobs expect it. | `courses.readonly` `skills.readonly` | Planned |
| **Training budget tracking** | Tracks a training plan's budget by funding source. | `courses.readonly` | Planned |
| **Training catalog** | Shows the trainings available in the catalog. | `courses.readonly` | Planned |
| **Training catalog overview** | Lists every training in the catalog, one line each. | `courses.readonly` | Planned |
| **Training cost** | Gives the price per participant of a catalogue training and its estimated total cost. | `courses.readonly` | Planned |
| **Training evaluations** | Shows the post-training evaluations of a catalog training. | `courses.readonly` | Planned |
| **Training participants** | Lists a training's participants with session dates and duration. | `courses.readonly` | Planned |
| **Training plans** | Lists training plans and their budget. | `courses.readonly` | Planned |
| **Training sessions** | Lists scheduled training sessions and how full they are. | `courses.readonly` | Planned |


## Related topics

- [Connect an AI Assistant to Lucca](https://developers.luccasoftware.com/documentation/mcp/setup.md)
- [OAuth scopes](https://developers.luccasoftware.com/api-reference/latest/oauth-scopes.md)
