Skip to main content
Glama

List Manifests

starshipit_list_manifests
Read-onlyIdempotent

List all manifests in your StarShipIt account.

Instructions

List all manifests in your StarShipIt account.

Manifests group shipments that have been closed/submitted to a carrier. A manifest is created when you "manifest" a set of shipments, signalling to the carrier that they are ready for collection.

Returns: Manifest ID, name, date, carrier ID, and the number of consignments and articles in each manifest.

Example response fields:

  • id: Unique identifier for the manifest

  • name: Manifest name

  • date: ISO 8601 timestamp of the manifest

  • carrierId: Numeric carrier ID

  • numberConsignments / numberArticles: Counts in the manifest

  • total_count / total_pages: Pagination totals

Pagination: Use limit (max 250) and page to page through results.

Error cases:

  • 401/403: Invalid or missing API credentials

Use this tool when:

  • Reviewing past manifests for a carrier

  • Looking up a manifest ID before downloading its PDF

  • Auditing which shipments have been submitted to carriers

Input Schema

NameRequiredDescriptionDefault
pageNoPage number for pagination (default: 1)
limitNoMaximum number of results to return (default: 50, max: 250)
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

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is covered. The description adds real value beyond that with pagination mechanics (limit max 250, page) and documented 401/403 auth failures. The 'Returns' section largely restates what the output schema already declares, limiting the additional behavioral disclosure.

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?

The purpose statement is front-loaded and the bolded section headers (Returns, Pagination, Error cases, Use this tool when) make it easy to scan. It is somewhat longer than necessary because the return-field enumeration duplicates an existing output schema, but nothing is actively confusing.

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?

For a zero-required-parameter list tool, the description covers selection criteria, pagination, auth error behavior, and return shape, which is close to complete. The only meaningful omission is guidance on when to prefer the carrier- or tracking-scoped manifest siblings over this general lister.

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 page, limit, and response_format are already documented, making 3 the baseline. The description's pagination note repeats the limit ceiling already present in the schema and says nothing about response_format, so it adds little semantic meaning beyond the structured fields.

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 opens with a specific verb+resource ("List all manifests in your StarShipIt account") and defines what a manifest is, which is genuinely useful domain context. It stops short of explicitly differentiating itself from close siblings like starshipit_manifest_by_carrier or starshipit_manifest_by_tracking, so an agent still has to infer which lister to pick.

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

Usage Guidelines4/5

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

A dedicated 'Use this tool when' block gives three concrete scenarios (review past manifests, look up an ID before PDF download, audit submitted shipments), which gives clear positive-selection context and even implies a follow-up call to get_manifest_files. There are no explicit exclusions or named alternatives, so it stops one step short of a 5.

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