PayrollEngine.Mcp.Tools 0.10.0-beta.4

This is a prerelease version of PayrollEngine.Mcp.Tools.
dotnet add package PayrollEngine.Mcp.Tools --version 0.10.0-beta.4
                    
NuGet\Install-Package PayrollEngine.Mcp.Tools -Version 0.10.0-beta.4
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="PayrollEngine.Mcp.Tools" Version="0.10.0-beta.4" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="PayrollEngine.Mcp.Tools" Version="0.10.0-beta.4" />
                    
Directory.Packages.props
<PackageReference Include="PayrollEngine.Mcp.Tools" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add PayrollEngine.Mcp.Tools --version 0.10.0-beta.4
                    
#r "nuget: PayrollEngine.Mcp.Tools, 0.10.0-beta.4"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package PayrollEngine.Mcp.Tools@0.10.0-beta.4
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=PayrollEngine.Mcp.Tools&version=0.10.0-beta.4&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=PayrollEngine.Mcp.Tools&version=0.10.0-beta.4&prerelease
                    
Install as a Cake Tool

Payroll Engine MCP Tools

Part of the Payroll Engine open-source payroll automation framework. Full documentation at payrollengine.org.

Read-only MCP tools for the Payroll Engine — HR, Payroll, Report and System query tools built on PayrollEngine.Mcp.Core, ready for use in any MCP server deployment.


NuGet Package

Available as a private GitHub Package:

dotnet add package PayrollEngine.Mcp.Tools

Overview

PayrollEngine.Mcp.Tools provides the complete set of read-only MCP tools that expose Payroll Engine data to AI agents. All tools are read-only by design — no mutations, no side effects, with two exceptions: get_employee_pay_preview and execute_payroll_report execute synchronous calculations without persisting anything to the database.

Tools are organized into four roles. Each role is independently enabled or disabled per server deployment via McpPermissions.


Tools

Server — Always Available

Registered unconditionally, independent of role permissions or isolation level.

Tool Description
get_server_info Server version, active isolation level, configured scope, and role permissions

HR — Human Resources

Employee master data, case values, and audit trail.

Tool Description
list_divisions List all divisions of a tenant
get_division Get a division by name
get_division_attribute Get a single custom attribute of a division
list_employees List employees with optional OData filter
get_employee Get an employee by identifier
get_employee_attribute Get a single custom attribute of an employee
list_employee_case_values Full case value history of an employee
list_company_case_values Company-level case values of a tenant
list_employee_case_changes Audit trail of employee data mutations
list_company_case_changes Audit trail of company data mutations

Payroll — Payroll Processing

Payroll structure, results, preview calculations, temporal case value queries, and lookup resolution.

Tool Description
list_payrolls List all payrolls of a tenant
get_payroll Get a payroll by name
list_payruns List all payruns of a tenant
list_payrun_jobs List all payrun jobs ordered by creation date descending
list_payroll_wage_types Effective wage types merged across all regulation layers
get_payroll_lookup_value Resolved lookup value by key or range value
list_payroll_result_values Flat denormalized list of all result values
get_consolidated_payroll_result All results for one employee and one period
get_employee_pay_preview Preview payroll calculation without persisting results
get_case_time_values Case values valid at a specific point in time

Report — Report Execution

Tool Description
execute_payroll_report Execute a payroll report and return its result data set

System — Administration

Tool Description
list_tenants List all tenants
get_tenant Get a tenant by identifier
get_tenant_attribute Get a single custom attribute of a tenant
list_users List all users of a tenant
get_user Get a user by identifier
get_user_attribute Get a single custom attribute of a user

Role × Isolation Level

= tools registered = not applicable at this isolation level

Role MultiTenant Tenant Division Employee
HR
Payroll
Report
System

Assembly Marker

ToolsMarker is the assembly marker for tool discovery in ToolRegistrar.GetPermittedTypes():

var toolsAssembly = typeof(ToolsMarker).Assembly;
var permittedTypes = ToolRegistrar.GetPermittedTypes(toolsAssembly, permissions, isolationLevel);

When building a server that combines these tools with additional write tools from a private assembly, pass both assemblies to GetPermittedTypes or call it twice.


Repository Description
PayrollEngine.Mcp.Core Core infrastructure — ToolBase, isolation model, permission system
PayrollEngine.Mcp.Server Hosted MCP server using Core and Tools
PayrollEngine.Client.Core Payroll Engine REST API client

License

MIT License — free for personal and commercial use.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.10.0-beta.4 32 4/1/2026