list-payroll-leave-types

Instructions

Implementation Reference

• src/tools/list/list-payroll-leave-types.tool.ts:5-47 (handler)

  Main tool handler: defines the 'list-payroll-leave-types' tool using CreateXeroTool. Includes empty input schema, description, and async executor that calls the Xero handler, handles errors, and formats leave types as text blocks.

  const ListPayrollLeaveTypesTool = CreateXeroTool(
    "list-payroll-leave-types",
    "Lists all available leave types in Xero Payroll. This provides information about all the leave categories configured in your Xero system, including statutory and organization-specific leave types.",
    {},
    async () => {
      const response = await listXeroPayrollLeaveTypes();
      if (response.isError) {
        return {
          content: [
            {
              type: "text" as const,
              text: `Error listing payroll leave types: ${response.error}`,
            },
          ],
        };
      }
  
      const leaveTypes = response.result;
  
      return {
        content: [
          {
            type: "text" as const,
            text: `Found ${leaveTypes?.length || 0} payroll leave types:`,
          },        ...(leaveTypes?.map((leaveType: LeaveType) => ({
            type: "text" as const,
            text: [
              `Leave Type: ${leaveType.name || "Unnamed"}`,
              `Leave Type ID: ${leaveType.leaveTypeID || "Unknown"}`,
              leaveType.isPaidLeave !== undefined ? `Is Paid Leave: ${leaveType.isPaidLeave ? 'Yes' : 'No'}` : null,
              leaveType.showOnPayslip !== undefined ? `Show On Payslip: ${leaveType.showOnPayslip ? 'Yes' : 'No'}` : null,
              leaveType.isActive !== undefined ? `Is Active: ${leaveType.isActive ? 'Yes' : 'No'}` : null,
              leaveType.typeOfUnits ? `Type Of Units: ${leaveType.typeOfUnits}` : null,
              leaveType.typeOfUnitsToAccrue ? `Type Of Units To Accrue: ${leaveType.typeOfUnitsToAccrue}` : null,
              leaveType.updatedDateUTC ? `Last Updated: ${leaveType.updatedDateUTC}` : null,
            ]
              .filter(Boolean)
              .join("\n"),
          })) || []),
        ],
      };
    },
  );

• src/handlers/list-xero-payroll-leave-types.handler.ts:26-52 (helper)

  Core helper function listXeroPayrollLeaveTypes that fetches leave types from Xero Payroll API via xeroClient.payrollNZApi.getLeaveTypes, handles errors, and returns structured response.

  export async function listXeroPayrollLeaveTypes(): Promise<
    XeroClientResponse<LeaveType[]>
  > {
    try {
      const leaveTypes = await fetchLeaveTypes();
  
      if (!leaveTypes) {
        return {
          result: [],
          isError: false,
          error: null,
        };
      }
  
      return {
        result: leaveTypes,
        isError: false,
        error: null,
      };
    } catch (error) {
      return {
        result: null,
        isError: true,
        error: formatError(error),
      };
    }
  }

• src/handlers/list-xero-payroll-leave-types.handler.ts:10-21 (helper)

  Internal helper to perform the actual Xero API call to retrieve leave types.

  async function fetchLeaveTypes(): Promise<LeaveType[] | null> {
    await xeroClient.authenticate();
  
    const response = await xeroClient.payrollNZApi.getLeaveTypes(
      xeroClient.tenantId,
      undefined, // page
      undefined, // pageSize
      getClientHeaders(),
    );
  
    return response.body.leaveTypes ?? null;
  }

• src/tools/list/index.ts:32-58 (registration)

  Registration: ListPayrollLeaveTypesTool is included in the ListTools array export (line 52). This array is likely imported and registered in the MCP server.

  export const ListTools = [
    ListAccountsTool,
    ListContactsTool,
    ListCreditNotesTool,
    ListInvoicesTool,
    ListItemsTool,
    ListManualJournalsTool,
    ListQuotesTool,
    ListTaxRatesTool,
    ListTrialBalanceTool,
    ListPaymentsTool,
    ListProfitAndLossTool,
    ListBankTransactionsTool,
    ListPayrollEmployeesTool,
    ListReportBalanceSheetTool,
    ListOrganisationDetailsTool,
    ListPayrollEmployeeLeaveTool,
    ListPayrollLeavePeriodsToolTool,
    ListPayrollEmployeeLeaveTypesTool,
    ListPayrollEmployeeLeaveBalancesTool,
    ListPayrollLeaveTypesTool,
    ListAgedReceivablesByContact,
    ListAgedPayablesByContact,
    ListPayrollTimesheetsTool,
    ListContactGroupsTool,
    ListTrackingCategoriesTool
  ];

• src/tools/list/index.ts:22-22 (registration)

  Import statement for the ListPayrollLeaveTypesTool in the tools index.

  import ListPayrollLeaveTypesTool from "./list-payroll-leave-types.tool.js";