Skip to main content
Glama

List products

list_products
Read-only

List the workspace's synced Shopify products, by title, vendor or SKU with q, each with its id, title, vendor, status, price range, availability, variant count and storefront link. Read one in full with get_product.

Input Schema

NameRequiredDescriptionDefault
qNoWords to match in the title, vendor or a variant SKU.
pageNoPage number, 1 to 500; `metadata.hasMore` says whether another page follows.
statusNoOnly products with this status in the store.
perPageNoProducts per page (at most 200).
sourceIdNoOnly products of this `products` knowledge source.
integrationIdNoOnly products of this store connection.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / integrationId
      Added value: +{
      +  "description": "Only products of this store connection.",
      +  "maxLength": 64,
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / sourceId
      Added value: +{
      +  "description": "Only products of this `products` knowledge source.",
      +  "maxLength": 64,
      +  "minLength": 1,
      +  "type": "string"
      +}
  2. Changed1 schema field changed
    • addedInput schema / properties / status / type
      Added value: +"string"
  3. First observed

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered by structured data. The description adds the useful constraint that results are scoped to the workspace's synced Shopify products, but says nothing about pagination or result ordering beyond what the schema's `page`/`metadata.hasMore` already states.

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

Conciseness5/5

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

One front-loaded sentence carrying scope, search targets and return fields, followed by a one-clause routing pointer. No filler and nothing buried.

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?

With no output schema, enumerating returned fields (id, title, vendor, status, price range, availability, variant count, storefront link) is exactly the right compensation. Pagination mechanics are left entirely to the schema, which handles them, so nothing essential is missing.

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 (q, page, status, perPage, sourceId, integrationId) is already documented in the schema. The description only restates the q match targets, adding no new semantics; baseline 3 applies.

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 the workspace's synced Shopify products'), the match fields q searches, and the exact fields returned. It explicitly contrasts with the sibling get_product, so an agent can pick between list and single-read without opening a schema.

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?

'Read one in full with get_product' names the alternative and the condition (need full detail) that selects it. No exclusion guidance on the filter parameters (status, sourceId, integrationId), but the list-vs-get branch is unambiguous.

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.