Skip to main content
Glama

Point scan

servicenow_point_scan

Initiate a point instance scan for a target ServiceNow record using its sys_id and table, returning scan details.

Instructions

Initiate a point instance scan based on the provided parameters.

:param target_sys_id: The sys_id of the target instance. :type target_sys_id: str :param target_table: The table of the target instance. :type target_table: str

:return: Response containing parsed Pydantic model with information about the point scan. :rtype: Response

:raises MissingParameterError: If target_sys_id or target_table 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=false, idempotentHint=false, openWorldHint=true and destructiveHint=false, so the mutation-ish, non-idempotent, external-facing profile is covered structurally. The description adds one genuinely useful detail -- that target_sys_id and target_table are effectively mandatory despite the schema listing zero required parameters. It omits the async nature implied by 'Initiate' (i.e., that results are later polled via servicenow_instance_scan_progress) and says nothing about side effects or scope of the scan.

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 sentence is front-loaded, which is good, but 'based on the provided parameters' is pure filler and the Sphinx-style :param/:type/:return/:raises block is boilerplate that spends four lines documenting two of 43 parameters. It is short overall, so there is no bloat, but the allocation of space is poor.

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 43-parameter tool with no output schema and a 0%-covered schema, the description is far too thin: it does not explain the scan's async lifecycle, what a point scan actually covers, or the role of any optional parameter. It resolves only the mandatory-parameter question, leaving an agent unable to invoke anything beyond the two-field minimal form.

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 fails it -- only target_sys_id and target_table are explained, leaving ~41 parameters (scope, scan_type, plugin_id, packages, repo_url, update_set_id, etc.) completely undefined. The two documented params are the critical ones, which earns some credit, but the vast parameterization of this tool remains opaque.

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 names a verb ('Initiate') and resource ('point instance scan'), which is a real purpose statement rather than a tautology. However, 'point scan' is unexplained jargon and the description never distinguishes it from the sibling scan tools (servicenow_full_scan, servicenow_suite_scan, servicenow_combo_suite_scan), so an agent cannot tell which scan variant to pick from this text alone.

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 whatsoever: no conditions selecting this over a full or suite scan, no prerequisites, no mention of the time/scope tradeoff that would justify a 'point' scan. The only contextual hint is the MissingParameterError clause, which is not usage guidance.

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