Skip to main content
Glama

sn_atf_author

Create ServiceNow ATF tests and suites, add tests to suites, or attach ordered steps from a verified catalog—without executing tests.

Instructions

Create ATF tests and suites, or add tests to a suite. Requires explicit table write grants. Rolls back confirmed inserts on failure; reports incomplete or uncertain writes. Supports a runtime-verified step catalog; script steps require atf.allowScriptSteps. Does not execute tests.

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

Input Schema

NameRequiredDescriptionDefault
nameNoName required for create_test and create_suite
stepsNoOrdered typed steps with validated inputs for add_steps
actionYesCreate tests/suites, add memberships or typed steps, or list supported step types
activeNoWhether the new test or suite is active (default true)
profileYesConfigured ServiceNow profile name (required; no default fallback).
descriptionNoDescription for a new test or suite
start_orderNoFirst membership order (default 100); existing memberships are unchanged
test_sys_idNoTest sys_id for add_steps
suite_sys_idNoSuite sys_id required for add_tests_to_suite
test_sys_idsNoUnique test sys_ids to add, in execution order (maximum 100)
application_scopeNoApplication scope sys_id or global for Global scope

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.1/5.0
Behavior5/5

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

Beyond the annotations (readOnlyHint=false, destructiveHint=false, idempotentHint=false, openWorldHint=true), the description discloses failure semantics that matter for a write tool: confirmed inserts are rolled back on failure, and incomplete or uncertain writes are reported. It also states the authorization requirement (table write grants) and the feature gate for script steps, which the annotations cannot convey.

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?

Five short sentences, with scope and creation capability front-loaded, followed by authorization, failure behavior, and the negative scope statement. Every sentence carries distinct information with no repetition of the schema or annotations.

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 an output schema present, the description need not explain return values, and it covers authorization, rollback, partial-write reporting, and non-execution. The main gap is that the list_step_types action and its role in discovering valid step types are not mentioned, which is relevant given the free-form 'type' field in the steps array.

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 parameter meaning is already well documented and the baseline is 3. The description adds some indirect value by indicating steps are 'typed' and validated against a runtime-verified catalog, but it does not say which step types exist, where to obtain them, or which types trigger the atf.allowScriptSteps gate, so it does not meaningfully deepen parameter semantics.

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 names specific verbs and resources: create ATF tests and suites, add tests to a suite, and add steps. It also differentiates the tool from the runner sibling, stating explicitly 'Does not execute tests.' However, it omits the fifth supported action, list_step_types, so an agent could not infer from the description that this tool is also the way to discover valid step types.

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 clear prerequisites and constraints: explicit table write grants are required, and script steps require atf.allowScriptSteps. The phrase 'Does not execute tests' implicitly routes execution to a sibling, but it never names that sibling or states other exclusions, so the guidance stops short of full when/when-not routing.

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