Skip to main content
Glama

Mailrith Email Marketing

Change an automation status

automations_update_status
DestructiveIdempotent

Starts, pauses, or returns one Automation to draft without changing its definition. Effect: external-email. Retry after reading the current resource state. Permissions: live_actions:write, automations:write. API reference: https://mailrith.com/developers/api-reference.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYesThe exact JSON request body defined by the Mailrith public API contract.
automation_idYesThe Automation identifier.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
errorNo
responseNo
request_idYesThe stable correlation ID for this MCP tool invocation.
operation_idYesThe stable Mailrith public API operation ID.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • addedOutput schema / $defs / AutomationStepConfig / properties / subject / description
      Added value: +"For Subscriber personalization in email subjects and body text nodes, use Mailrith bracket tokens such as [Subscriber_Name, fallback=\"friend\"] or [Subscriber_Email, fallback=\"\"]. Before using a custom field, call custom_fields_list or custom_fields_get and copy its personalization_token exactly. Do not use Handlebars-style variables such as {{ subscriber.name }}; Mailrith sends them as literal text."
    • changedOutput schema / $defs / BroadcastEmailDocument / description
      Previous value: -"A structured email document. The root node must use type `doc` and contain supported block nodes."New value: +"A structured email document. The root node must use type `doc` and contain supported block nodes. For Subscriber personalization in email subjects and body text nodes, use Mailrith bracket tokens such as [Subscriber_Name, fallback=\"friend\"] or [Subscriber_Email, fallback=\"\"]. Before using a custom field, call custom_fields_list or custom_fields_get and copy its personalization_token exactly. Do not use Handlebars-style variables such as {{ subscriber.name }}; Mailrith sends them as literal text."
    • changedOutput schema / $defs / BroadcastEmailDocument / example / content
      Previous value: -[
      -  {
      -    "content": [
      -      {
      -        "text": "Hello from Mailrith.",
      -        "type": "text"
      -      }
      -    ],
      -    "type": "paragraph"
      -  }
      -]New value: +[
      +  {
      +    "content": [
      +      {
      +        "text": "Hello [Subscriber_Name, fallback=\"friend\"].",
      +        "type": "text"
      +      }
      +    ],
      +    "type": "paragraph"
      +  }
      +]
    • changedOutput schema / $defs / BroadcastEmailDocument / examples
      Previous value: -[
      -  {
      -    "content": [
      -      {
      -        "content": [
      -          {
      -            "text": "Hello from Mailrith.",
      -            "type": "text"
      -          }
      -        ],
      -        "type": "paragraph"
      -      }
      -    ],
      -    "type": "doc"
      -  }
      -]New value: +[
      +  {
      +    "content": [
      +      {
      +        "content": [
      +          {
      +            "text": "Hello [Subscriber_Name, fallback=\"friend\"].",
      +            "type": "text"
      +          }
      +        ],
      +        "type": "paragraph"
      +      }
      +    ],
      +    "type": "doc"
      +  }
      +]
  2. Changed4 schema fields changed
    • removedOutput schema / $defs / AutomationStepConfig / properties / subject / description
      Removed value: -"For Subscriber personalization in email subjects and body text nodes, use Mailrith bracket tokens such as [Subscriber_Name, fallback=\"friend\"] or [Subscriber_Email, fallback=\"\"]. Before using a custom field, call custom_fields_list or custom_fields_get and copy its personalization_token exactly. Do not use Handlebars-style variables such as {{ subscriber.name }}; Mailrith sends them as literal text."
    • changedOutput schema / $defs / BroadcastEmailDocument / description
      Previous value: -"A structured email document. The root node must use type `doc` and contain supported block nodes. For Subscriber personalization in email subjects and body text nodes, use Mailrith bracket tokens such as [Subscriber_Name, fallback=\"friend\"] or [Subscriber_Email, fallback=\"\"]. Before using a custom field, call custom_fields_list or custom_fields_get and copy its personalization_token exactly. Do not use Handlebars-style variables such as {{ subscriber.name }}; Mailrith sends them as literal text."New value: +"A structured email document. The root node must use type `doc` and contain supported block nodes."
    • changedOutput schema / $defs / BroadcastEmailDocument / example / content
      Previous value: -[
      -  {
      -    "content": [
      -      {
      -        "text": "Hello [Subscriber_Name, fallback=\"friend\"].",
      -        "type": "text"
      -      }
      -    ],
      -    "type": "paragraph"
      -  }
      -]New value: +[
      +  {
      +    "content": [
      +      {
      +        "text": "Hello from Mailrith.",
      +        "type": "text"
      +      }
      +    ],
      +    "type": "paragraph"
      +  }
      +]
    • changedOutput schema / $defs / BroadcastEmailDocument / examples
      Previous value: -[
      -  {
      -    "content": [
      -      {
      -        "content": [
      -          {
      -            "text": "Hello [Subscriber_Name, fallback=\"friend\"].",
      -            "type": "text"
      -          }
      -        ],
      -        "type": "paragraph"
      -      }
      -    ],
      -    "type": "doc"
      -  }
      -]New value: +[
      +  {
      +    "content": [
      +      {
      +        "content": [
      +          {
      +            "text": "Hello from Mailrith.",
      +            "type": "text"
      +          }
      +        ],
      +        "type": "paragraph"
      +      }
      +    ],
      +    "type": "doc"
      +  }
      +]
  3. Changed4 schema fields changed
    • addedOutput schema / $defs / AutomationStepConfig / properties / subject / description
      Added value: +"For Subscriber personalization in email subjects and body text nodes, use Mailrith bracket tokens such as [Subscriber_Name, fallback=\"friend\"] or [Subscriber_Email, fallback=\"\"]. Before using a custom field, call custom_fields_list or custom_fields_get and copy its personalization_token exactly. Do not use Handlebars-style variables such as {{ subscriber.name }}; Mailrith sends them as literal text."
    • changedOutput schema / $defs / BroadcastEmailDocument / description
      Previous value: -"A structured email document. The root node must use type `doc` and contain supported block nodes."New value: +"A structured email document. The root node must use type `doc` and contain supported block nodes. For Subscriber personalization in email subjects and body text nodes, use Mailrith bracket tokens such as [Subscriber_Name, fallback=\"friend\"] or [Subscriber_Email, fallback=\"\"]. Before using a custom field, call custom_fields_list or custom_fields_get and copy its personalization_token exactly. Do not use Handlebars-style variables such as {{ subscriber.name }}; Mailrith sends them as literal text."
    • changedOutput schema / $defs / BroadcastEmailDocument / example / content
      Previous value: -[
      -  {
      -    "content": [
      -      {
      -        "text": "Hello from Mailrith.",
      -        "type": "text"
      -      }
      -    ],
      -    "type": "paragraph"
      -  }
      -]New value: +[
      +  {
      +    "content": [
      +      {
      +        "text": "Hello [Subscriber_Name, fallback=\"friend\"].",
      +        "type": "text"
      +      }
      +    ],
      +    "type": "paragraph"
      +  }
      +]
    • changedOutput schema / $defs / BroadcastEmailDocument / examples
      Previous value: -[
      -  {
      -    "content": [
      -      {
      -        "content": [
      -          {
      -            "text": "Hello from Mailrith.",
      -            "type": "text"
      -          }
      -        ],
      -        "type": "paragraph"
      -      }
      -    ],
      -    "type": "doc"
      -  }
      -]New value: +[
      +  {
      +    "content": [
      +      {
      +        "content": [
      +          {
      +            "text": "Hello [Subscriber_Name, fallback=\"friend\"].",
      +            "type": "text"
      +          }
      +        ],
      +        "type": "paragraph"
      +      }
      +    ],
      +    "type": "doc"
      +  }
      +]
  4. First observed

