Get batch
get_batchA draft or bought batch: shipments, tracking, rates to buy, what can be refunded.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| batch_id | Yes | From create_shipment or list_batches. |
get_batchA draft or bought batch: shipments, tracking, rates to buy, what can be refunded.
| Name | Required | Description | Default |
|---|---|---|---|
| batch_id | Yes | From create_shipment or list_batches. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description's value-add is telling the agent that the response spans shipments, tracking, buyable rates and refundable amounts, which is useful since no output schema exists, but it does not say anything about the draft-vs-bought distinction as a behavioral state (e.g., rates only present for drafts).
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?
A single compact clause with no waste, and the resource identity is front-loaded. The noun-phrase phrasing is slightly telegraphic and would read better as a verb phrase, but nothing is padded.
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 one-parameter read-only getter with full annotation coverage and full schema coverage, the description supplies the key missing piece: what the returned batch payload contains. It is nearly complete, falling short only on how draft and bought batches differ in that payload.
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?
Only one parameter exists and schema description coverage is 100% with an explicit provenance note ('From create_shipment or list_batches'). The description adds nothing about the batch_id format or prefix, so the baseline 3 applies.
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 characterizes the resource (a draft or bought batch) and enumerates its contents, which implies a retrieval tool, but it never states the verb 'get' or 'retrieve' and never contrasts itself with the sibling list_batches. An agent can infer the purpose but must read the name to confirm it is a single-resource fetch rather than another listing.
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?
There is no when-to-use guidance, no prerequisites, and no named alternative. The parameter schema notes batch_id comes from create_shipment or list_batches, but that is schema text, not description text, so the description itself offers no routing help.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.