Skip to main content
Glama

run_atf_suite

Execute a ServiceNow ATF test suite by system ID to validate automated tests; optionally run async and poll job status. Requires ATF_ENABLED=true.

Instructions

Execute an ATF test suite (requires ATF_ENABLED=true)

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": {
      "sys_id": "<sys_id>"
    },
    "name": "run_atf_suite"
  }
}

Input Schema

NameRequiredDescriptionDefault
asyncNoRun as a background job and return a job_id at once. Poll it with get_job. Calls that take longer than about 20 seconds switch to a job on their own.
sys_idYesSystem ID of the test suite

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv5.0.1
    • addedInput schema / properties / async
      Added value: +{
      +  "description": "Run as a background job and return a job_id at once. Poll it with get_job. Calls that take longer than about 20 seconds switch to a job on their own.",
      +  "type": "boolean"
      +}
  2. First observedv1.0.2

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare non-readonly, non-idempotent, non-destructive execution with open-world reach, so the safety profile is covered. The description adds the meaningful feature-flag prerequisite, but says nothing about what execution produces or how results surface, which matters for a non-idempotent run tool.

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?

One short sentence with the prerequisite parenthesized upfront — zero waste and easy to parse. It is terse to the point of omitting the result-retrieval workflow, but nothing written is redundant.

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

Completeness3/5

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

With annotations present and parameters fully described in schema, the basic definition is serviceable. Still missing is what the call returns (suite result ID or job ID) when async auto-switches, and how to fetch outcomes — relevant given there is no output schema.

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 both sys_id and async are fully documented in the schema, including the background-job behavior and get_job polling. The description adds no meaning beyond that, 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?

States a specific verb (Execute) and resource (ATF test suite), and the noun 'suite' distinguishes it from the sibling run_atf_test, which handles individual tests. It does not explicitly name that sibling, but the resource scope 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 Guidelines3/5

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

Adds a real prerequisite (ATF_ENABLED=true must be set), which tells the agent when the call is even possible. However, it gives no guidance on when to use this versus get_atf_suite_result or get_atf_suite, so the agent must infer the execute-then-retrieve workflow.

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