postgrid_upload_pdf

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

With no annotations provided, the description carries the transparency burden and discloses decision-relevant traits: the URL expires after 5 minutes and the file is auto-deleted after 24 hours. It also notes the two accepted input modes. It stops short of describing failure behavior or the exact return payload, but covers the lifecycle constraints that matter most for downstream calls.

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

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

Four sentences, each with a distinct job: purpose, usage timing, input formats, and lifecycle. The most important fact (what it does) is front-loaded, and there is no filler or repetition of schema content.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a two-parameter tool with no output schema, the description covers what it does, when to use it, how to pass input, and how long the artifact persists. The return value is implied ('get a URL'), though the exact output shape and failure modes are not specified; the essentials for a correct call are present.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and each parameter already carries environment-specific guidance. The description adds the either/or semantic — 'Accepts either a local file path or base64-encoded PDF content' — which is valuable because both params are marked optional and an agent needs to know one is expected rather than both or neither.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific action (upload), resource (PDF), destination (temporary storage), and the result (a URL PostGrid can access). This clearly differentiates it from siblings like postgrid_create_letter and postgrid_get_upload_url.

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

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

Explicitly says 'Use this before postgrid_create_letter when you have a PDF file to mail,' giving both sequencing and the triggering condition. It does not enumerate when-not-to-use conditions or name alternatives beyond create_letter, so it falls short of a 5.

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