Skip to main content
Glama

Lightspeed Retail (X-Series) MCP by usefulapi

Get inventory levels

lightspeedxseries_get_inventory_levels
Read-only

Stock on hand per product per outlet: product_id, location_id (= outlet id), current_inventory_level, reorder threshold/amount, quantity_to_procure, average cost, total cost, supplier. Filter by outlet_ids, product_ids (or root_product_ids for variant families), supplier_ids; to_be_procured_only keeps products with a positive quantity_to_procure (the vendor's re-order suggestion, which accounts for open orders); for a plain below-reorder-point list, compare current_inventory_level with reorder_threshold yourself. Offset paging: pass next_offset to continue (null = last page). Read-only even though the vendor takes the filter as a POST body. POST /inventory_levels.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sizeNoRecords per page (default 100, max 500 here).
offsetNoOffset for the next page: pass next_offset from the previous call (default 0).
sort_typeNo
outlet_idsNoOnly these outlets (the vendor calls them location_ids).
product_idsNoOnly these products. Not together with root_product_ids.
supplier_idsNo
group_variantsNoAggregate variant families when filtering by root_product_ids.
sort_directionNo
include_inactiveNotrue = include inactive products.
root_product_idsNoOnly these variant families (use with group_variants). Not together with product_ids.
include_compositesNo
to_be_procured_onlyNotrue = only products with a positive quantity_to_procure (not the same as below the reorder point).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, but the description adds real value beyond them: it pre-empts the POST-body confusion ('Read-only even though the vendor takes the filter as a POST body') and describes paging behavior (pass next_offset, null = last page). It says nothing about permissions, rate limits, or error behavior, so not 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.

Conciseness4/5

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

Front-loads the returned fields, then filters, then paging — a sensible order with no filler. It is dense and long, but the field enumeration earns its place because there is no output schema. Slightly overpacked into one paragraph where a break before paging would aid scanning.

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 field list is necessary and present; with 12 optional params, filtering and paging semantics are the critical parts and are covered. The remaining gaps (sort_type/sort_direction meaning, include_composites, include_inactive) are minor for a read tool flagged readOnly.

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 67%, and the description compensates for the most consequential gaps: it explains the outlet_ids/location_ids naming, the product_ids vs root_product_ids exclusion, and precisely what to_be_procured_only means versus a below-reorder-point list. However, size (max 500), sort_type, sort_direction, include_inactive, and include_composites are left to the schema, and sort_type's enum values carry no description at all.

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?

Opens with a precise verb+resource ('Stock on hand per product per outlet') and enumerates the returned fields, so an agent immediately knows this is a per-outlet inventory read rather than a product or sales listing. It is clearly separable from siblings like list_products or search_products.

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?

Gives explicit conditional guidance: use to_be_procured_only for the vendor's re-order suggestion (accounting for open orders), and compare current_inventory_level with reorder_threshold yourself for a plain below-reorder-point list. Also states product_ids and root_product_ids are mutually exclusive. It does not name a sibling alternative, which keeps it a 4 rather than 5.

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.