TDQS

A4.4/5.0
Behavior5/5

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

Annotations already show readOnlyHint=false and destructiveHint=true, but the description adds valuable context: 'Effect: external-email' warns of external side effects, 'Retry after reading the current resource state' gives practical retry guidance, and permissions are listed. This goes beyond the basic annotations without contradicting them.

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?

The description is concise and front-loaded with the action. It uses compact phrases for effect, retry, permissions, and API reference, with no filler or repetition. Every sentence contributes functional guidance.

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?

The tool has an output schema, so return values need not be explained. The description covers core behavior, side effects, retry semantics, and permissions. It omits prerequisites like requiring the automation to exist, but that is standard and not a significant gap for a status-update tool.

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%, with both automation_id and body having descriptions. The description maps the action verbs to status enum values ('starts'='running', 'pauses'='paused', 'returns to draft'='draft'), which is mildly helpful but largely redundant given the schema's enum.

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?

The description clearly states the tool starts, pauses, or returns an automation to draft, with the key qualifier 'without changing its definition.' This specific verb+resource+scope distinguishes it from sibling tools like automations_update, which handles definition changes.

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?

The description provides clear context for use by noting it handles status changes only ('without changing its definition'), implying that automations_update is for definition changes. It does not explicitly name alternative tools, but the scope is well-defined enough for an agent to choose correctly.

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.