Skip to main content
Glama
montrellcruse

ServiceTitan MCP

settings_activity_codes_list

Read-onlyIdempotent

List payroll activity codes with filters for active status, date ranges, sorting, and pagination to locate codes for payroll synchronization.

Instructions

List one requested page of payroll activity codes with active-state, date, and sort controls. Use the get tool for one known code or the export feed for synchronization.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number (starts at 1)
sortNoSort: Field (default), +Field (asc), or -Field (desc). Fields: Id, ModifiedOn, CreatedOn
activeNoFilter by active statusTrue
pageSizeNoRecords per page (default 50)
includeTotalNoInclude total count in response
createdBeforeNo
modifiedBeforeNo
createdOnOrAfterNo
modifiedOnOrAfterNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv3.0.0
    • 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.2/5.0
Behavior3/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, so the description's job is lighter. It adds the useful trait that only one requested page is returned, but it does not disclose edge behaviors such as sortable-field limits or date-filter boundary semantics beyond what the schema already provides.

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, no filler. The core list behavior is front-loaded and the alternative routing is in the second sentence. Every phrase earns its place.

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

Completeness4/5

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

For a nine-parameter list tool with an output schema and strong annotations, the description covers the essential invocation context: paginated listing, filter dimensions, and the alternatives to use for single-record lookup or full synchronization. It does not enumerate all parameters, but the schema carries that detail.

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 56%, so the schema already documents page, sort, active, pageSize, includeTotal, and date formats. The description adds a helpful grouping ('active-state, date, and sort controls') but does not add granular meaning for the undocumented date parameters, nor does it mention pageSize/includeTotal.

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 names a specific verb ('List'), a specific resource ('payroll activity codes'), and a scope ('one requested page'), which clearly distinguishes it from the sibling get and export tools. It also signals the available controls up front, so the agent knows this is a paginated list endpoint.

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 routes to alternatives: 'Use the get tool for one known code or the export feed for synchronization.' That gives concrete when-to-use-this vs. when-to-use-other guidance without requiring the agent to infer from tool names.

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