Skip to main content
Glama

Get Delivery Services

starshipit_get_delivery_services
Read-onlyIdempotent

Fetches available carrier delivery services and service codes for an existing order or a new route, enabling selection and population of shipping options during order creation or updates.

Instructions

Get available delivery services (carrier + service options) for a specific order or a general route. Returns service codes that are directly usable when creating or updating orders.

When to use: Prefer this over starshipit_get_rates when:

  • You have an existing order (order_id) and need the services available for it

  • You want to populate a dropdown or list of services that a user can select (the returned service_code values map directly to the StarShipIt order field)

  • You need a fresh rate lookup — pass refresh_rate: true to bypass any cached result

Parameters:

  • order_id (optional) — existing order ID to fetch services for; if omitted, sender/destination/packages are used

  • refresh_rate (optional, default false) — set true to force a live carrier rate lookup instead of returning cached data

  • sender, destination, packages — same shape as starshipit_get_rates; required when order_id is not provided

Returns: An array of service objects, each with:

  • carrier / carrier_name — carrier identifier and display name

  • service_name / service_code — description and the code to pass to order create/update

  • total_price — quoted price

  • pricing_breakdown — price ex GST, GST, and estimated delivery days (JSON format)

Errors:

  • 400 — missing required fields or invalid address/package data

  • 404 — order_id not found

  • 401/403 — authentication failure

Example — get services for an existing order:

{ "order_id": 100000, "refresh_rate": true }

Example — get services for a new route:

{
  "sender": { "street": "10 Geonic Street", "suburb": "Woodridge", "state": "QLD", "post_code": "4114", "country_code": "AU" },
  "destination": { "street": "10 Geoffrey Place", "suburb": "Mangere East", "city": "Auckland", "post_code": "2024", "country_code": "NZ" },
  "packages": [{ "weight": 1.2 }]
}

Input Schema

NameRequiredDescriptionDefault
senderNoOrigin/pickup address — required when order_id is not provided
order_idNoExisting StarShipIt order ID to fetch delivery services for
packagesNoPackages to ship — required when order_id is not provided; weight (kg) is required per package
destinationNoDelivery address — required when order_id is not provided
refresh_rateNoSet true to force a fresh rate lookup (bypass cache)
response_formatNoOutput format: 'markdown' for human-readable or 'json' for machine-readablemarkdown

Output Schema

NameRequiredDescriptionDefault
errorsNoValidation or processing errors returned by StarShipIt
objectNoThe response payload when StarShipIt returns a non-object value
successNoStarShipIt success flag (a boolean on most endpoints)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive), and the description adds substantive context beyond them: caching behavior and how to bypass it, plus concrete error semantics (400 for missing/invalid data, 404 for unknown order_id, 401/403 auth). The response field list also flags that pricing_breakdown is embedded JSON, which is non-obvious behavior.

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-loaded with purpose, then gated by bolded headers, and the two runnable examples are high value. Minor waste: the Parameters section largely restates what the 100%-covered schema already documents, which lengthens an otherwise tight definition.

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?

For a 6-parameter tool with nested addresses and packages and a 0-required-parameter shape, the description covers the mutually exclusive input modes, the caching flag, error outcomes, and worked examples for both modes. With an output schema present, the return-value sketch is surplus but harmless.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3; the description earns above that by stating the conditional dependency (sender/destination/packages required only when order_id is omitted) and by explaining that refresh_rate forces a live carrier lookup rather than cached data. It does not mention response_format at all, leaving that enum entirely to the schema.

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?

States a specific verb and resource ("Get available delivery services (carrier + service options)") plus the scope (for an order or a general route) and what the return values are good for ("service codes directly usable when creating or updating orders"). It explicitly names the sibling tool it supersedes, so the agent can discriminate without opening schemas.

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?

A dedicated "When to use" block gives three concrete selection conditions and names the alternative (starshipit_get_rates) it should be preferred over, plus the refresh_rate escape hatch for fresh lookups. The order_id vs sender/destination/packages switch is stated as an explicit rule rather than left to inference.

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