Skip to main content
Glama

Read a journey

get_journey
Read-onlyIdempotent

One journey step by step: its name, whether it is live, every step in order with its id (including structured custom trigger configuration and business-defined intent options) and where each leads, plus anything that would stop it being switched on. Branch path keys are stable: if_true / if_false for condition splits and the A/B variant keys for A/B splits. Call it before any journey edit — the edit tools take these step ids.

Input Schema

NameRequiredDescriptionDefault
site_idYesThe site, from list_sites
user_goalNoOptional: the user's goal behind this call, in one short sentence of plain words (e.g. "add a page so customers can book tables"). No names, emails or other personal details.
journey_idYesThe journey, by id from list_journeys

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / user_goal
      Added value: +{
      +  "description": "Optional: the user's goal behind this call, in one short sentence of plain words (e.g. \"add a page so customers can book tables\"). No names, emails or other personal details.",
      +  "type": "string"
      +}
  2. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so safety is covered; the description adds genuine behavioral content — it discloses return payload structure, the stable branch-path key conventions (if_true/if_false, A/B variant keys), and the presence of enablement blockers. It stops short of error behavior (e.g. unknown journey_id), which keeps it at 4 rather than 5.

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?

Three sentences, front-loaded with the returned payload, then the key-stability convention, then the usage rule — logical order with little waste. The opening sentence is dense and packs several clauses, but nothing is redundant.

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

Completeness4/5

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

With no output schema, the description must convey return content, and it does so thoroughly (fields, ordering, branch keys, blockers). Minor gaps remain around failure modes for an invalid journey_id, but for a simple read tool it is otherwise self-sufficient.

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 site_id and journey_id are already documented, and the description adds no per-parameter detail (the optional user_goal is not mentioned). Baseline 3 applies when the schema carries parameter semantics.

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?

Opens with a specific verb+resource ('one journey step by step') and enumerates exactly what is returned: name, live status, ordered steps with ids, targets, and blockers. It is unambiguously distinct from list_journeys (enumeration) and get_contact_journey (a contact's path).

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 instructs 'Call it before any journey edit — the edit tools take these step ids,' naming the dependency condition and the alternative flow. An agent knows when to reach for this tool versus listing journeys or editing directly.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources