Skip to main content
Glama

Update a newsletter

update_newsletter
Destructive

Changes a draft or ready newsletter: name, audience, subject, preheader or body fields, or marks it ready (ready: true) or back to draft. Changing a body field rebuilds the body from the plain fields, replacing block edits made in the editor; subject, preheader and audience changes keep the body. Pass document to replace the whole email document as get_newsletter returns it.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
htmlNoOptional: a full HTML body instead of the blocks (it is sanitized; the brand header, address and unsubscribe footer are added).
nameNo
readyNotrue marks it ready to schedule or use in a journey; false back to draft.
titleNoThe headline.
ctaUrlNoButton link (https).
layoutNo
eyebrowNoSmall line above the title.
signoffNoClosing line.
subjectNoSubject line.
audienceNoWho it goes to: contacts in ANY (match "any") or ALL (match "all") of the included segments, tags and filters, minus the excluded ones. Nothing included means every contact of the product. Consent and suppressions are always applied on top.
ctaLabelNoButton label.
documentNoOptional: the complete email document (as get_newsletter returns it).
sectionsNoBody sections, each with a heading and body text.
subjectBNoOptional second subject for an A/B test (half the audience gets each).
preheaderNoPreview text after the subject.
productIdNoProduct id, or null for every product.
campaignIdYesNewsletter id from list_newsletters.
introductionNoOpening paragraph(s). {{first_name}} and other merge tags work.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already flag destructiveHint=true and non-idempotency, but the description goes further and states exactly what is lost: changing a body field rebuilds the body from plain fields and discards block edits made in the editor, while subject/preheader/audience edits preserve the body. That is precisely the kind of "what gets destroyed" context the annotations cannot convey. It omits return/validation behavior, keeping it below 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 changeable state and fields, then the destructive body-rebuild warning, then the document override. Dense but each sentence carries distinct information. Slightly baroque in phrasing but nothing is wasted.

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 an 18-parameter destructive mutation with no output schema, the description covers the highest-risk behavior (body rebuild vs. preservation) that an agent needs before calling. It does not address partial-update semantics for the many optional fields or any confirmation requirements, leaving a small gap.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is high (89%), so a baseline of 3 applies, but the description adds real meaning: it explains the side-effect difference between body-field edits and subject/preheader/audience edits, and that `document` replaces the whole email document exactly as get_newsletter returns it. That interpretation guidance is not derivable from the schema alone.

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?

The description names a specific verb (changes/updates) and resource (a draft or ready newsletter), and enumerates the fields it can touch, so it is clearly distinct from create_newsletter, get_newsletter or schedule_newsletter. It stops short of explicitly naming siblings to route against, so it lands just under a 5.

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?

Usage is implied rather than stated: the description assumes the agent already knows to reach for this when editing an existing newsletter, and never says when NOT to use it (e.g., create, generate, or schedule_newsletter for those intents). It does clarify the accepted states (draft or ready), which is useful but not a when-to-use rule.

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