Skip to main content
Glama

Lightspeed Retail (X-Series) MCP by usefulapi

Search products

lightspeedxseries_search_products
Read-only

Filter products by SKU, brand, supplier, tag, product type or variant parent. Uses offset paging: pass next_offset to continue (null = last page). GET /search?type=products.

Input Schema

NameRequiredDescriptionDefault
skuNoSKU filter (sent in lowercase, as the vendor search requires).
offsetNoOffset for the next page: pass next_offset from the previous call (default 0).
tag_idNoTag id.
deletedNotrue = include deleted records (default: active only).
brand_idNoBrand id.
page_sizeNoRecords per page (max 1000).
supplier_idNoSupplier id.
product_type_idNoProduct type id.
variant_parent_idNoOnly the variants of this parent product.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

With readOnlyHint already declared, the description usefully adds the paging contract: offset paging, pass next_offset to continue, and null means last page. That is real behavioral context beyond the annotations. It omits that filters combine as AND and that results default to active records only, so a 4 rather than a 5.

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?

Three tightly packed sentences: filters, paging contract, endpoint. Front-loaded with the capability and no filler. The endpoint reference is arguably redundant but is a single short clause.

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?

For a nine-parameter, no-output-schema read tool, the description covers the two things an agent cannot infer: the filter surface and the pagination loop (next_offset / null terminator). What is still missing is return-shape description and page_size interaction with offset, but the schema and annotation carry much of the load.

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 one of the nine parameters already carries its own description (including the lowercase-SKU note and next_offset paging hint). The description restates the filter facets but adds no new syntax, format, or constraint detail, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource ('Filter products by SKU, brand, supplier, tag, product type or variant parent') and enumerates the filter dimensions, which is more informative than the bare title. It stops short of distinguishing itself from the sibling `lightspeedxseries_list_products`, which is exactly the tool an agent would confuse it with.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is only implied: the word 'Filter' plus the list of facets suggests this is the tool for narrowed product lookups. No explicit 'use this when / use list_products instead' routing, no note that no filters returns everything, no guidance on filter combination semantics.

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.