Skip to main content
Glama

Mailrith Email Marketing

Activate or pause a sequence

sequences_update_status
DestructiveIdempotent

Starts or pauses one Sequence without changing its content or delivery settings. Effect: external-email. Retry after reading the current resource state. Permissions: live_actions:write, sequences:write. API reference: https://mailrith.com/developers/api-reference.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "sequence_id": "<sequence_id>",
      "body": "<body>"
    },
    "name": "sequences_update_status"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesThe exact JSON request body defined by the Mailrith public API contract.
sequence_idYesThe Sequence identifier.

Output 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. Changed1 schema field changed
    • changedOutput schema / $defs / Sequence / properties / reply_to_email / anyOf
      Previous value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "description": "An override for this email's Reply-To. Null uses the sender's current Reply-To when the email is sent.",
      +    "type": "string"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
  2. Changed6 schema fields changed
    • 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"
      +  }
      +]
    • addedOutput schema / $defs / BroadcastSendProgress / properties / sent
      Added value: +{
      +  "type": "integer"
      +}
    • changedOutput schema / $defs / BroadcastSendProgress / required
      Previous value: -[
      -  "run_id",
      -  "phase",
      -  "selected",
      -  "materialized",
      -  "accepted",
      -  "skipped",
      -  "retrying",
      -  "permanent_failed",
      -  "unknown",
      -  "canceled",
      -  "percent_complete",
      -  "effective_rate",
      -  "provider_limited_rate",
      -  "provider",
      -  "estimated_completion",
      -  "estimated_completion_basis",
      -  "last_progress_at",
      -  "pause_reason",
      -  "next_retry_at",
      -  "next_retry_action",
      -  "pause_message",
      -  "terminal"
      -]New value: +[
      +  "run_id",
      +  "phase",
      +  "selected",
      +  "materialized",
      +  "sent",
      +  "accepted",
      +  "skipped",
      +  "retrying",
      +  "permanent_failed",
      +  "unknown",
      +  "canceled",
      +  "percent_complete",
      +  "effective_rate",
      +  "provider_limited_rate",
      +  "provider",
      +  "estimated_completion",
      +  "estimated_completion_basis",
      +  "last_progress_at",
      +  "pause_reason",
      +  "next_retry_at",
      +  "next_retry_action",
      +  "pause_message",
      +  "terminal"
      +]
    • addedOutput schema / $defs / SequenceEmail / 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."
  3. Changed6 schema fields changed
    • 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"
      +  }
      +]
    • removedOutput schema / $defs / BroadcastSendProgress / properties / sent
      Removed value: -{
      -  "type": "integer"
      -}
    • changedOutput schema / $defs / BroadcastSendProgress / required
      Previous value: -[
      -  "run_id",
      -  "phase",
      -  "selected",
      -  "materialized",
      -  "sent",
      -  "accepted",
      -  "skipped",
      -  "retrying",
      -  "permanent_failed",
      -  "unknown",
      -  "canceled",
      -  "percent_complete",
      -  "effective_rate",
      -  "provider_limited_rate",
      -  "provider",
      -  "estimated_completion",
      -  "estimated_completion_basis",
      -  "last_progress_at",
      -  "pause_reason",
      -  "next_retry_at",
      -  "next_retry_action",
      -  "pause_message",
      -  "terminal"
      -]New value: +[
      +  "run_id",
      +  "phase",
      +  "selected",
      +  "materialized",
      +  "accepted",
      +  "skipped",
      +  "retrying",
      +  "permanent_failed",
      +  "unknown",
      +  "canceled",
      +  "percent_complete",
      +  "effective_rate",
      +  "provider_limited_rate",
      +  "provider",
      +  "estimated_completion",
      +  "estimated_completion_basis",
      +  "last_progress_at",
      +  "pause_reason",
      +  "next_retry_at",
      +  "next_retry_action",
      +  "pause_message",
      +  "terminal"
      +]
    • removedOutput schema / $defs / SequenceEmail / 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."
  4. Changed4 schema fields changed
    • 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"
      +  }
      +]
    • addedOutput schema / $defs / SequenceEmail / 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."
  5. Changed2 schema fields changed
    • addedOutput schema / $defs / BroadcastSendProgress / properties / sent
      Added value: +{
      +  "type": "integer"
      +}
    • changedOutput schema / $defs / BroadcastSendProgress / required
      Previous value: -[
      -  "run_id",
      -  "phase",
      -  "selected",
      -  "materialized",
      -  "accepted",
      -  "skipped",
      -  "retrying",
      -  "permanent_failed",
      -  "unknown",
      -  "canceled",
      -  "percent_complete",
      -  "effective_rate",
      -  "provider_limited_rate",
      -  "provider",
      -  "estimated_completion",
      -  "estimated_completion_basis",
      -  "last_progress_at",
      -  "pause_reason",
      -  "next_retry_at",
      -  "next_retry_action",
      -  "pause_message",
      -  "terminal"
      -]New value: +[
      +  "run_id",
      +  "phase",
      +  "selected",
      +  "materialized",
      +  "sent",
      +  "accepted",
      +  "skipped",
      +  "retrying",
      +  "permanent_failed",
      +  "unknown",
      +  "canceled",
      +  "percent_complete",
      +  "effective_rate",
      +  "provider_limited_rate",
      +  "provider",
      +  "estimated_completion",
      +  "estimated_completion_basis",
      +  "last_progress_at",
      +  "pause_reason",
      +  "next_retry_at",
      +  "next_retry_action",
      +  "pause_message",
      +  "terminal"
      +]
  6. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare destructive, idempotent, and open-world behavior, while the description adds useful context: required permissions and the external-email effect. It does not explain precisely what makes the operation destructive, but it goes meaningfully beyond the 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.

Conciseness5/5

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

The description is short, front-loads the core action, and then adds effect, retry guidance, permissions, and reference in a compact sequence. Every sentence contributes operational context without repetition.

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?

Given the annotations, complete input schema, and presence of an output schema, the description supplies the remaining important context: external-email effect, required permissions, and retry guidance. It is complete enough for an agent to invoke the tool with appropriate caution.

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 both sequence_id and the nested status field are already documented structurally. The description says starts or pauses, which loosely maps to the status enum, but adds no parameter-level details beyond the schema.

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 names a specific action pair and resource: "Starts or pauses one Sequence." It also distinguishes the scope from content/settings changes by saying "without changing its content or delivery settings," which helps separate it from sequences_update.

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 description implies this is the status-only operation and advises retrying after reading current state, but it does not explicitly name alternatives such as sequences_update or sequences_get. Usage is inferable but not fully guided.

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.