Skip to main content
Glama
Sign In
starshipit-mcp

starshipit-mcp

by devkindhq
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

List / Search Products

starshipit_list_products
Read-onlyIdempotent

List or search products in the StarShipIt product catalogue.

Instructions

List or search products in the StarShipIt product catalogue.

Products are pre-configured items used to auto-populate order line items when creating orders. Each product can carry customs details (HS code, country of origin, customs description) and physical dimensions for accurate rate calculations.

Query parameters:

  • search_term: Free-text search across SKU, title, barcode, and description. Pass an empty string "" to list all products without filtering.

  • page_number: Page number for pagination (default: 1)

  • page_size: Number of results per page (min: 10, max: 2000, default: 50)

  • skip_records: Number of records to skip (offset). Useful for offset-based pagination alongside page_size. Default: 0.

  • sort_column: Column to sort by. One of: Sku | Barcode | BinLocation | Brand | Colour | Country | CustomsDescription | DangerousGoods | Description | HsCode | Mid | Price | Size | Title | Weight (default: Sku)

  • sort_direction: Ascending or Descending (default: Ascending)

Note: This API uses page_number/page_size/skip_records rather than the standard page/limit pagination used by other StarShipIt endpoints.

Returns per product:

  • SKU, title, id, brand, barcode, bin_location, country, weight, dimensions (length/width/height in metres), hs_code, mid, price, dangerous_goods flag, colour, size, material, model, usage, customs_description, description

Example return fields:

{
  "id": 12345,
  "sku": "WIDGET-001",
  "title": "Blue Widget",
  "weight": 0.5,
  "hs_code": "8543.70",
  "country": "CN",
  "price": 9.99
}

Error cases:

  • 401/403: Invalid or missing API credentials

  • 400: Invalid query parameters (e.g. page_size out of range)

Use this tool when:

  • Looking up a product by SKU or name before creating an order

  • Auditing the product catalogue for missing customs info

  • Checking dimensions/weights for rate calculation accuracy

Input Schema

NameRequiredDescriptionDefault
page_sizeNoNumber of results per page (min: 10, max: 2000, default: 50)
page_numberNoPage number for pagination (default: 1)
search_termNoFree-text search across SKU, title, barcode, and description. Pass an empty string to list all products.
sort_columnNoColumn to sort results by. Valid values: Sku | Barcode | BinLocation | Brand | Colour | Country | CustomsDescription | DangerousGoods | Description | HsCode | Mid | Price | Size | Title | Weight (default: Sku)Sku
skip_recordsNoNumber of records to skip (offset-based pagination). Default: 0.
sort_directionNoSort direction: Ascending or Descending (default: Ascending)Ascending
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.9/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, open-world behavior, so the safety profile is settled. The description adds real value beyond that with error cases (401/403 credentials, 400 out-of-range page_size) and the empty-string-lists-all convention. It does not discuss result caps, rate limits, or what happens with very large page_size values, so it stays mid-range.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded and well-sectioned, but bloated: the parameter block duplicates schema descriptions, and the return value is presented twice (a long field list plus a JSON example) even though an output schema exists. Both of those sections could be removed without losing information the agent doesn't already have.

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 7-parameter read-only list tool, nothing essential is missing: identity of the resource, search semantics, the empty-string convention, pagination mechanics and the non-standard pagination warning, error conditions, and use cases are all present. Annotations carry the safety profile and the output schema carries the return shape, so the redundancy in the returns section is harmless rather than a gap.

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 baseline is 3. The parameter block largely restates the schema text verbatim (search_term, page_number, page_size, sort_column, sort_direction, skip_records). The one genuinely additive item is the note that this endpoint uses page_number/page_size/skip_records instead of the page/limit convention elsewhere, and that skip_records can be combined with page_size for offset paging — but response_format is never mentioned in the description at all.

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?

The first sentence states a specific verb and resource ('List or search products in the StarShipIt product catalogue') and the follow-up explains what a product is (pre-configured line-item template with customs data and dimensions). This clearly separates it from the mutate-oriented siblings add_product, update_product, and delete_products.

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?

The 'Use this tool when' block gives three concrete scenarios (SKU lookup before order creation, customs auditing, dimension/weight checks), which is stronger than most list tools. What's missing is any explicit exclusion or named alternative (e.g. 'to create or modify products use add_product/update_product'), so it stops 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.

Deploy Server

Other Tools