ServiceTitan MCP

payroll_employees_payrolls_list

Read-onlyIdempotent

Retrieve a paginated list of payroll periods for a specific employee, filtered by status, active state, and date ranges to locate relevant payroll records.

Instructions

List one requested page of payroll periods for a required employee, with status, active-state, and date filters. Use payroll_payrolls_list for a tenant-wide search.

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)
`employeeId`	Yes	Employee ID
`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 behavior. The description adds useful context about pagination ('one requested page') and the requirement for an employee, which goes slightly beyond the structured annotations. No contradictions.

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 core function and scope are stated first, followed by the routing guidance for the sibling tool. Every sentence earns its place.

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?

The description, combined with full schema coverage, rich annotations, and an output schema, provides everything an agent needs to know to invoke this tool correctly. The only notable addition—the tenant-wide alternative—is already present.

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%, with each parameter already documented. The description's mention of 'status, active-state, and date filters' groups the filters but does not add meaning beyond what the schema provides, so the baseline of 3 applies.

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'), a specific resource ('payroll periods for a required employee'), and scoping details ('one requested page', filters). It clearly distinguishes itself from payroll_payrolls_list, the tenant-wide sibling, so an agent can select it correctly.

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?

Explicitly names the alternative tool (payroll_payrolls_list) and the condition that should trigger it ('for a tenant-wide search'), leaving no ambiguity about when to use this tool versus its sibling.

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

Deploy Server