Skip to main content
Glama

Batch rollback

servicenow_batch_rollback
Read-onlyIdempotent

Roll back a batch installation using its rollback ID to revert changes and restore the previous state.

Instructions

Rollback a batch installation based on the provided rollback ID.

:param rollback_id: The ID associated with the batch rollback. :type rollback_id: str

:return: Response containing parsed Pydantic model with information about the batch rollback. :rtype: Response

:raises MissingParameterError: If rollback_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.3/5.0
Behavior1/5

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

The description says the tool 'rolls back a batch installation', an explicitly state-changing operation, yet annotations declare readOnlyHint=true and destructiveHint=false. This directly contradicts the annotations, and the description supplies no other behavioral context (what is undone, whether it is reversible, permissions).

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

Conciseness3/5

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

The purpose is front-loaded and clear, but the sphinx-style :type:/:rtype: boilerplate and a trivial :raises: note for a single optional parameter add redundant structure without new information. Not bloated, but not tight either.

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

Completeness1/5

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

For a destructive-sounding batch operation with 43 undocumented parameters, zero schema coverage, no output schema, and annotations that misclassify it as read-only, the description is far too thin. An agent cannot confidently invoke it or predict the effects.

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 must carry the burden and does not. It only documents rollback_id (as a string 'associated with the batch rollback'), leaving the other 42 optional parameters — scope, packages, sys_id, force_commit, rollback_installs, etc. — entirely unexplained.

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 ('Rollback a batch installation') plus the required identifier, so an agent knows exactly what the tool does. It does not, however, distinguish itself from the several sibling rollback tools (servicenow_app_repo_rollback, servicenow_rollback_plugin, servicenow_update_set_back_out), so 4 rather than 5.

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 batch_install or the other rollback/back-out siblings, and no prerequisites or recovery context. Only the bare action is described.

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