Skip to main content
Glama

Cratejoy MCP by usefulapi

List shipments

cratejoy_list_shipments
Read-only

List shipments (id, customer_id, status, created_at, target_at, shipped_at, tracking_number, is_gift). Filter by status and creation range, or with filters. Relationships: customer, fulfillments, labels, ship_address, subscriptions. GET /v1/shipments/.

Input Schema

NameRequiredDescriptionDefault
pageNoPage number, counting from 0 (default 0). Pass the previous reply's next_page.
withNoRelationships to embed: comma-separated names (e.g. 'customer,orders'), 'all', or an empty string for none. Omit it for the vendor default.
limitNoResults per page, 1-100 (default 25).
statusNoShipment status.
filtersNoExtra Cratejoy filters as { '[relation.]property[__comparison]': value }. Comparisons: eq (default), ne, lt, le, gt, ge, like, ilike (% is the wildcard), in, nin (comma-separated), is_null. Status columns take integers. Example: { 'customer.email__like': '%@example.com' }.
created_afterNoOnly shipments created on or after this date/date-time.
created_beforeNoOnly shipments created on or before this date/date-time.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, openWorldHint=true, and destructiveHint=false, so the safety profile is covered. The description adds value beyond that by listing the exact returned fields, the embeddable relationships, and the underlying endpoint. Pagination behavior is left entirely to the schema.

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 compact, front-loaded sentences packed with concrete detail (field list, filter mechanism, relationships, endpoint) and no filler. Dense but readable.

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?

No output schema exists, so the enumerated field list and relationship names in the description usefully fill that gap, and annotations cover the read-only safety profile. For a read-only list tool this is nearly complete, though it could note default pagination behavior.

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%, so every parameter is already documented in the schema, including status, created_after/created_before, filters, with, page, and limit. The description merely echoes filter capability, adding no syntax or format detail beyond the schema, 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?

States a specific verb+resource ('List shipments') and enumerates the returned fields, so an agent knows exactly what this retrieves. It does not explicitly contrast itself with the singular sibling cratejoy_get_shipment, but list-vs-get is self-evident.

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?

Says 'Filter by status and creation range, or with `filters`', which implies how to narrow results, but gives no when-to-use guidance or exclusions relative to siblings like cratejoy_get_shipment or cratejoy_list_orders. Usage is inferable but not stated.

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.