Skip to main content
Glama

run_atf_test

Executes a single ServiceNow ATF test by sys_id, optionally as a background job for long runs; requires ATF_ENABLED=true.

Instructions

Execute a single ATF test (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_test"
  }
}

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

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.2/5.0
Behavior3/5

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

Annotations already establish the operation is mutating, non-idempotent, open-world, and non-destructive, and the description adds the useful ATF_ENABLED prerequisite that annotations cannot express. However, it omits other behavior an agent needs, such as what happens when ATF_ENABLED is false and that long runs may silently become background jobs (that detail lives only in the schema).

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?

A single front-loaded sentence with zero filler, and the precondition is parenthetically attached to the action rather than buried. It is efficient, though its brevity borders on under-specification.

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?

For a two-parameter tool with full schema coverage and clear annotations, the definition is minimally viable. With no output schema, the description should still say what a call returns or errors on when ATF_ENABLED is not set, and it does not.

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%, with sys_id and the async/job_id polling behavior fully documented in the schema. The description adds no parameter meaning beyond that, so the baseline of 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?

"Execute a single ATF test" states a specific verb and resource, and the word "single" implicitly separates it from the suite runner sibling. It does not name run_atf_suite outright, so an agent must infer the distinction from the adjective 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?

The only guidance is the gating prerequisite ATF_ENABLED=true, which is helpful but is a configuration condition rather than when-to-use guidance. No direction is given on choosing between run_atf_test, run_atf_suite, or get_atf_test.

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