now-sdk-ext-mcp

Get Flow Error

get_flow_error

Read-only

Get the error message of a failed flow execution by its context ID to diagnose the failure and correct the flow definition.

Instructions

Retrieve the error message from a failed flow execution by its context ID. Call this after get_flow_context_status shows ERROR to understand why the flow failed.

Returns the flow's error message which can be used to diagnose and fix issues in the flow definition.

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": {
      "context_id": "<context_id>"
    },
    "name": "get_flow_error"
  }
}

Input Schema

Name	Required	Description	Default
`instance`	No	The ServiceNow instance auth alias to use. This is the alias configured via `now-sdk auth --add` (e.g., "myinstance", "prod", "test"). The user will typically refer to this by name when saying things like "on my myinstance instance". If not provided, falls back to the SN_AUTH_ALIAS environment variable.
`context_id`	Yes	The flow context sys_id from the execution result's contextId field.

Schema Changelog

Changes observed during successful MCP inspections.

First observedv2.5.1May 30, 2026

TDQS

A4.3/5.0

Behavior4/5

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

With readOnlyHint=true annotation, the description correctly aligns as a read operation. It adds valuable behavioral context by explaining the precondition (only for failed flows) and that the return is the error message for diagnosing flow definition issues. No contradictions with annotations.

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?

Two sentences, front-loaded with the core action and immediately useful usage condition. Every sentence adds value, no redundancy or fluff.

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

Completeness5/5

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

For a simple retrieval tool with 2 parameters and no output schema, the description fully covers purpose, usage trigger, parameter reference, and return value. It integrates well with sibling tools by referencing get_flow_context_status, and no critical information is missing for an agent to invoke it correctly.

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 both instance and context_id fully documented in the schema. The description itself adds no additional parameter meaning beyond mentioning 'context ID' which mirrors the schema's required context_id field. Baseline 3 applies as schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool retrieves the error message from a failed flow execution by context ID, using specific verb 'retrieve' and naming the exact resource. It distinguishes itself from sibling tools like get_flow_logs and get_flow_outputs by focusing specifically on the error message.

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?

The description gives an explicit when-to-use: 'Call this after get_flow_context_status shows ERROR'. However, it does not explicitly mention when not to use it or name alternative tools for related diagnostic needs, so it falls short of full alternative/exclusion guidance.

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

Deploy Server