Skip to main content
Glama

Update set back out

servicenow_update_set_back_out

Reverse an update set installation via its sys_id and optionally roll back batch installs from commit. Use to undo applied update sets and restore prior state.

Instructions

Backs out an installation operation that was performed on an update set with a given sys_id.

:param update_set_id: Sys_id of the update set. :type update_set_id: str :param rollback_installs: Flag that indicates whether to rollback the batch installation performed during the update set commit. :type rollback_installs: bool

:return: Response containing parsed Pydantic model with progress information about the back out. :rtype: Response

:raises MissingParameterError: If update_set_id is not provided.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNo
nameNo
notesNo
scopeNo
sys_idNo
os_nameNo
versionNo
packagesNo
repo_urlNo
dev_notesNo
plugin_idNo
result_idNo
scan_typeNo
app_sys_idNo
os_versionNo
branch_nameNo
descriptionNo
progress_idNo
rollback_idNo
auto_previewNo
browser_nameNo
combo_sys_idNo
force_commitNo
suite_sys_idNo
target_tableNo
target_sys_idNo
update_set_idNo
api_parametersNo
browser_versionNo
test_suite_nameNo
update_set_nameNo
base_app_versionNo
update_source_idNo
app_scope_sys_idsNo
cleanup_retrievedNo
credential_sys_idNo
mid_server_sys_idNo
rollback_installsNo
test_suite_sys_idNo
remote_update_set_idNo
auto_upgrade_base_appNo
remote_update_set_idsNo
update_source_instance_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.4.0

TDQS

C2.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, openWorldHint=true, idempotentHint=false, destructiveHint=false, so the safety profile is largely covered. The description adds real context beyond that: it explains rollback_installs as reversing the batch installation performed during commit, notes the return contains progress information, and documents a MissingParameterError. It still omits whether the back out is reversible, what permissions are required, or whether it is synchronous.

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?

The core behavior is front-loaded in a single clear sentence, followed by a structured docstring block for the two parameters, return, and one exception. The rtype/return lines are somewhat boilerplate, but there is no filler prose and the size is appropriate for a first-pass read.

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?

There is no output schema, 43 parameters with zero schema descriptions, and only two documented in the description. For an operation this large and mutation-oriented, an agent needs to know which parameters actually matter (only two are real here?) and what the effect on the update set is; the description leaves that entirely unresolved.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% across 43 parameters, so the description carries the full burden and only explains two of them (update_set_id and rollback_installs). The explanation of rollback_installs is genuinely useful, but 41 parameters—including many plausibly irrelevant or dangerous ones—remain wholly undocumented anywhere, so the description does not compensate for the coverage gap.

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 states a specific verb and resource: 'Backs out an installation operation that was performed on an update set.' Combined with the title this clearly distinguishes it from siblings like update_set_commit, update_set_preview, and update_set_retrieve without needing their schemas. It stops short of a 5 because it doesn't clarify the scope/effect of the back out (what it removes, on which instance).

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 guidance on when to use this tool versus the surrounding update-set tools (commit, commit_multiple, preview, retrieve). No prerequisites, no mention of the state the update set must be in, and no conditions under which backing out is appropriate or unsafe are given.

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