Skip to main content
Glama

Preview who a campaign would reach

previewSend
Read-onlyIdempotent

Work out exactly how many contacts a campaign to this segment would actually reach right now, and why the rest would not - suppressed, unsubscribed, mailed too recently, or over today's limit. Always do this before proposing a send.

Only for a workspace with subscribed email contacts.

Input Schema

NameRequiredDescriptionDefault
segmentKeyYesWhich audience: 'all', a segment's key, or a segment's id, exactly as readSegments gives them
workspaceIdNoThe workspace, as listWorkspaces gives it (its id or slug). Leave it out when this connection reaches one workspace.

Output Schema

NameRequiredDescriptionDefault
caveatsYesWhat this preview cannot see
sampledYesThe audience was too large to count in full; the numbers are for the first part of it
audienceYesContacts in the segment, before anything is taken out
reachableYesHow many would be mailed right now
suppressedYesOn the suppression list: bounced or complained
notSubscribedYes
dailyRemainingYesWhat is left of today's sending allowance; null when the plan has no daily cap
frequencyCappedYesMailed too recently
deferredToTomorrowYesWould be mailed, but over today's sending allowance, so they wait

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Beyond the read-only and idempotent annotations, the description explains that the tool breaks down reach by exclusion reason: suppressed, unsubscribed, recently mailed, or over today's limit. That adds useful behavioral context about what the preview reports, though it does not discuss auth or rate limits.

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?

Two sentences, no wasted words. The core purpose is front-loaded, and the prerequisite and workflow instruction follow compactly.

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?

For a read-only preview tool with a full input schema, an output schema, and clear annotations, the description supplies everything an agent needs: what is computed, why exclusions occur, when to use it, and the workspace prerequisite. Return-value details can be left to the output schema.

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 segmentKey and workspaceId are already documented in the schema. The description refers to 'this segment' but does not add parameter syntax, format, or examples beyond what the schema provides, so the baseline of 3 applies.

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 states a specific verb and resource: calculating how many contacts a campaign would reach for a segment and why others would be excluded. It is clearly a preview/reach-count operation, distinguishable from siblings such as sendTestCampaign or scheduleCampaign.

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?

It gives explicit workflow guidance: 'Always do this before proposing a send.' It also states a prerequisite constraint: only for a workspace with subscribed email contacts. It does not name alternative tools, but the when-to-use context is strong.

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