Skip to main content
Glama

Search products

products_search
Read-onlyIdempotent

Search Shopware products by free-text terms and Criteria filters and get compact summaries with price, stock, availability, manufacturer, categories and cover image; optionally include variants.

Instructions

Search products by free-text term and/or Criteria filters (e.g. active, stock, manufacturer.name, categories.id, productNumber). Returns compact product summaries with price, stock, availability, manufacturer, category names and cover image URL. By default only main products are returned; set includeVariants=true to also get variants. Use products_get for the full record of one product. Returns { total, page, limit, items[] }.

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": "products_search"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNo1-based page
sortNoSort order; defaults per tool
termNoFull-text search term
limitNoItems per page, max 50 (default from SHOPWARE_MCP_DEFAULT_LIMIT)
fieldsNoExtra raw entity fields to add to each item, e.g. ['customFields', 'ean']. Dot-paths allowed.
filterNoCriteria filters, combined with AND
includeVariantsNoInclude variant products (children) in the results. Default: parents only.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.11.1

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. Beyond that, the description adds real behavioral context: results are compact summaries rather than full records, variants are excluded by default, and it gives the response envelope { total, page, limit, items[] }. Pagination defaults per tool are left implicit but the shape is disclosed.

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?

Four dense sentences: purpose, output content, default scope, then the sibling alternative and return shape. Nothing is repeated from the annotations and no sentence is filler.

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 seven optional parameters, no output schema, and no required fields, the description supplies exactly what is missing: search semantics, return envelope, variant scoping, and a pointer to the single-record sibling. An agent could call this correctly from the description plus schema alone.

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 100%, so the baseline is 3. The description earns above baseline by naming concrete filterable fields (active, stock, manufacturer.name, categories.id, productNumber), which shows the agent how the untyped filter.field parameter is actually used, and by restating the includeVariants default as a scoping rule rather than just a boolean.

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 description opens with a specific verb and resource ("Search products") and immediately scopes it to free-text and/or Criteria filters. It names the sibling it is not (products_get) and states the default variant behavior, so an agent can distinguish it from the other 35+ tools 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?

It explicitly routes the agent to products_get for the full record of a single product and states the default scope (main products only unless includeVariants=true). It does not spell out when to prefer term search versus filter search, or how it relates to generic siblings like entity_search, but the selection context is otherwise clear.

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