Skip to main content
Glama

Get a shipment

get_shipment
Read-onlyIdempotent

Everything about one shipment: status, route, ETA (effective_eta is the one to quote, with original_eta and predicted_eta beside it), carrier, parties, cargo, containers, labels, check counts, notes, and a free_time summary with the demurrage and detention clocks. Use it for "when does it arrive" or "how many free days are left". For where a shipment is now or the way it is taking, use get_tracking_timeline, which also shows a map (the same route, vessel and track data is the REST API's GET /shipments/{id}/map); for paperwork use list_documents. url is the shipment's page in Trackberry: link its display_name (container or air waybill number) to it, never a made-up URL. public_tracking_url is the shareable tracking page that needs no login, for sending to a customer or partner; it is null when the organization has public pages off or the shipment is archived or not yet live, so never invent one.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
shipment_idYesA shipment id such as "shp_123", as returned by search_shipments.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, so the safety profile is covered. The description adds genuinely non-structured behavioral context: which ETA field to quote, that public_tracking_url is null when public pages are off / shipment archived / not yet live, and that URLs must never be invented.

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?

Front-loads the payload summary, then routes to alternatives, then handles the two URL fields. Dense and purposeful, though the URL/ETA caveats make it longer than strictly minimal; every sentence still does work.

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 carries the return-value burden — and it does so by listing the returned categories plus the ETA-field and nullability semantics. An agent can call this and interpret the response without further documentation.

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, fully documented in the schema (100% coverage, including the shp_123 format and its source search_shipments). The description adds no further parameter-level detail, so the baseline 3 for schema-carried params applies.

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

Purpose5/5

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

Opens with a specific verb and resource ('Everything about one shipment') and then enumerates the exact payload surface (status, route, ETA, carrier, parties, cargo, containers, labels, check counts, notes, free_time). It is immediately distinguishable from siblings like get_tracking_timeline and list_documents.

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

Usage Guidelines5/5

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

Gives explicit trigger phrases ('when does it arrive', 'how many free days are left') and names alternatives with their selecting conditions: get_tracking_timeline for current position/route, list_documents for paperwork. Nothing is left to inference.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources