Skip to main content
Glama

Lightspeed Retail (X-Series) MCP by usefulapi

Set product stock and reorder levels

lightspeedxseries_set_product_stock
DestructiveIdempotent

WRITE: set the stock on hand (current_amount) and/or the reorder point and reorder amount of ONE product at ONE outlet. current_amount is the NEW TOTAL on hand, not a change: it overwrites the count, so sales made since you last read it are lost from the count. Read get_inventory_levels first and confirm the number with the user. Other outlets and all other product fields stay as they are. PATCH /products/{product_id} (outlet_inventories).

Input Schema

NameRequiredDescriptionDefault
outlet_idYesOutlet id (from list_outlets).
product_idYesProduct id (from list_products).
reorder_pointNoRe-order when stock falls to this level.
current_amountNoNew stock on hand at this outlet (the total, not a delta).
reorder_amountNoHow many to re-order.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already flag destructiveHint=true and idempotentHint=true, but the description goes further by explaining the overwrite semantics: current_amount is the NEW TOTAL, not a delta, so sales made since the last read are lost. It also bounds the blast radius ('other outlets and all other product fields stay as they are') and cites the underlying PATCH endpoint.

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?

Front-loaded with 'WRITE:' as a mode marker, then scope, then the critical overwrite warning, then the unaffected-surface note, then the endpoint. Four dense sentences with no filler or repetition.

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?

A single-object destructive mutation with no output schema is fully covered: what is written, what is overwritten, what is preserved, the read-before-write workflow, and user confirmation. No behavioral gap remains that would cause a mis-invocation.

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?

With 100% schema coverage the baseline is 3, and the description adds partial-update semantics ('and/or') plus the loss-consequence framing of current_amount that reinforces the schema's 'total, not a delta' note. It does not add unit or format guidance for the reorder fields beyond what the schema already supplies, so it sits just above baseline.

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?

States a specific verb and resource ('set the stock on hand ... and/or the reorder point and reorder amount') with explicit scope ('ONE product at ONE outlet'). The field names in parentheses and the mention of get_inventory_levels make it immediately distinguishable from the read-only inventory siblings.

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

Usage Guidelines5/5

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

Explicitly instructs to call get_inventory_levels first and to confirm the number with the user before writing, which is the key when-to-use precondition for a destructive overwrite. It also implicitly routes read-only intent to get_inventory_levels, leaving nothing to infer.

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.