Skip to main content
Glama

Create a resource proof

lob_resource_proofs_create
Idempotent

Generate a PDF proof of a postcard, letter, or self-mailer to review before sending mail. Pass resource parameters to preview print output.

Instructions

Create a proof — a PDF preview of how a resource (postcard, letter, self-mailer) will print — for review before committing to a mail send. Pass resource_parameters with the same shape you would pass to the underlying create endpoint (e.g. { front, back, to } for a postcard). Returns once Lob has rendered the proof (bounded by LOB_PROOF_WAIT_MS); one still rendering comes back with render_pending: true. Note: the lob_*_preview tools call this endpoint internally; this raw tool is exposed for advanced use cases.

Input Schema

NameRequiredDescriptionDefault
extraNoAdditional Lob API parameters not enumerated above. Merged into the request body verbatim. See https://docs.lob.com for the full parameter list per resource.
template_idNoOptional template ID to associate with the proof.
resource_typeYesType of resource being proofed.
resource_parametersYesParameters matching the resource type's create shape — e.g. `{ front, back, to }` for a postcard, `{ file, to }` for a letter. Each field accepts an HTML string, URL, or template ID.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.3.0

TDQS

A4.3/5.0
Behavior4/5

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

Annotations only declare the safety profile (non-read-only, idempotent, non-destructive, open-world). The description adds real behavioral context the annotations don't: the call blocks until Lob renders the proof, bounded by LOB_PROOF_WAIT_MS, and returns render_pending: true when still rendering. That renders-safe, returns-something-unfinished nuance is valuable and non-obvious.

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 resource definition before the usage caveat. Dense and mostly waste-free; the caveat sentence is long but carries routing value.

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?

No output schema exists, so the description correctly carries the return-value burden by explaining the render_pending fallback and the blocking window. Combined with the sibling-routing note, an agent has enough to call and interpret it correctly.

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 the schema already documents all four parameters. The description's note that resource_parameters mirrors the underlying create endpoint's shape (with examples) adds mild provenance context but little beyond the schema, 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?

Specific verb+resource: 'Create a proof — a PDF preview of how a resource (postcard, letter, self-mailer) will print.' It defines the artifact precisely and its role in the mail workflow, clearly distinguishing it from the create/send siblings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly states when to use it ('for review before committing to a mail send') and, more importantly, when not to: it names that the lob_*_preview tools call this endpoint internally and that the raw tool is for advanced use cases, routing the agent to the simpler alternative.

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

Deploy Server

Other Tools