Plan a leave year
plan_leave_yearPlan a whole leave year: the set of breaks that turns the person's annual leave allowance into the most days off, using every bank holiday, with the dates to book for each break and the totals. Handles any leave year start date, part-time working days, three plan styles and school holidays (parents: breaks only in school holidays; school staff: the holidays themselves), from the council's published term dates when you pass council and typical dates otherwise. Use for "Plan my 28 days of leave for 2027, I have kids at school in Leeds".
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "plan_leave_year"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| year | No | Which leave year: current or next. Defaults to current, or next when under 90 days are left. | |
| style | No | mix: two proper holidays of 9+ days, the rest long weekends (default). longWeekends: as many 3–5 day weekends as possible. bigTrips: fewer trips of 9+ days. | mix |
| region | No | Where the person works: england-and-wales, scotland or northern-ireland for UK bank holidays (from gov.uk); IE for Ireland; an Australian state or territory as AU-NSW, AU-VIC, AU-QLD, AU-WA, AU-SA, AU-TAS, AU-ACT or AU-NT (their public holidays differ a lot); US for US federal holidays; or a two-letter ISO 3166-1 country code such as DE or FR for other countries' public holidays (from Nager.Date). Defaults to england-and-wales, or to the council's nation when council is given. | |
| school | No | none (default); parent: children at school, so breaks only in the school holidays; staff: works in a school, so the school holidays are the breaks. UK only. | none |
| council | No | With school: parent or staff. The UK council whose term dates the school follows: its name ("Surrey", "Edinburgh"), its id ("surrey", "city-of-edinburgh") or the first half of a postcode ("GU1", "EH1"), looked up in Leave Hacker's own copy of the ONS list. Send only the first half of a postcode, not the full one. Without it, typical school holidays (Northern Ireland: the Department of Education's dates). | |
| workdays | No | Days the person works, e.g. ["mon","tue","wed","thu"] for a four-day week. Defaults to Monday to Friday. | |
| allowance | No | Days of annual leave (PTO in the US) a year, not counting public holidays. Defaults to the usual for the region: 25 in the UK, 20 in Ireland and Australia (the legal minimum for full-time work), 15 in the US. | |
| days_used | No | Days of this leave year's allowance already taken or booked. Default 0. | |
| us_holidays | No | US only: which holidays the person's employer gives. Private employers choose: common = the usual six (New Year's Day, Memorial Day, Independence Day, Labor Day, Thanksgiving, Christmas); federal = all 11 federal holidays; custom = the ones in us_holiday_ids. Default here: common. | common |
| us_holiday_ids | No | US only, with us_holidays: custom. Any of: new-years-day, mlk-day, washingtons-birthday, memorial-day, juneteenth, independence-day, labor-day, columbus-day, veterans-day, thanksgiving, day-after-thanksgiving, christmas-day (day-after-thanksgiving isn't federal, but many employers give it). | |
| leave_year_starting | No | Instead of year: the calendar year the leave year starts in, e.g. 2027 for January–December 2027 or April 2027–March 2028. | |
| leave_year_start_day | No | Day of the month the leave year starts. Default 1. | |
| next_working_day_off | No | Ireland only: true if the person's employer gives the next working day off when a public holiday falls on a Saturday or Sunday (the civil service and banks do; Irish law doesn't require it, so the employer may give a day within a month, an extra day's leave or a day's pay instead). Adds those days, e.g. Mon 27 and Tue 28 Dec 2027. Default false. | |
| leave_year_start_month | No | Month the leave year starts, 1–12 (1 = January, 4 = April). Default 1. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| notes | Yes | ||
| style | Yes | ||
| breaks | Yes | ||
| budget | Yes | ||
| region | Yes | ||
| school | Yes | ||
| source | Yes | ||
| totals | Yes | ||
| council | Yes | The council whose published dates are used, or null for typical dates | |
| licence | Yes | ||
| daysUsed | Yes | ||
| workdays | Yes | ||
| allowance | Yes | ||
| leaveYear | Yes | ||
| sourceUrl | Yes | ||
| regionName | Yes | ||
| assumptions | Yes | ||
| attribution | Yes | Credit to show with the dates | |
| plannedFrom | Yes | ||
| schoolYears | Yes | Where each school year's dates come from | |
| bankHolidays | Yes | ||
| trainingDays | Yes | The council's staff training (INSET) days: pupils are off, staff work | |
| schoolHolidays | Yes |