Skip to main content
Glama
cotletdev

Pirate Ship MCP Server

Get batch

get_batch
Read-onlyIdempotent

Retrieve a Pirate Ship batch to inspect shipments, tracking numbers, rates available to buy, label status, and refund eligibility for drafting, purchasing, or managing labels.

Instructions

A draft or bought batch: shipments, tracking, rates to buy, what can be refunded.

One Pirate Ship batch: a single label from create_shipment is a batch of one. A draft (step Rated) lists every rate the packages qualify for, with rate_id for buy_label. A bought batch (Billed) shows each shipment's status, tracking number and link, whether its label can be printed or refunded, and what was paid per service.

Input Schema

NameRequiredDescriptionDefault
batch_idYesFrom create_shipment or list_batches.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already establish readOnly, idempotent, non-destructive. The description adds genuine state-dependent behavior beyond that: a Rated draft lists all qualifying rates with rate_id, while a Billed batch reports per-shipment status, tracking, print/refund eligibility and amount paid per service. It stops short of noting any auth or rate-limit considerations.

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 sentences, front-loaded with the subject before the exposition. Dense but every clause carries information; the long second sentence is justified by the distinct draft vs bought payload differences.

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

Completeness5/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 bears full responsibility for describing return values — and it does so thoroughly for both states, including the fields an agent would need to act on (rate_id, tracking, print/refund flags). Nothing essential to calling or interpreting the result is missing.

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?

Only one parameter with 100% schema description coverage, so the schema already carries batch_id's origin ('From create_shipment or list_batches'). The description adds no further semantics about the identifier, so baseline 3 applies.

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?

States a specific resource (a single Pirate Ship batch) and enumerates its contents, distinguishing draft (Rated) from bought (Billed) states. It does not name a sibling like list_batches as the contrasting alternative, which keeps it just 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 Guidelines3/5

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

Usage is implied rather than stated: 'rates to buy' with rate_id points forward to buy_label, and the schema notes batch_id comes from create_shipment or list_batches. There is no explicit when-to-use-this-vs-list_batches guidance or exclusions.

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