Skip to content

Status and result tools

MCP action tools that create persisted runs return a run_id.

Follow the returned next_action when it is present. It points to the correct tool for the run shape.

ToolUse it for
get_sleepwalker_visibility_run_statusPoll direct AI Visibility runs.
list_sleepwalker_visibility_runsList direct AI Visibility runs.
get_sleepwalker_content_run_statusPoll direct Content Intelligence runs.
list_sleepwalker_content_runsList direct Content Intelligence runs.
get_sleepwalker_run_resultFetch saved Console run details, including saved-test Content Intelligence reruns.
get_sleepwalker_prompt_responseFetch one AI Visibility prompt response chunk.

Required scope:

runs:read
create run
-> store run_id
-> poll status every 10 to 30 seconds
-> stop when terminal
-> fetch heavier result detail only if needed

MCP create and status responses can include next_action. Treat it as the recommended next tool call for the current run state.

next_action.version is currently 1. Supported next_action.type values are:

TypeMeaning
poll_statusPoll the named status tool after the suggested delay.
fetch_resultFetch the full result only if the user needs detailed evidence.
explain_terminal_statusExplain a failed or cancelled terminal state before retrying.
StatusMeaning
queuedAccepted and waiting to start.
runningWork has started.
completedWork finished and result data is available.
failedWork could not complete.
cancelledWork was not run or was stopped.
partially_queuedSome requested probes were queued and some were skipped.

See Enums for shared status values.

MCP accepts common status wording such as done, complete, and in progress, then normalizes it to the canonical status.

Status and result tools return compact data by default.

ToolFlagUse when
get_sleepwalker_visibility_run_statusinclude_probesYou need per-probe status rows.
get_sleepwalker_visibility_run_statusinclude_resultsYou need available probe result data.
get_sleepwalker_content_run_statusinclude_resultYou need the full Content Intelligence result.

Use include flags deliberately. Large payloads are harder for MCP clients to handle.

For any AI Visibility run (saved-test or direct-URL), fetch individual prompt responses with:

get_sleepwalker_prompt_response

This is the preferred way to read a large run: pull one answer at a time instead of the full include_results payload. The response includes the model that answered, the full (capped) text, and citations.

Inputs:

InputTypeNotes
run_idstringRequired run ID.
result_indexintegerFetch by flattened result index (same order as the status ca_result).
platformstringFetch by platform. Canonical values and common labels such as ChatGPT or Grok are accepted.
prompt_indexintegerFetch by prompt position.
max_charsinteger1 to 25,000.
offsetintegerContinue long text from an offset.
Poll this Sleepwalker run until it completes, then summarize the result.
Fetch the first prompt response with citations for this visibility run.