Skip to main content
Glama
montrellcruse

ServiceTitan MCP

payroll_technicians_payrolls_list

Read-onlyIdempotent

Retrieve a paginated list of payroll periods for a specific technician, with filters for status, active state, and dates.

Instructions

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

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number (starts at 1)
activeNoActive filter
statusNoPayroll status
pageSizeNoRecords per page (default 50)
includeTotalNoInclude total count in response
technicianIdYesTechnician ID
createdBeforeNoFilter payrolls created before this timestamp
modifiedBeforeNoFilter payrolls modified before this UTC timestamp
endedOnOrBeforeNoFilter payrolls ended on or before this UTC timestamp
createdOnOrAfterNoFilter payrolls created on or after this timestamp
startedOnOrAfterNoFilter payrolls started on or after this UTC timestamp
approvedOnOrAfterNoFilter payrolls approved on or after this UTC timestamp
modifiedOnOrAfterNoFilter payrolls modified on or after this UTC timestamp

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv3.0.0
    • 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"
      +}
  2. First observedv2.5.1

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already establish that the tool is read-only, idempotent, and non-destructive. The description adds useful behavioral context beyond that: it is page-scoped, requires a technician, and supports multiple filter categories. This is a small but meaningful disclosure of how the tool behaves.

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 first states the tool's function and scope, the second gives the key alternative. The most important scoping information is front-loaded for quick agent scanning.

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?

Given the rich schema (100% parameter coverage), existing output schema, and annotations covering safety, the description completes the picture for selection and invocation. It communicates the required technician scope, pagination behavior, filter availability, and the tenant-wide alternative without needing to restate the schema.

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. The description only groups parameters into categories like status, active-state, and date filters, which adds mild orientation but no new semantic detail beyond the schema.

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 clearly states a specific verb ('List'), a specific resource ('one requested page of payroll periods for a required technician'), and the available filters (status, active-state, date). It also explicitly distinguishes itself from the tenant-wide sibling payroll_payrolls_list, so an agent can tell the tools apart.

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?

The description clearly says when to use this tool: for a required technician's payroll periods. It also explicitly names the alternative, payroll_payrolls_list, for tenant-wide searches, giving the agent a direct routing decision between the two.

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

Deploy Server

Other Tools