Get a JsonFabrica batch

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

No annotations are provided, so the description carries the full burden. It discloses that the tool performs a GET, returns batch status, and only returns generated documents once the batch is complete. The async 202 polling context is useful behavioral information beyond the bare endpoint.

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?

Two tightly written sentences that lead with the HTTP operation and endpoint, then describe the return value and the intended polling use case. No filler or redundant 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 single-parameter read/poll tool, the description covers the endpoint, what is returned, and when to call it. It does not describe error conditions, status values, or auth requirements, but those are not essential for basic correct invocation.

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 0% and the only parameter, batchId, has no description beyond its type. The description adds the URL path context (/v1/batches/{batchId}), confirming batchId is a path parameter, but it does not explain where the batch ID comes from or any format constraints.

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?

States the exact operation ('Calls GET /v1/batches/{batchId}') and the resource (batch), and explains what it returns. The description distinguishes it clearly from siblings like create_batch and generate_from_template by focusing on retrieval and polling.

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 tells the agent when to use it: 'Use this to poll a batch that was accepted asynchronously (202).' This is clear contextual guidance, though it does not mention when not to use it or name alternative tools.

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