Sliq

Get Campaign Flow

get_campaign_flow

Read-only

sequence is the authored DAG (null for a flowless campaign): sequence.start is the origin node and sequence.nodes the body nodes, each with its id, label, and kind (start / connection_request / send / action / manual / gift / automation / decision / terminal) plus that kind's typed routing — a connection_request's accepted / already_connected / timeout / message_templates (its note), a send's channel / action / replied / follow_up / message_templates (two while it A/B tests a second version), a silent action's channel / action / then, a manual node's action_description / then, a gift node's product_url / max_price_usd / gift_note / then, an automation node's then (its side-effect is authored on its on_enter trigger), a decision's rule / arms, a terminal (a sink). Timed edges carry {value, unit} (unit w/d/h/m). A connection_request node is always LinkedIn (its channel/action are implicit in its kind); the resolve stage is the action == 'resolve' silent-action node — it looks each profile up, then the campaign flows onward. Walk sequence to see which step feeds which and what gates each hop; join it with nodes by node id for per-node occupancy.

nodes is the per-node occupancy map, keyed by node id: by_status, current, blocked, pending, removed, and off_sequence. It covers every sequence node plus any foreign id the queue throughput or the cursor carries. The start node's current counts every prospect not yet routed onto any node. removed counts prospects removed from the campaign at that node (skipped on its channel, or on every channel for a node without one): they still rest there, and are left out of current, blocked, and pending. off_sequence is True for a node id prospects rest on that the current sequence no longer defines — a position an earlier flow edit stranded — surfaced so those prospects stay visible (such an id is absent from sequence, so read its counts here).

pause is the per-scope pause breakdown (null for a non-outreach agent): campaign.paused holds every action node; linkedin.reason (needs_reconnect / auto / manual, with until on an auto rate-limit pause) holds every LinkedIn action node while email stays live; connection_request.until holds only connection_request nodes; and steps.paused lists the node ids whose own step is paused — nothing new is composed there until it resumes, though sends already queued still go out. Read it to answer "why is step 3 not firing" per node — a paused scope explains a node with pending occupants but no throughput. Dict with sequence (the authored DAG as stored, or null for a flowless campaign), nodes {node_id: {by_status, current, blocked, pending, removed, off_sequence}}, and pause (per-scope pause breakdown; see above). blocked is how many resting prospects have a blocked enactment (see report_enactment_blocked; clear one for retry with retry_blocked_enactment); pending how many rest on an action/manual/decision node whose step hasn't run for them yet — for a manual node, awaiting the human who performs it — no intervention needed, unlike blocked. Null sequence and empty nodes for a flowless campaign with no queue activity.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`agent_id`	Yes	ID of the agent (campaign) to read.
`on_behalf_of`	No	An agency client's email, from list_agency_clients, to run this call in that client's account: their agents, settings, connected accounts, and credits. Omit it to act on your own account.

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedOct 19, 2026

addedInput schema / properties / on_behalf_of

Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null,
+  "description": "An agency client's email, from list_agency_clients, to run this call in that client's account: their agents, settings, connected accounts, and credits. Omit it to act on your own account."
+}

Changed3 schema fields changedSep 23, 2026

addedInput schema / properties / agent_id

Added value: +{
+  "description": "ID of the agent (campaign) to read.",
+  "type": "integer"
+}

removedInput schema / properties / task_id

Removed value: -{
-  "description": "ID of the task (campaign) to read.",
-  "type": "integer"
-}

changedInput schema / required

Previous value: -[
-  "task_id"
-]New value: +[
+  "agent_id"
+]

First observedSep 15, 2026

TDQS

A4.5/5.0

Behavior5/5

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

With only readOnlyHint in annotations and no output schema, the description carries the full behavioral burden and does so richly: it explains that `removed` prospects still rest at a node but are excluded from `current`/`blocked`/`pending`, that `off_sequence` ids are absent from `sequence` yet visible in `nodes`, and that paused steps compose nothing new while queued sends still go out. These edge-case semantics are exactly what an agent needs and are absent from structured fields.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The summary is front-loaded and uses backticks/sections well, but the body is an extremely dense wall of text covering every node kind and routing field. Much of that field-by-field enumeration is verbose relative to the decision an agent needs to make, so it is longer than the call warrants.

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 complex, read-only tool with no output schema, the description fully covers the return shape (`sequence`, `nodes`, `pause`), the flowless-campaign edge case (null `sequence`, empty `nodes`), and cross-references to related tools (report_enactment_blocked, retry_blocked_enactment). Nothing needed to interpret the result is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3; the description adds a genuine nuance beyond the schema by noting the read is not limited to the agent in context and can target any of the user's campaigns. The `on_behalf_of` agency-client behavior is fully covered by the schema itself.

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?

States a specific verb and resource ('Read the live Campaign Flow for an agent') and immediately scopes the payload: the authored `sequence` DAG, per-node occupancy (`current`), and queue throughput (`by_status`). It is clearly distinguishable from siblings like get_agent_details or get_node_history because it defines its own output model.

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?

Gives concrete when-to-use triggers ('where are my prospects in the campaign', 'how many are stuck at the connect step', 'why is step 3 not firing') and clarifies scope ('Pass any of the user's campaigns; it is not limited to the agent in context'). It does not, however, name alternative tools (e.g., get_node_history for history) or state exclusions, so it stops short of a 5.

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

All Sliq tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?