Skip to main content
Glama

Get batch

get_batch
Read-onlyIdempotent

Retrieve a Bannerbear batch by UID to inspect its processing status, outputs, and job details.

Instructions

GET /v5/batches/{uid}. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Read operation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uidYes
accountNoExact private workspace profile label; no fallback to another profile key.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

B3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is covered. The description adds the note that 'provider scopes, locks and credits apply,' which hints at operational constraints, but it is boilerplate-vague and does not explain scope requirements or credit implications concretely.

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?

Two short sentences, front-loaded with the endpoint, with no wasted preamble. The second sentence is generic boilerplate but does not bloat the definition.

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

Completeness3/5

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

There is no output schema, so the description could describe what a batch response contains (status, counts, etc.), and it does not. For a simple read tool whose annotations carry the safety profile, this is adequate but leaves the agent guessing about return contents and scope prerequisites.

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

Parameters2/5

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

Schema coverage is only 50%: account is documented in the schema, but uid has no description. The description merely embeds {uid} in the path without explaining its meaning, format, or where to obtain it, so it fails to compensate for the coverage gap.

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?

The description gives a specific verb+resource via the endpoint 'GET /v5/batches/{uid}', making it clear this retrieves one batch identified by uid, distinct from list_batches. However it offers no explicit sibling differentiation or statement of what a 'batch' is, so it stops short of a 5.

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

Usage Guidelines2/5

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

There is no when-to-use guidance: nothing tells the agent to prefer this over list_batches, or when a batch uid is known versus discovered. 'Read operation.' restates a safety fact rather than describing usage context.

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