Skip to main content
Glama

Progress

servicenow_progress
Read-onlyIdempotent

Fetch progress information by progress ID to track ServiceNow operation status. Use the ID to retrieve progress details and results.

Instructions

Get progress information based on the provided progress ID.

:param progress_id: The ID associated with the progress. :type progress_id: str

:return: Response containing parsed Pydantic model with progress information. :rtype: Response

:raises MissingParameterError: If progress_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.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=true, so the safety profile is covered. The description adds one useful behavioral detail beyond annotations — that a MissingParameterError is raised when progress_id is absent — but says nothing about what the returned model contains or any rate/scope constraints.

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?

Sphinx-style :param:/:return:/:raises: sections are compact and every line is relevant, but the docstring format is not front-loaded for agent consumption and the boilerplate return/type lines add little. Adequate but not optimized.

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 tool with 43 parameters, no output schema, and zero schema descriptions, the description is too thin — it explains only the ID parameter and gives no sense of the return shape or role of the other inputs. An agent could call it but would be guessing about most of the interface.

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 full param burden, yet it documents only progress_id (with type). The other 42 nullable parameters are unexplained, leaving the agent to guess whether they matter for this call. This is a significant shortfall against low schema coverage.

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

Purpose3/5

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

The description gives a verb+resource ('Get progress information based on the provided progress ID'), which is more than a tautology, but 'progress information' is generic and does not say what kind of progress or distinguish this tool from siblings like servicenow_instance_scan_progress or servicenow_batch_install_result. An agent cannot tell which progress artifact this retrieves without more context.

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 mention of alternatives, and no preconditions beyond the note that it raises MissingParameterError. The agent is told the tool needs an ID but not when this tool is the right choice over the many other ServiceNow status/progress tools.

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