Skip to main content
Glama

execute_playbook

Execute a ServiceNow playbook step by step, passing results through shared context; supports dry-run preview and async background jobs for long runs.

Instructions

Execute a playbook step by step, passing results forward through context (requires NOW_ASSIST_ENABLED). Supports dry_run.

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": {
      "playbook": "<playbook>"
    },
    "name": "execute_playbook"
  }
}

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.
contextNoInitial context key-value pairs available to all steps
dry_runNoPreview execution plan without invoking tools (default true)
playbookYesPlaybook object with name, description, and steps array

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. Addedv4.9.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare non-read-only, open-world, non-idempotent behavior, so the bar is lower. The description adds two useful facts beyond that: the NOW_ASSIST_ENABLED feature-flag requirement and dry_run support. It says nothing about what execution does to external systems, how approvals are handled, or that execution may silently become a background job.

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 tight sentence with the action front-loaded, followed by the mechanism and prerequisite. Nothing is wasted, though it is arguably too short for a nested-object, multi-step execution tool.

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 tool that runs arbitrary sequences of other tools with error policies and conditions, the description is thin: it does not explain step semantics, on_error behavior, or how step outputs become context. The rich schema compensates somewhat and there is no output schema to explain, so it is adequate but with clear gaps.

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 the four parameters including async, context, dry_run, and the nested playbook object are already documented in the schema. The description reinforces context passing and dry_run but adds no new syntax or constraints, so 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 and resource ('Execute a playbook') plus the key differentiator that results are passed forward through step context. It does not say how it differs from sibling tools like run_security_playbook or execute_script, so an agent cannot separate them from the description 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?

No when-to-use or when-not-to-use guidance. The presence of execute_script, execute_background_script, and run_security_playbook next to this tool makes the omission material; the only implicit cue is the NOW_ASSIST_ENABLED prerequisite.

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