Skip to main content
Glama

HelpWell

by ai.helpwell.app
OverviewDiscussionsAdmin

Update a journey

update_journey
Destructive

Saves a journey’s full definition (read it with get_journey, change it, send it back). On a published journey this is a draft: the live version keeps running until publish_journey.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
journeyIdYesJourney id from list_journeys.
definitionYesThe journey document: { name, description, trigger (one of: ticket.created, ticket.escalated, ticket.closed, ticket.reopened, ticket.tagged, ticket.unresolved, ticket.rated, customer.replied, human.replied, chat.started, chat.answer_rated, contact.subscribed, contact.created, contact.updated, contact.tagged, custom.event, page.visited, login.succeeded, login.failed, email.delivered, email.opened, email.clicked, stripe.customer.created, stripe.customer.updated, stripe.checkout.completed, stripe.subscription.created, stripe.subscription.updated, stripe.subscription.cancelled, stripe.subscription.trial_ending, stripe.subscription.product_status, stripe.invoice.paid, stripe.invoice.payment_failed, stripe.charge.refunded, form.submitted, form.confirmed, contact.enriched, segment.entered, segment.left, article.viewed, article.rated, search.failed, roadmap.idea, roadmap.voted, roadmap.shipped, changelog.viewed, survey.answered, journey.entered, journey.completed, journey.converted, date.reached, manual.enrolled), triggers?: [{ event, ... }], productId, stopOnReply, reentry: always|once|after_completion, entry?: conditions, goal?, settings?: { quietHours, timeZone, emailCap }, steps: [...] }. Steps (1 to 50, each may have an id): { type: "wait", minutes }, { type: "email", campaignId } (a ready journey email), { type: "tag", tag }, { type: "remove_tag", tag }, { type: "set_attribute", ... }, { type: "branch", conditions, yes, no }, { type: "wait_event", ... }, { type: "message", ... }, { type: "note", body }, { type: "notify", ... }, { type: "exit" }, among others. Existing journey documents include the full step configuration.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare destructive=true and readOnly=false, so the write/destructive profile is known. The description adds meaningful extra context: changes on a published journey are a draft and the live version keeps running until publish_journey. It does not, however, spell out that the prior definition is overwritten.

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 tight sentences with no waste. The core action and its main caveat (draft vs live) are front-loaded, and the parenthetical workflow is compact.

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?

For a complex nested-object tool with no output schema, the description covers the important lifecycle behavior (draft semantics, publish requirement). It is nearly complete, though it could note the return value or the draft-id surface.

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 coverage is 100%, so both parameters (journeyId, definition) are already fully documented in the schema. The description frames definition as 'full definition' but adds no format or structural detail beyond what the schema provides. 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?

States a specific verb (saves) and resource (a journey's full definition), and clarifies it is a full-document write rather than a partial edit. It also names siblings get_journey and publish_journey, so the agent can place it precisely in the journey lifecycle.

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?

Gives an explicit read-modify-write workflow ('read it with get_journey, change it, send it back') and the key when-not condition: on a published journey this only creates a draft, so the agent must call publish_journey to go live. Alternatives are named directly.

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

All HelpWell toolsInspect
Try in Browser
Context All Your Agents Can ShareAgents share what they learn, hand off work, and hold it when you switch models. Start with 5 GB free.fulcradynamics.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources