HelpWell

Update a proactive message

update_proactive_message

Destructive

Changes a message. Each part given (content, audience, pages, trigger, frequency, schedule, goal) replaces that part; parts left out stay. A live message must stay complete.

Input Schema

Name	Required	Description
`goal`	No	What counts as success: { event (a journey trigger name such as page.visited, or null), name (for custom.event), days, stop: stop showing it to people who reached it }.
`name`	No	Internal name.
`pages`	No	Page paths: { include: ["/pricing", "/docs/**"], exclude: [] }. No includes means every page.
`content`	No	By kind. chat: { text (markdown, at most 300 chars, {{first_name}} works), sender: {type:"agent"} \| {type:"member",userId} \| {type:"team",name}, display: "bubble"\|"messenger", buttons: [{label, action: url\|chat\|article\|dismiss\|reply, value}], replyable }. popup: { slides: [{ title, text, button: {label, action, value} \| null, media: null }], size: small\|medium\|large, layout: top\|side\|background, dismissible }. banner: { text (at most 120 chars), position: top\|bottom, style: inline\|floating, tone: accent\|neutral\|warning, cta: { type: none\|link\|button, label, url }, dismissible }.
`trigger`	No	Popups and banners only: when it shows. { type: "load" } \| { type: "delay", seconds } \| { type: "scroll", percent } \| { type: "exit" } \| { type: "time_on_page", seconds } \| { type: "inactivity", seconds } \| { type: "click", selector } \| { type: "event", name } \| { type: "manual" }.
`audience`	No	Who sees it: { who: all\|identified\|anonymous\|journey ("journey" only when a journey sends it), device: any\|desktop\|mobile, utm: {source, medium, campaign}, conditions: rules on contact fields }.
`priority`	No	Higher shows first.
`schedule`	No	{ start, end }: ISO dates or null.
`frequency`	No	{ repeat: once\|session\|days, days (for "days"), skipIfChatted: skip people who chatted in the last day }.
`messageId`	Yes	Proactive message id from list_proactive_messages.
`productId`	No	One product, or null for every product.

Schema Changelog

Changes observed during successful MCP inspections.

Changed5 schema fields changedOct 26, 2026

changedInput schema / properties / audience / properties / conditions / description

Previous value: -"Conditions on contact fields. mode \"all\" or \"any\"; each rule is { field, operator, value }. Fields: contact.name, contact.email, contact.consent (subscribed | unknown | unsubscribed), contact.email_status, contact.product_id, contact.created_at, contact.last_seen_at, contact.attributes.<field> (tags are contact.attributes.tags), contact.events.<event>. Operators: is, is_not, contains, not_contains, gt, lt, exists, missing, before, after (dates are ISO or now-7d)."New value: +"Conditions on contact fields. mode \"all\" or \"any\"; each rule is { field, operator, value }. Fields: contact.name, contact.email, contact.consent (subscribed | unknown | unsubscribed), contact.email_status, contact.product_id, contact.created_at, contact.last_seen_at, contact.attributes.<field> (tags are contact.attributes.tags), contact.events.<event>. Operators: is, is_not, contains, not_contains, gt, gte, lt, lte, between (value and value2), any_of and none_of (value is a list of strings), exists, missing, before, after (dates are ISO or now-7d)."

changed

Input schema / properties / audience / properties / conditions / properties / rules / items / properties / operator / enum

Previous value: -[
-  "is",
-  "is_not",
-  "contains",
-  "not_contains",
-  "gt",
-  "lt",
-  "exists",
-  "missing",
-  "before",
-  "after"
-]New value: +[
+  "is",
+  "is_not",
+  "contains",
+  "not_contains",
+  "gt",
+  "gte",
+  "lt",
+  "lte",
+  "between",
+  "any_of",
+  "none_of",
+  "exists",
+  "missing",
+  "before",
+  "after"
+]

addedInput schema / properties / audience / properties / conditions / properties / rules / items / properties / value / anyOf

Added value: +[
+  {
+    "type": [
+      "string",
+      "number",
+      "boolean"
+    ]
+  },
+  {
+    "items": {
+      "type": "string"
+    },
+    "type": "array"
+  }
+]

removedInput schema / properties / audience / properties / conditions / properties / rules / items / properties / value / type
```
Removed value: -[
-  "string",
-  "number",
-  "boolean"
-]
```
addedInput schema / properties / audience / properties / conditions / properties / rules / items / properties / value2
```
Added value: +{
+  "type": [
+    "string",
+    "number"
+  ]
+}
```

First observedOct 18, 2026

TDQS

B3.4/5.0

Behavior3/5

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

Annotations already declare destructiveHint=true, idempotentHint=false, and readOnlyHint=false. The description adds genuinely non-obvious behavior — replace-only-supplied-parts and a completeness invariant for live messages — but omits the consequences of the destructive flag (what is lost, whether a live message can be broken, whether changes are recoverable).

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 short sentences, front-loaded with the action and the patch rule; no filler. 'Changes a message' is slightly under-specified compared to 'proactive message', and 'must stay complete' is left undefined, but nothing is wasted.

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

Completeness3/5

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

With 11 parameters, deep nesting, no output schema, and a destructive mutation, the description covers the core edit model but says nothing about required messageId, product scope, priority conflicts, or what a failed completeness check looks like. Adequate, not complete.

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 every parameter including nested objects is already documented in detail. The description only adds replace-vs-omit semantics per part, which is useful but marginal against a fully-annotated schema. Baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a clear verb and resource ('Changes a message') and the parenthetical enumerates exactly which parts are updatable, which maps to the schema properties. It does not name the sibling update/create/delete tools, but 'update_proactive_message' plus the title make the target unambiguous.

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

Usage Guidelines3/5

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

The patch semantics implicitly define usage (supply only what you want to change), and 'A live message must stay complete' hints at a validation rule. However, it never says when to use this versus create_proactive_message or delete_proactive_message, and gives no prerequisites for a live/published message.

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

All HelpWell 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?