now-sdk-ext-mcp

Get Flow Context Status

get_flow_context_status

Read-only

Check the current status of a background flow execution using its context ID. Poll to see if it is queued, in progress, waiting, complete, cancelled, or errored.

Instructions

Query the current status of a flow execution by its context ID. Use this to poll background flow executions started with execute_flow, execute_subflow, or execute_action in background mode.

Possible states: QUEUED, IN_PROGRESS, WAITING, COMPLETE, CANCELLED, ERROR.

Typical pattern: execute in background -> poll this tool every few seconds -> once COMPLETE, call get_flow_outputs. If ERROR, call get_flow_error.

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

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 returned from an execute_flow, execute_subflow, or execute_action call (the contextId field).

Schema Changelog

Changes observed during successful MCP inspections.

First observedv2.5.1May 30, 2026

TDQS

A4.5/5.0

Behavior4/5

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

The description adds valuable behavioral context beyond the annotations: it lists possible states (QUEUED, IN_PROGRESS, etc.) and describes the polling pattern. It doesn't detail error responses for invalid context IDs, but annotations already cover the read-only safety profile.

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?

The description is concise and front-loaded with the core purpose. Every sentence contributes value: the initial query statement, the usage context, the state enumeration, and the typical workflow pattern. No redundant or filler content.

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 status-polling tool, the description is complete. It lists all possible states and suggests next steps (get_flow_outputs on COMPLETE, get_flow_error on ERROR). No output schema exists, but the description covers what the agent needs to know about the return value and workflow.

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 both parameters (instance and context_id) are already fully described in the input schema. The description does not add additional parameter semantics, so baseline 3 is appropriate.

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's function: 'Query the current status of a flow execution by its context ID.' It specifies the resource (flow execution status) and the key input (context ID), distinguishing it from sibling tools like get_flow_outputs and get_flow_error.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly states when to use this tool: 'Use this to poll background flow executions started with execute_flow, execute_subflow, or execute_action in background mode.' It also provides a typical pattern with alternatives: 'once COMPLETE, call get_flow_outputs. If ERROR, call get_flow_error.'

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

Deploy Server