Skip to main content
Glama

List Products

sirv_list_products
Read-onlyIdempotent

Search and list Studio catalogue products by name, SKU, status, source, or ranked query to find product IDs; optionally include linked assets and counts.

Instructions

List or search the products in the Studio catalogue (PIM). Three modes:

  • Default: list products, filtered by search (name or SKU), status and externalSource, and sorted by sortBy.

  • With q: ranked search over product names, SKUs and other product text, best match first. Only limit and offset apply.

  • With includeAssets: list products with their linked assets and asset counts, filtered by search and hideEmpty. sortBy can be assetCount.

Use it to find a product id. For one product's full details, use sirv_get_product.

Read-only. Returns product ids, names, SKUs and status, and the total with the offset for the next page.

Credits: free.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "sirv_list_products"
  }
}

Input Schema

NameRequiredDescriptionDefault
qNoWords to search for. Switches to ranked search over names, SKUs and other product text. Only limit and offset work with it
limitNoProducts per page, 1 to 100. Default: 20
orgIdNoWorkspace id from sirv_list_organizations. Default: the workspace you signed in to
offsetNoNumber of products to skip, for the next page. Default: 0
searchNoShow products whose name or SKU contains this text. Not with q
sortByNoSort field. Default: createdAt, or name with includeAssets. sku and updatedAt work only without includeAssets; assetCount only with it
statusNoDefault mode only: show products with this status
hideEmptyNoWith includeAssets only: true hides products with no linked assets. Default: true
sortOrderNoSort direction. Default: desc, or asc with includeAssets
includeAssetsNotrue: list products with their linked assets and asset counts. Default: false
externalSourceNoDefault mode only: show products from this source

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed16 schema fields changedv0.1.1
    • changedInput schema / properties / externalSource / description
      Previous value: -"Filter by source"New value: +"Default mode only: show products from this source"
    • addedInput schema / properties / hideEmpty
      Added value: +{
      +  "description": "With includeAssets only: true hides products with no linked assets. Default: true",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / includeAssets
      Added value: +{
      +  "description": "true: list products with their linked assets and asset counts. Default: false",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / limit / description
      Previous value: -"Number of results"New value: +"Products per page, 1 to 100. Default: 20"
    • changedInput schema / properties / offset / description
      Previous value: -"Pagination offset"New value: +"Number of products to skip, for the next page. Default: 0"
    • addedInput schema / properties / offset / maximum
      Added value: +9007199254740991
    • changedInput schema / properties / orgId / description
      Previous value: -"Organization ID (uses default org if omitted)"New value: +"Workspace id from sirv_list_organizations. Default: the workspace you signed in to"
    • addedInput schema / properties / orgId / pattern
      Added value: +"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    • addedInput schema / properties / q
      Added value: +{
      +  "description": "Words to search for. Switches to ranked search over names, SKUs and other product text. Only limit and offset work with it",
      +  "maxLength": 100,
      +  "minLength": 1,
      +  "type": "string"
      +}
    • changedInput schema / properties / search / description
      Previous value: -"Search by name or SKU"New value: +"Show products whose name or SKU contains this text. Not with q"
    • removedInput schema / properties / sortBy / default
      Removed value: -"createdAt"
    • changedInput schema / properties / sortBy / description
      Previous value: -"Sort field"New value: +"Sort field. Default: createdAt, or name with includeAssets. sku and updatedAt work only without includeAssets; assetCount only with it"
    • changedInput schema / properties / sortBy / enum
      Previous value: -[
      -  "createdAt",
      -  "name",
      -  "sku",
      -  "updatedAt"
      -]New value: +[
      +  "createdAt",
      +  "updatedAt",
      +  "name",
      +  "sku",
      +  "assetCount"
      +]
    • removedInput schema / properties / sortOrder / default
      Removed value: -"desc"
    • changedInput schema / properties / sortOrder / description
      Previous value: -"Sort direction"New value: +"Sort direction. Default: desc, or asc with includeAssets"
    • changedInput schema / properties / status / description
      Previous value: -"Filter by status"New value: +"Default mode only: show products with this status"
  2. First observedv0.1.0

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is covered; the description's 'Read-only' line is largely redundant. It does add value the annotations cannot: the return payload shape ('product ids, names, SKUs and status'), pagination contract ('the total with the offset for the next page'), and the credit cost ('Credits: free'). Missing only rate-limit or result-cap 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 the core action, then a tight three-bullet mode breakdown, then routing, then return/credit notes — a sensible information hierarchy with no filler. Minor waste: the mode bullets restate sort/status restrictions that the schema already encodes, and 'Read-only' duplicates the annotation.

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 an 11-parameter, zero-required, no-output-schema list tool this covers everything an agent needs: what each mode does, which parameters are mutually exclusive, how to page, and what fields come back. The absence of an output schema is compensated by the description naming the returned fields and the pagination total.

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 description coverage is 100%, so the per-parameter baseline is 3. The description earns above baseline by grouping the 11 parameters into three coherent modes, which conveys the interactive semantics an agent cannot easily infer from eleven independently documented properties — e.g. that `q` collapses the surface to just `limit`/`offset`, and that `sortBy` values are mode-gated.

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 ('List or search the products in the Studio catalogue (PIM)') and immediately enumerates three distinct operating modes, each tied to the parameter that selects it. It also names the sibling it is not ('For one product's full details, use sirv_get_product'), so an agent can route without opening either schema.

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?

Gives an explicit use case ('Use it to find a product id'), an explicit alternative with the condition that selects it ('for one product's full details, use sirv_get_product'), and per-mode applicability rules ('Only `limit` and `offset` apply', 'Default mode only'). The exclusions ('Not with q') mean the agent knows which parameter combinations will silently do nothing.

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