mailbox.bot

get_batch_mail

Read-onlyIdempotent

A batch with its status (draft → paid → generating → submitted → in_progress → completed | partially_completed | failed; cancelled), recipient summary, pricing (credits_charged, refunded_cents), field_kit, tracking (QR pieces scanned and confirmed), links and the first 50 pieces, each with its qr (code, link, your ref, scans, first_scanned_at, confirmed_at, expires_at; sandbox verify pieces also carry short_code). Poll it after confirm; batch.submitted / batch.completed also arrive on the agent's webhook. Every piece: page with offset and limit, or ask for the pieces scanned, confirmed (verify: the address verified) or not_scanned with qr; REST: GET /v1/batch-mail/{id}/pieces.

Input Schema

Name	Required	Description
`qr`	No	Only the pieces whose QR code was scanned, confirmed (verify: the address verified) or not scanned yet. Batches with QR codes only.
`limit`	No	Pieces per page, default 50.
`offset`	No	Pieces to skip, default 0.
`batch_id`	Yes	The batch's id (UUID) from create_batch_mail or list_batch_mail.

Output Schema

Name	Required	Description	Default
`result`	Yes	batch, pieces (in mailing order; the first 50 unless qr, limit or offset say otherwise) and pagination.

Schema Changelog

Changes observed during successful MCP inspections.

Changed4 schema fields changedOct 28, 2026

addedInput schema / properties / limit

Added value: +{
+  "description": "Pieces per page, default 50.",
+  "maximum": 100,
+  "minimum": 1,
+  "type": "integer"
+}

addedInput schema / properties / offset

Added value: +{
+  "description": "Pieces to skip, default 0.",
+  "maximum": 10000,
+  "minimum": 0,
+  "type": "integer"
+}

addedInput schema / properties / qr

Added value: +{
+  "description": "Only the pieces whose QR code was scanned, confirmed (verify: the address verified) or not scanned yet. Batches with QR codes only.",
+  "enum": [
+    "scanned",
+    "confirmed",
+    "not_scanned"
+  ],
+  "type": "string"
+}

changedOutput schema / properties / result / description

Previous value: -"batch and pieces (first 50 in mailing order)."New value: +"batch, pieces (in mailing order; the first 50 unless qr, limit or offset say otherwise) and pagination."

AddedOct 22, 2026

TDQS

A4.1/5.0

Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the safety profile is covered; the description adds real behavior beyond that — the status lifecycle chain, default page size of 50, and the fact that the same events are pushed to the webhook. It omits things like auth requirements or rate limits, so it's strong but not exhaustive.

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?

The purpose is front-loaded and most clauses earn their place, packed efficiently into a dense description. It is a long, heavily parenthesized run-on and ends with a trailing REST path that adds little, which keeps it from a 5.

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 tool with a full input schema plus an output schema, the description already over-delivers on return shape, status semantics, pagination, and webhook interplay. Nothing an agent needs to call it correctly is missing.

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 baseline is 3; the description still adds value by explaining the qr filter semantics in context ('the pieces scanned, confirmed (verify: the address verified) or not_scanned') and how offset/limit page through pieces. It doesn't deepen the batch_id parameter beyond what the schema already says.

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 names a specific verb and resource ('a batch with its status ... recipient summary, pricing, tracking...'), so an agent immediately knows it fetches a single batch-mail batch with full detail. It stops short of naming the obvious siblings it should be distinguished from, e.g. list_batch_mail and get_batch_mail_proof, which would make the boundary unambiguous.

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 explicit timing guidance tied to the confirm_batch_mail step, and it notes that batch.submitted / batch.completed also arrive on the webhook, which is a genuine alternative path. It doesn't state when *not* to use it (e.g. to list batches or to fetch proof artifacts), so it falls short of full when/when-not coverage.

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

All mailbox.bot tools Inspect

Try in Browser

Claude Code, inside the Godot 4 editorFlockbay puts an AI agent in the real Godot 4 editor: it writes GDScript, runs your game and fixes what breaks. Free, or bring your own Claude Code or Codex.flockbay.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.