# KeyPay MCP > KeyPay lets you manage payroll, employee records, and pay runs directly from your agent. This MCP connects to KeyPay (Employment Hero Payroll) so you can list businesses, check earnings, track leave requests, and verify compliance data for all your employees. ## Overview - **Category:** human-resources - **Price:** Free - **Tags:** payroll-processing, workforce-management, compliance, employee-records, pay-runs, hr-automation ## Description Need to handle complex payroll tasks without logging into a web dashboard? This MCP lets your AI client talk directly to your KeyPay account. You can run checks across multiple business entities associated with the account or pull specific details about an employee's profile. Your agent handles everything from listing current pay runs and their detailed earnings down to tracking historical leave requests. It also gives you immediate access to payslips for any worker, plus a way to inspect deduction lines to guarantee compliance accuracy. Because this connection is hosted on Vinkius, you get the benefit of having your payroll data available to any MCP-compatible client—whether that's Cursor or Claude. You just tell your agent what information you need, and it gets it for you. ## Tools ### list_businesses Gets a list of every business connected to your KeyPay account. ### list_pay_run_deductions Shows all deductions applied during a specific payroll run. ### list_pay_run_earnings Retrieves the detailed list of earnings for a given pay cycle. ### list_employees Provides a roster and basic details for all employees in one business. ### get_business_details Pulls specific, detailed information about a single identified business entity. ### get_employee_details Fetches the full profile and configuration details for one employee. ### get_pay_run_details Retrieves comprehensive information about a single pay run, including status and dates. ### list_leave_requests Lists all current and past leave applications for a specified business unit. ### list_pay_runs Retrieves a list of recent pay runs conducted for a given business. ### list_pay_slips Generates a list of payslips available for a particular employee. ## Prompt Examples **Prompt:** ``` List all businesses in my KeyPay account. ``` **Response:** ``` I've retrieved your businesses. You have 3 registered entities: 'Acme Australia', 'Acme Global Services', and 'Tech Ventures Pty Ltd'. ``` **Prompt:** ``` Show me the pay runs for business ID '12345'. ``` **Response:** ``` For business 12345, I found 5 recent pay runs. The latest is 'Fortnightly Pay Period' ending May 15th, currently marked as 'Finalised'. ``` **Prompt:** ``` Find employee 'John Smith' in business '12345'. ``` **Response:** ``` I've found 'John Smith' (ID: 98765) in business 12345. He is currently active and listed as a 'Senior Developer'. ``` ## Capabilities ### Identify associated businesses Retrieve a list of all corporate entities linked to the KeyPay account. ### Check employee details Fetch specific profile and payroll setup information for individual employees. ### Analyze pay run financials Retrieve full details about a single pay cycle, including all earnings and deductions. ### Monitor time off history Get a complete list of both pending and historical leave requests across your business units. ### Access payroll documents List and retrieve payslips for specific employees instantly. ## Use Cases ### Investigating an employee's pay slip discrepancy The HR manager notices a payslip looks wrong. They ask their agent, which then runs `list_pay_slips` and pulls the exact document details for review. Finally, they run `list_pay_run_earnings` to compare the listed earnings against the employee's base salary records. ### Auditing a business unit’s payroll history The CFO needs to see how many pay runs occurred in Q1. They use `list_businesses` first, then run `list_pay_runs` for the specific entity ID. This quickly builds a timeline of all paid periods. ### Onboarding a new worker and checking their status A team lead needs to confirm if John Doe is active and what his current title is. They ask the agent to use `get_employee_details` for John Doe, confirming his role before processing payroll. ### Reviewing leave balance across all departments The department head needs a quick headcount of available time off. By using `list_leave_requests`, they get an immediate summary of pending leave for their entire team, saving days of manual form checking. ## Benefits - Instantly check pay run status. Instead of navigating through dashboards to see if a pay period is 'Finalised' or pending, your agent uses `get_pay_run_details` to give you the current status right away. - Verify employee data on the fly. Need to know an employee’s active role or payroll setup? Use `get_employee_details` and get that information without ever leaving your chat interface. - Manage compliance checks easily. By running `list_pay_run_deductions`, you can quickly inspect every deduction line, making sure the records match local law before pay day. - Track time off effortlessly. The MCP lets you run `list_leave_requests` to monitor all pending or historical leave for a business without having to check multiple HR systems. - Get full visibility across companies. If your organization has multiple legal entities, use `list_businesses` first to scope the data before running payroll checks. ## How It Works The bottom line is that you delegate complex, multi-step HR data retrieval entirely to your AI client. 1. You subscribe to this MCP on Vinkius and provide your KeyPay API key and region domain. 2. Your AI client uses the credentials to connect, allowing it to access your payroll data across all linked businesses. 3. The agent executes specific tasks—like listing pay runs or fetching employee details—and returns clean, actionable data directly to you. ## Frequently Asked Questions **How do I check multiple businesses with KeyPay MCP?** Use the `list_businesses` tool first to see all registered entities. You can then target specific companies by calling tools like `list_pay_runs` or `get_employee_details` using that business's ID. **Can I find an employee’s full details with KeyPay MCP?** Yes. You run `get_employee_details`, and the agent pulls up their entire profile, including payroll configuration and current status, in one go. **Does KeyPay MCP help me calculate taxes?** No, this MCP reads existing data; it doesn't perform calculations. However, you can use `list_pay_run_deductions` to verify what deductions were applied during a run for auditing purposes. **How do I get payslips using KeyPay MCP?** You execute `list_pay_slips`. You just need to specify the employee and the period, and your agent retrieves all available payslip information for you. **What if I need data from a business that isn't listed?** If you suspect an entity is missing, start by using `list_businesses` to confirm the full list. If it’s not there, you must contact your KeyPay administrator to get it added.