Skip to main content
Glama

Lightspeed Retail (R-Series) MCP by usefulapi

List items

lightspeedrseries_list_items
Read-only

Search the product catalog. Each item has itemID, description, SKUs (systemSku, customSku, upc, ean, manufacturerSku), defaultCost, categoryID and its Prices (price levels). Set include_stock to add per-shop quantities (ItemShops; shopID 0 = all shops). Paginate with next_url. GET /Account/{accountID}/Item.json.

Input Schema

NameRequiredDescriptionDefault
eanNoExact EAN.
upcNoExact UPC.
sortNoSort field; prefix "-" for descending. Allowed: itemID, timeStamp, description.
limitNoRecords per page (1-100, default 100).
min_qohNoOnly items with at least one shop record whose quantity on hand is >= this (loads ItemShops).
archivedNofalse (default) = active records only, true = active and archived, only = archived only.
next_urlNoTo get the next page: the next_url value from a previous call of this same tool, unchanged. Other filters are ignored when it is set.
item_codeNoExact match on itemID, UPC or EAN.
vendor_idNoOnly items whose default vendor is this vendorID.
custom_skuNoExact custom SKU.
system_skuNoExact Lightspeed system SKU (the barcode on labels).
category_idNoOnly items in this category (categoryID).
descriptionNoDescription contains this text (like search).
include_stockNoInclude per-shop stock (ItemShops relation).
modified_sinceNoOnly items modified at or after this time (item timeStamp, UTC unless an offset is given).
include_categoryNoInclude the Category record.
manufacturer_skuNoExact manufacturer SKU.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.8/5.0
Behavior4/5

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

With readOnlyHint=true already covering the safety profile, the description adds useful behavioral context: it lists returned item fields, notes that include_stock adds ItemShops quantities and that shopID 0 means all shops, and explains pagination via next_url. It does not cover auth, rate limits, or error behavior, but it goes meaningfully beyond the annotations.

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?

The description is five short sentences, front-loads the core purpose, and each sentence adds useful information about response fields, stock inclusion, pagination, or the endpoint. It is efficient with no obvious filler.

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 17-parameter read-only list/search tool with no output schema, the description gives endpoint context, partial return structure, stock inclusion behavior, and pagination. It does not exhaustively document return values or the accountID path requirement, but the high schema coverage and annotations make it largely sufficient for invocation.

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 all 17 parameters are already documented in the schema. The description mentions include_stock and next_url, but those are already covered there and it does not add filter syntax or additional meaning beyond the schema; baseline 3 is appropriate.

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/resource: 'Search the product catalog' and gives the GET endpoint for items. It is clearly a plural item retrieval/search tool, but it does not explicitly distinguish itself from siblings like get_item or list_inventory.

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?

The phrase 'Search the product catalog' implies usage for catalog lookups, and it mentions include_stock and next_url as optional patterns. However, it gives no explicit when-to-use guidance, exclusions, or alternatives such as using get_item for a single item.

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.