Skip to main content
Glama

sn_atf_run

Run ServiceNow ATF suites through CI/CD using Cloud Runner only and explicit atf.execute permission. Returns progress/result IDs, readable failures, and cached comparison; verify readiness first.

Instructions

Run an ATF suite using ServiceNow Cloud Runner only (no local browser or manual-runner fallback), through CI/CD with explicit atf.execute permission. Returns progress/result IDs, readable failures and cached comparison. Use sn_atf_readiness first.

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": {
      "profile": "<profile>"
    },
    "name": "sn_atf_run"
  }
}

Input Schema

NameRequiredDescriptionDefault
waitNoWait for completion (default true)
profileYesConfigured ServiceNow profile name (required; no default fallback).
timeoutNoMaximum wait in seconds after submission
suite_nameNoExact unique active suite name
browser_nameNoOptional Cloud Runner browser name
run_in_cloudNoCloud-only execution; local browser runners are not supported
suite_sys_idNoSuite sys_id; supply exactly one suite selector

Output Schema

NameRequiredDescriptionDefault
dataYes
profileYesConfigured ServiceNow profile name (required; no default fallback).
metadataYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.2.0

TDQS

A4/5.0
Behavior4/5

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

Beyond the annotations, the description discloses the cloud-only execution constraint, the absence of a manual-runner fallback, and the required atf.execute permission — all operationally important for an agent. It also signals the return shape (progress/result IDs, readable failures, cached comparison), though it does not discuss rate limits or failure/rollback behavior for a partially executed suite.

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

Conciseness5/5

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

Three compact sentences, front-loaded with the execution-mode constraint, then the return shape, then the prerequisite. No filler text and nothing that merely restates the tool name.

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

Completeness4/5

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

With annotations covering the safety profile and an output schema covering return values, the description still supplies the permission requirement and the readiness prerequisite that an agent needs before invoking it. The remaining gap is the relationship to sn_atf/sn_atf_results, which is not addressed.

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 description coverage is 100%, so every parameter is already documented in the schema, including the exactly-one-suite-selector rule and the run_in_cloud const. The description only echoes the cloud-only constraint and adds no new meaning about wait, timeout, or browser_name behavior, so the baseline 3 applies.

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 opens with a precise verb+resource ('Run an ATF suite') and immediately bounds the execution mode ('ServiceNow Cloud Runner only, no local browser or manual-runner fallback'). It does not explicitly contrast itself with nearby siblings such as sn_atf or sn_atf_results, so the differentiation is only partial, but the purpose itself 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 Guidelines4/5

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

It gives a clear prerequisite sequence ('Use sn_atf_readiness first') and an environment precondition ('through CI/CD with explicit atf.execute permission'). It stops short of stating when-not to use this tool or naming an alternative runner tool, but the context needed to select it is present.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.