ServiceTitan MCP

settings_user_roles_list

Read-onlyIdempotent

Retrieve a paginated list of user roles filtered by IDs, name, active state, creation date, or employee type to resolve role IDs and availability.

Instructions

List one requested page of user roles, optionally filtered by IDs, name, active state, creation date, or employee type. Use this catalog to resolve role IDs and availability.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`ids`	No	Comma-separated role IDs (max 50)
`name`	No	Role name filter
`page`	No	Page number (starts at 1)
`active`	No	Filter by active status	True
`pageSize`	No	Records per page (default 50)
`employeeType`	No	Filter roles by employee type
`includeTotal`	No	Include total count in response
`createdBefore`	No	Created date upper bound (UTC)
`createdOnOrAfter`	No	Created date lower bound (UTC)

Output Schema

TableJSON Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv3.0.0Sep 6, 2026

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.1/5.0

Behavior3/5

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

Annotations already cover readOnly, idempotent, open world, and non-destructive behavior. The description adds a useful pagination trait ('one requested page') but does not detail output shape or edge behaviors. That is acceptable given the output schema and strong annotations, but some behavioral context is still left implicit.

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 short sentences with no filler. The first sentence front-loads action, resource, and scope; the second adds purpose. 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?

With a fully documented schema, an output schema, and strong annotations, the description supplies exactly the missing purpose and use-case context. Nothing needed to invoke the tool correctly—required params, formats, or return values—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 covers 100% of parameters with descriptions, so the baseline is 3. The description summarizes filter dimensions (IDs, name, active state, creation date, employee type) but adds no syntax or format details beyond what the schema already provides.

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?

Description uses a specific verb ('List'), a clear resource ('user roles'), and precise scope ('one requested page'). It also states the catalog purpose of resolving role IDs and availability, which clearly separates it from the broader list/export siblings.

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 explicitly gives a use case: 'Use this catalog to resolve role IDs and availability.' It does not name alternatives or when-not-to-use conditions, but the context is clear enough for a read-only catalog tool.

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

Deploy Server