ServiceTitan MCP

payroll_payrolls_list

Read-onlyIdempotent

List payroll periods across employees using filters for employee type, status, active state, and date ranges to locate and review payroll records.

Instructions

List one requested page of payroll periods across employees, with employee type, status, active-state, and date filters. Use the employee- or technician-specific payroll tools when that worker ID is known.

Input Schema

TableJSON Schema

Name	Required	Description
`page`	No	Page number (starts at 1)
`active`	No	Active filter
`status`	No	Payroll status
`pageSize`	No	Records per page (default 50)
`employeeType`	No	Employee type
`includeTotal`	No	Include total count in response
`createdBefore`	No	Filter payrolls created before this timestamp
`modifiedBefore`	No	Filter payrolls modified before this UTC timestamp
`endedOnOrBefore`	No	Filter payrolls ended on or before this UTC timestamp
`createdOnOrAfter`	No	Filter payrolls created on or after this timestamp
`startedOnOrAfter`	No	Filter payrolls started on or after this UTC timestamp
`approvedOnOrAfter`	No	Filter payrolls approved on or after this UTC timestamp
`modifiedOnOrAfter`	No	Filter payrolls modified on or after this UTC timestamp

Output Schema

TableJSON Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

Changed3 schema fields changedv3.0.0Sep 6, 2026

addedInput schema / properties / createdBefore

Added value: +{
+  "description": "Filter payrolls created before this timestamp",
+  "format": "date-time",
+  "type": "string"
+}

addedInput schema / properties / createdOnOrAfter

Added value: +{
+  "description": "Filter payrolls created on or after this timestamp",
+  "format": "date-time",
+  "type": "string"
+}

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": true,
+  "properties": {},
+  "type": "object"
+}

First observedv2.5.1Apr 18, 2026

TDQS

A4.5/5.0

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already cover read-only, idempotent, non-destructive, and open-world behavior. The description adds useful behavioral context beyond those annotations: the tool returns only one requested page and supports named filter categories, which helps the agent understand its scope and pagination semantics.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences with no filler. The primary function and pagination style are front-loaded, and the routing guidance to sibling tools is placed in the second sentence without repeating schema details.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a read-only list tool with 100% schema coverage, rich annotations, and an output schema, the description covers the essential selection and invocation details: pagination, scope, filter families, and when to use an alternative tool. Nothing critical is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents every parameter in detail. The description adds a helpful high-level grouping ('employee type, status, active-state, and date filters'), but it does not add meaning beyond what the parameter names and descriptions already convey.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb ('List'), names the resource ('payroll periods across employees'), and summarizes the available filters. It also distinguishes itself from the employee- and technician-specific payroll tools, so an agent can tell it apart without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It explicitly says to use the employee- or technician-specific payroll tools when a worker ID is known, which gives a clear routing condition. It also implies this tool is for broader, unfiltered-by-worker listing, which is exactly the selection guidance needed.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server