Skip to main content
Glama
montrellcruse

ServiceTitan MCP

dispatch_job_hold_reasons_list

Read-onlyIdempotent

Retrieve paginated job-hold reason catalog entries with IDs and metadata. Filter by active state or created/modified ranges to find valid reasons for placing a job on hold.

Instructions

List one page of job-hold-reason catalog entries, filtered by active state or created and modified ranges. Returned records provide reason IDs and metadata used when placing a job on hold; they are distinct from cancellation reasons.

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
createdBeforeNoReturn items created before this UTC timestamp
modifiedBeforeNoReturn items modified before this UTC timestamp
createdOnOrAfterNoReturn items created on or after this UTC timestamp
modifiedOnOrAfterNoReturn items modified on or after this UTC timestamp

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.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive behavior, so the description does not need to restate those. It adds useful context about pagination ('one page'), filtering by active state and date ranges, and the purpose of returned records, which goes beyond the structured annotations.

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 efficient sentences with no filler. The primary action and scope are front-loaded, followed by filter capabilities and the key distinction from cancellation reasons. Every clause 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?

For a read-only list operation, the description is complete: it identifies the resource, the business purpose, the filtering dimensions, and the distinction from related catalogs. The 100% schema coverage, rich annotations, and output schema remove the need for additional detail in the description.

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?

The input schema has 100% description coverage for all 9 parameters, so the schema already documents each parameter clearly. The description only loosely summarizes filtering ('active state or created and modified ranges') without adding new parameter-level meaning, so the baseline score 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') and a clear resource ('job-hold-reason catalog entries'), and it notes they are 'distinct from cancellation reasons,' which helps separate this tool from the similarly named cancellation-reason siblings in the surrounding tool list.

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

Usage Guidelines4/5

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

It gives clear context for when the tool is relevant: retrieving reason IDs and metadata for placing a job on hold. It also excludes cancellation reasons, preventing confusion with dispatch_job_cancel_reasons_list, though it does not explicitly name alternate sibling tools or state 'use X instead.'

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