Skip to main content
Glama
mailbox-mcp

mailbox-mcp

get_batch_mail

Read-onlyIdempotent

Retrieve a mail batch's status, recipient summary, pricing, links, and first 50 pieces by batch ID. Poll it after confirming a batch to track progress or handle failures.

Instructions

A batch with its status (draft → paid → generating → submitted → in_progress → completed | partially_completed | failed; cancelled), recipient summary, pricing (credits_charged, refunded_cents), links and the first 50 pieces. Poll it after confirm; batch.submitted / batch.completed also arrive on the agent's webhook.

Input Schema

NameRequiredDescriptionDefault
batch_idYesThe batch's id (UUID) from create_batch_mail or list_batch_mail.

Output Schema

NameRequiredDescriptionDefault
resultYesbatch and pieces (first 50 in mailing order).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.0.4

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already establish readOnly/idempotent/non-destructive, and the description adds genuinely new behavior: the full status lifecycle, the 'first 50 pieces' truncation boundary, and webhook events that duplicate this data. It doesn't state what happens beyond 50 pieces (pagination or a separate call), which is the one gap.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

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

The status-chain parenthetical is valuable but dense, and the sentence opens with the clipped fragment 'A batch with its status' rather than a verb-first statement of the action. Two sentences total with little waste, but the front-loading could be stronger.

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 an output schema present, return values needn't be spelled out, and the description still summarizes them usefully. Polling guidance and webhook alternatives cover the main operational question; only the post-50-pieces behavior is left unaddressed.

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% and the single batch_id parameter is already documented in the schema as a UUID sourced from create_batch_mail or list_batch_mail. The description adds nothing about the parameter, so baseline 3 applies.

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?

It describes retrieving a single batch and enumerates what comes back (status, recipient summary, pricing, links, first 50 pieces), which is enough to tell it apart from list_batch_mail. It never uses an explicit verb like 'fetch' and relies on the schema's mention of create_batch_mail/list_batch_mail for framing, so it is clear but not razor-sharp.

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?

'Poll it after confirm' gives an explicit trigger, and the mention of batch.submitted / batch.completed webhooks tells the agent when polling is unnecessary. It stops short of naming list_batch_mail as the alternative for enumerating batches, so the routing is implied rather than stated.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.