Skip to main content
Glama

preview_update_set

Preview all changes in a ServiceNow Update Set by sys_id before committing it. Lists affected records so you can verify the contents prior to deployment.

Instructions

Preview all changes contained in an Update Set

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "sys_id": "<sys_id>"
    },
    "name": "preview_update_set"
  }
}

Input Schema

NameRequiredDescriptionDefault
asyncNoRun as a background job and return a job_id at once. Poll it with get_job. Calls that take longer than about 20 seconds switch to a job on their own.
limitNoMax records to list (default 100)
sys_idYesUpdate Set sys_id

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv5.0.1
    • addedInput schema / properties / async
      Added value: +{
      +  "description": "Run as a background job and return a job_id at once. Poll it with get_job. Calls that take longer than about 20 seconds switch to a job on their own.",
      +  "type": "boolean"
      +}
  2. First observedv1.0.2

TDQS

C2.9/5.0
Behavior2/5

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

Annotations supply readOnlyHint=false, destructiveHint=false, idempotentHint=false and openWorldHint=true, and the description adds nothing beyond them — notably it does not resolve the tension between "Preview" (intuitively a read) and readOnlyHint=false, nor does it say whether previewing has side effects on the instance. It also does not mention that large sets are truncated by the limit or auto-switch to a job, leaving that detail to the schema.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

One short, front-loaded sentence with no filler or repetition of the tool name. Its brevity is efficient but is also the source of the definition's gaps, since nothing else is offered.

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

Completeness2/5

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

For a three-parameter tool sitting in a dense cluster of update-set operations, the definition is under-built: it does not say what a preview returns, whether it changes state, or how it relates to complete_update_set/ensure_active_update_set. With no output schema, the description should have described the shape of the result (list of records/change counts) but does not.

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 sys_id, limit and async each documented in the schema, so the schema carries parameter meaning and a baseline of 3 applies. The description adds no additional semantics such as what unit the limit counts or how many changes a typical set produces.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb ("Preview") with a specific resource ("all changes contained in an Update Set"), so an agent knows it is a non-committing inspection call rather than a mutation. It stops short of distinguishing itself from neighbors such as complete_update_set or find_update_sets, which keeps it out of 5 territory.

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

Usage Guidelines2/5

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

There is no when-to-use guidance, no statement of prerequisites (does the set need to be the active/current one?), and no routing to alternatives. The description never says this is the step to run before complete_update_set, which is the obvious sibling relationship an agent would need.

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