Skip to main content
Glama
@cmssy/mcp-server

@cmssy/mcp-server

Official

List products

list_products
Read-only

List a product model's catalog with stock and variant details, paginated and filterable by status, price, search, and stock state. Fetches storefront URLs for each record.

Instructions

List a product model's catalog with stock and variant info (onHand/reserved/available per record and variant). A product is a record of a model whose product capability is enabled (get_model shows product.enabled and the field roles): create one with create_record on that model and change it with update_record; set_product_tiers and the bulk_* product tools work on the same records. Paginated: while hasMore is true, pass nextCursor back as cursor while it is set; if hasMore is true but nextCursor is null, page with the offset instead, and past offset 10000 narrow the filter. Each record carries url: its live storefront link, built by the server from the model's urlPattern and the site's public site URL. Use it whenever you link to a record and never build a storefront URL yourself (not from a slug, not from the site address). When url is null or missing, say why instead of guessing: the model has no urlPattern (set it with update_model), the model is not delivered (deliveryAccess none, or it is the login model), the site has no public site URL, or the record - or one it links to - is unpublished.

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": {
      "modelId": "<modelId>"
    },
    "name": "list_products"
  }
}

Input Schema

NameRequiredDescriptionDefault
sortNo'<fieldKey>_asc' or '<fieldKey>_desc', e.g. createdAt_desc, price_asc. Built-in keys: createdAt, updatedAt, status; any other key must be a field of the model. Omitted: the model's default sort, else newest first.
limitNo
cursorNonextCursor from the previous page. The page continues after it in the same filter and sort; leave the skip/offset at 0 when you pass it
filterNo
offsetNoHow many rows to skip, at most 10000; page past that with cursor
modelIdYesThe product model's id or slug (from list_models)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.146.2
    • addedInput schema / properties / cursor
      Added value: +{
      +  "description": "nextCursor from the previous page. The page continues after it in the same filter and sort; leave the skip/offset at 0 when you pass it",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / offset / description
      Added value: +"How many rows to skip, at most 10000; page past that with cursor"
    • changedInput schema / properties / offset / maximum
      Previous value: -9007199254740991New value: +10000
    • changedInput schema / properties / offset / minimum
      Previous value: --9007199254740991New value: +0
  2. Changed9 schema fields changedv0.73.2
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / filter / properties / priceMax / description
      Added value: +"Major units - filters the stored price field directly"
    • addedInput schema / properties / filter / properties / priceMin / description
      Added value: +"Major units - filters the stored price field directly"
    • removedInput schema / properties / limit / default
      Removed value: -50
    • changedInput schema / properties / modelId / description
      Previous value: -"Product model id"New value: +"The product model's id or slug (from list_models)"
    • removedInput schema / properties / offset / default
      Removed value: -0
    • changedInput schema / properties / sort / description
      Previous value: -"Sort expression, e.g. 'createdAt' or '-updatedAt'"New value: +"'<fieldKey>_asc' or '<fieldKey>_desc', e.g. createdAt_desc, price_asc. Built-in keys: createdAt, updatedAt, status; any other key must be a field of the model. Omitted: the model's default sort, else newest first."
    • addedInput schema / properties / sort / pattern
      Added value: +"^(.+)_(asc|desc)$"
    • addedInput schema / required
      Added value: +[
      +  "modelId"
      +]
  3. First observedv0.73.1

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, and the description still adds substantial behavior: the hasMore/nextCursor pagination contract including the null-nextCursor fallback, the 10000 offset ceiling, and the semantics of the url field with the exact reasons it can be null. The directive never to construct storefront URLs and to explain a null url rather than guess is high-value behavioral guidance not present anywhere in the structured fields.

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?

Purpose is front-loaded and every sentence carries operational content, with no filler. The url paragraph is dense and lengthy, but since there is no output schema it earns its place by documenting a returned field and its null causes.

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?

With no output schema, the description carries the return-value burden itself by describing per-record stock fields and the url field, plus the pagination envelope (hasMore/nextCursor). For a paginated read-only list tool with a nested filter, an agent has everything needed to call it correctly and interpret the response.

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 67%, and the description compensates where it matters: it explains the interaction between cursor and offset ('leave the skip/offset at 0'), the hasMore/nextCursor-null fallback, and the filter-narrowing requirement past offset 10000. It adds little for sort, limit, or the filter sub-fields, which the schema already carries or leaves undocumented.

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 opening sentence names a specific verb (List), a specific resource (a product model's catalog), and states what each record contains (stock and variant info, onHand/reserved/available). It also defines what a product is ('a record of a model whose product capability is enabled'), which distinguishes it from the generic list_records sibling.

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?

It routes the agent to create_record/update_record for mutation and to get_model to verify product.enabled, and names set_product_tiers and bulk_* as operating on the same records. It also gives explicit fallback instructions for pagination (cursor vs offset past 10000). What's missing is a direct statement of when to prefer this over list_records for a product-enabled model.

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