Skip to main content
Glama

export_update_set

Retrieves the XML export payload for a ServiceNow Update Set by sys_id, enabling migration or deployment workflows. Supports background execution for long-running exports.

Instructions

Get the XML export payload for an Update Set (as used in migration). [Scripting]

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": "export_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.
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

B3.4/5.0
Behavior3/5

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

Annotations already disclose the safety profile (not read-only, not destructive, not idempotent, open-world), so the description's burden is lower. It adds useful scope context ('migration', '[Scripting]') but never explains why a 'Get' operation is flagged non-read-only, nor mentions permissions or the background-job behavior that the schema covers via the async parameter.

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?

A single front-loaded sentence with no waste. The trailing '[Scripting]' tag is slightly cryptic but compactly signals the execution context.

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

Completeness3/5

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

With no output schema, the description does state the return artifact (an XML export payload), which is the key fact. However, for a tool whose annotations mark it non-read-only and open-world, it should say whether the call has side effects or requires elevated permissions.

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 coverage is 100%, so both sys_id and async are fully documented in the schema, including the job_id polling flow. The description adds no parameter-level meaning beyond that, which is acceptable given complete schema descriptions.

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 names a specific verb and resource: retrieving the XML export payload for an Update Set. The parenthetical 'as used in migration' narrows intent. It does not explicitly differentiate itself from near siblings such as preview_update_set or export_properties, but the resource is unambiguous.

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

Usage Guidelines3/5

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

Usage is implied by 'as used in migration' and the [Scripting] tag, which signals this is for programmatic/migration workflows. There is no explicit when-to-use, when-not-to-use, or named alternative (e.g., preview_update_set) to steer selection.

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