Skip to main content
Glama

sn_atf_readiness

Read-onlyIdempotent

Verifies ServiceNow ATF readiness by checking plugins, properties, runner availability, and profile grants; reports unreadable or unverified checks and can inspect suites for active tests.

Instructions

Check ATF plugins, properties, runner availability and profile grants. Unreadable or unverified checks are reported explicitly. Optionally inspect a suite and its child suites for active tests and UI steps.

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_readiness"
  }
}

Input Schema

NameRequiredDescriptionDefault
profileYesConfigured ServiceNow profile name (required; no default fallback).
suite_nameNoOptional exact suite name; mutually exclusive with suite_sys_id
suite_sys_idNoOptional suite ID to verify membership and UI-runner requirements

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

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and non-destructive, so the safety profile is covered. The description adds meaningful behavior beyond that: it discloses that unreadable or unverified checks are surfaced explicitly rather than silently passing, which is exactly the kind of caveat an agent needs to interpret results. It does not mention auth or environment requirements, keeping it short of a 5.

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 short sentences, front-loaded with the primary checks and then the optional suite mode. Every clause carries information — the scope of checks, the reporting caveat, and the optional extension — with no filler or restatement of 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 a full input schema, an output schema, and rich annotations, the description only needs to frame intent and notable behavior, which it does. The remaining gap is guidance on how the optional suite inspection relates to result interpretation and to the sibling run/results tools, minor for a read-only preflight check.

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 largely already handled by the schema (including the mutual exclusivity note on suite_name/suite_sys_id). The description adds only light context by indicating that a suite is inspected for active tests and UI steps, which hints at what suite_name/suite_sys_id drive. Baseline 3 is appropriate.

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 states a specific verb ('Check') and enumerates the concrete resources inspected: ATF plugins, properties, runner availability, profile grants, plus optional suite inspection. It is clearly a readiness/preflight check rather than a runner (sn_atf_run) or results reader (sn_atf_results), though it never names those siblings to sharpen the distinction.

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?

The word 'Optionally' signals that suite inspection is a secondary mode and the two suite parameters are mutually exclusive (also encoded in the schema). However, there is no explicit statement of when to call this versus sn_atf_run or sn_atf_results, and no stated prerequisites beyond the required profile.

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