Skip to main content
Glama

Preview a newsletter

preview_newsletter
Read-onlyIdempotent

Renders a saved newsletter as one contact (or you) would get it: subject, preheader, the plain-text version, merge fields that print nothing, and personalization problems. Nothing is sent.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
variantNoWhich subject of an A/B test.
contactIdNoPreview as this contact (optional).
campaignIdYesNewsletter id from list_newsletters.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnly, non-destructive, idempotent, and closed-world, so the safety profile is covered. The description adds genuine context beyond that: what the render includes (merge fields that print nothing, personalization problems) and the explicit assurance that nothing is sent. It does not mention rate limits or whether previews affect any send metrics.

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?

One sentence, verb front-loaded, with the output contents listed after a colon and the no-side-effect guarantee in a short trailing clause. No filler and nothing an agent needs is buried.

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?

With no output schema, the description carries the burden of describing the return content and does so concretely, plus it rules out side effects. What's missing is minor: whether the preview consumes test-send quota or reflects the same render pipeline as an actual send.

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 100%, so the baseline is 3, but the description adds real meaning the schema lacks: it clarifies that omitting contactId previews as 'you', and that a preview is rendered 'as one contact' would receive it. The variant enum and campaignId sourcing are left entirely to the schema.

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 specific verb+resource ('Renders a saved newsletter') and enumerates exactly what the render contains (subject, preheader, plain-text, merge fields, personalization problems). The closing 'Nothing is sent' implicitly contrasts it with send_test_newsletter, but no sibling is named outright, so it stops short of full differentiation.

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 only implied: an agent can infer this is the pre-send inspection step and that contactId previews as a specific person. There is no explicit 'use this instead of X when...' guidance against send_test_newsletter, check_newsletter, or get_newsletter.

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