Skip to main content
Glama
GPX MCP Server
by gpxco

Show a shipment

get_shipment
Read-onlyIdempotent

Retrieve a shipment's status, devices, and stops by its ID to view detailed information about a specific shipment.

Instructions

Show a shipment

Returns one shipment with its status, devices and stops. The shipment's page in the GPX app is https://app.gpx.co/shipments/{id}.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "shipmentId": "<shipmentId>"
    },
    "name": "get_shipment"
  }
}

Input Schema

NameRequiredDescriptionDefault
shipmentIdYesThe shipment id, from `list_shipments`.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.3

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and non-open-world, so the safety profile is covered. The description adds genuine value beyond that by disclosing the return payload composition (status, devices, stops) and the corresponding GPX app page URL, which helps the agent present results; it omits error behavior for an unknown id, which is a minor remaining gap.

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?

Three short sentences, front-loaded with the purpose and then the return content, with no filler. The only redundancy is restating the title verbatim in the opening line.

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

Completeness4/5

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

With no output schema, the description carries the burden of describing returns, and it does so adequately by naming the included sub-resources. For a single-parameter read tool with full annotation coverage, that is sufficient; only missing-id behavior is left unstated.

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?

Schema description coverage is 100% and the shipmentId property description already explains the id comes from list_shipments. The tool description adds nothing about the parameter beyond what the schema states, so the 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?

The description gives a specific verb and resource ("Show a shipment") and immediately specifies what entity is returned with its status, devices and stops, which clearly separates it from the plural list_shipments sibling. It stops short of naming the alternative tool explicitly in the prose, so it is clear but not maximally differentiated.

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 only implied: the singular 'one shipment' and the required shipmentId signal a single-record lookup rather than enumeration. There is no explicit statement about when to prefer this over list_shipments or the shipment sub-resource tools (list_shipment_stops, get_shipment_route).

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