Skip to main content
Glama

Lightspeed Retail (X-Series) MCP by usefulapi

List brands

lightspeedxseries_list_brands
Read-only

List product brands (id, name). Paginate with next_after. GET /brands.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
afterNoCursor: only records with a version number greater than this. Omit for the first page; then pass next_after from the previous call. Stop when data is empty.
beforeNoOnly records with a version number up to this (rarely needed).
deletedNotrue = include deleted records (default: active only).
page_sizeNoRecords per page (the vendor default applies when omitted; 50-100 keeps replies short).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

readOnlyHint=true already declares the safety profile, so the bar is lower. The description does add that results are id/name pairs retrieved via GET /brands and that pagination uses next_after, but it says nothing about ordering, rate limits, or whether deleted brands appear (that is only in the schema).

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 terse fragments, front-loaded with the resource and return shape before pagination and endpoint details. Nothing extraneous 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, the description usefully names the returned fields (id, name) and the pagination cursor, but omits result ordering and total-count behavior that an agent consuming the list might want. Adequate for a simple read-only reference list.

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%, and each parameter already documents cursoring, deleted-record inclusion, and page size with vendor context. The description's 'Paginate with next_after' merely echoes a note already present in the 'after' parameter description, adding no new semantics.

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?

States a specific verb and resource ('List product brands') plus the returned fields (id, name) and the underlying endpoint (GET /brands). A 'brands' resource is clearly distinct from siblings like list_products or list_tags, though the description never explicitly contrasts with them.

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 only procedural guidance is 'Paginate with next_after', which covers the mechanics of iteration but not when to choose this tool over list_products or search_products. Usage is largely implied by the tool name for a simple reference-list endpoint.

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.