How to Connect Lightspeed Retail (X-Series) to Gemini via MCP

💡 No install? Use cloud.anythingmcp.com directly. Sign in, click Connectors → Lightspeed Retail (X-Series), paste your credentials, mint an MCP API key and you're done. No Docker, no git clone, no local server.

Lightspeed Retail (X-Series) + Gemini

Lightspeed Retail X-Series (formerly Vend) for one store: outlets, registers and till totals, sales search by date, products and product families, categories, brands, suppliers, price books and promotions, stock levels, adjustments, consignments and purchase orders, customers, store credit and gift cards. Returns and deletes install switched off.

Prerequisites

See the full setup instructions baked into the connector (visible in the in-app store when you select the connector). The required environment variables for this connector are:

LIGHTSPEED_DOMAIN_PREFIX, LIGHTSPEED_PERSONAL_TOKEN

Step 1 — Get credentials

X-Series only: this connector uses the Lightspeed Retail (X-Series) API, formerly Vend, date version 2026-10, of one store at https://<domain_prefix>.retail.lightspeed.app/api/2026-10. It does not cover Lightspeed Retail R-Series or Lightspeed Restaurant, which have other APIs.

Setting up takes about 2 minutes. Personal tokens need the Plus plan or above and an admin user.

1. As an admin open the Retail POS back office, Setup, Personal tokens, and click Add personal token. Give it a name (and, if you like, an expiry date), generate it and copy the token.
2. Paste it into LIGHTSPEED_PERSONAL_TOKEN. It is sent as Authorization: Bearer <token> and acts as the user who created it.
3. Set LIGHTSPEED_DOMAIN_PREFIX to the first part of your store address: for https://mystore.retail.lightspeed.app it is mystore.
4. Install the connector and run lightspeed_retail_get_retailer: it shows the store's name, currency and time zone and confirms the token.

Store setup: lightspeed_retail_get_retailer, lightspeed_retail_get_current_user, outlets with lightspeed_retail_list_outlets and lightspeed_retail_get_outlet, registers with lightspeed_retail_list_registers and lightspeed_retail_get_register, lightspeed_retail_get_register_payments_summary (expected amounts per payment type and cash movements of the open shift, as used to close the till), payment types, taxes, users (staff) and shifts.

Sales: for a period, an outlet, a register, a customer or an invoice number the AI uses lightspeed_retail_search with type: sales and date_from/date_to; the plain list ignores dates. lightspeed_retail_list_sales walks all sales by version (for syncing) and lightspeed_retail_get_sale reads one sale with its lines, payments, customer, user and register.

Catalog: lightspeed_retail_list_products (or sku for one product), lightspeed_retail_get_product, lightspeed_retail_get_product_family and lightspeed_retail_get_product_family_of_product. Since version 2026-10 a product family holds the shared data (name, brand, category, tags) and each product the per-variant data (codes, prices, suppliers). Reference data: categories, legacy product types, brands, tags, suppliers, price books and promotions.

Stock: lightspeed_retail_list_inventory_levels gives counts, average cost, reorder point and amount per product and outlet, with filters, sorting and to_be_procured_only for reorder lists; lightspeed_retail_get_product_inventory_levels shows one product in every outlet; lightspeed_retail_list_inventory_records and lightspeed_retail_list_stock_adjustments list the raw records and adjustments. Supplier orders, outlet transfers, supplier returns and stocktakes are consignments: lightspeed_retail_list_consignments, lightspeed_retail_get_consignment and lightspeed_retail_list_consignment_products (ordered and received counts). Purchase orders are read with lightspeed_retail_list_purchase_orders and lightspeed_retail_get_purchase_order.

Customers: the AI finds a customer with lightspeed_retail_search (type: customers, by email, name, code or phone), then reads lightspeed_retail_get_customer (loyalty, store credit and on-account balance, year to date spend). Also lightspeed_retail_list_customers, lightspeed_retail_list_customer_groups, lightspeed_retail_get_customer_store_credit and gift cards with lightspeed_retail_list_gift_cards and lightspeed_retail_get_gift_card.

What it writes: lightspeed_retail_create_sale records a sale (state closed completes it, parked or pending saves it for later); lightspeed_retail_update_sale changes or completes a parked or pending sale and replaces the whole sale, so the AI reads it first. Products: lightspeed_retail_create_product_family, lightspeed_retail_add_products_to_family (new variants), lightspeed_retail_update_product_family for shared data and lightspeed_retail_update_product for prices, codes, suppliers, outlet taxes and inventory settings. Also lightspeed_retail_create_supplier, lightspeed_retail_create_stock_adjustments (quantity is the change, negative to remove, with a reason such as damage, theft or stock found), lightspeed_retail_create_consignment (created in OPEN status; products are added in Lightspeed or later), lightspeed_retail_create_customer and lightspeed_retail_update_customer (first_name and last_name are required). Sales and stock adjustments change stock and the reports at once, so the AI shows you the lines and totals and waits for your yes.

Switched off at install: lightspeed_retail_return_sale, lightspeed_retail_delete_product and lightspeed_retail_delete_customer. They cannot be undone, so a workspace admin switches them on when the team needs them.

Data formats: answers wrap records in data. Ids are UUIDs. Money is a decimal number in the store currency. A sale has totals (price excluding tax, tax, price_incl_tax); on each line pricing.price is the unit price excluding tax, pricing.total the line total after discount, pricing.cost_total the cost, and tax.amount and tax.total the unit and line tax. Tax rates are fractions (0.2 = 20%). Times are UTC (ISO 8601): date_from/date_to take UTC, time_from/time_to take local time together with timezone. A sale state is closed, parked, pending (on account or layby) or voided.

Paging: most lists page by version: the answer has version with min and max, the AI passes max as after for the next page and stops when data is empty. lightspeed_retail_search and lightspeed_retail_list_inventory_levels page with offset; gift cards with before.

Limits and common errors: about 300 requests per 5 minutes per register plus 50; above that Lightspeed answers 429 with Retry-After. 401 means a wrong or expired token or a wrong domain prefix. 403 means the token's user may not do this, since personal tokens act as their user: create the token with an admin. 404 on every call means LIGHTSPEED_DOMAIN_PREFIX is wrong (only the part before .retail.lightspeed.app); on a single record it means a wrong id. 422 is a validation error with the field named.

With the tools on at install, the connector does not process returns and deletes nothing. It reads purchase orders, price books, promotions, store credit and gift cards but does not change them; a new supplier order is created as a consignment.

Step 2 — Install the adapter

curl -fsSL https://raw.githubusercontent.com/HelpCode-ai/anythingmcp/main/docker-compose.quickstart.yml -o docker-compose.yml
printf 'JWT_SECRET=%s\nENCRYPTION_KEY=%s\n' "$(openssl rand -hex 32)" "$(openssl rand -hex 32)" > .env
docker compose up -d

Step 3 — Add the connector in Gemini

Your server URL: in AnythingMCP, open MCP Servers → the server this connector is on, and copy its URL (https://cloud.anythingmcp.com/mcp/…). Use it wherever this guide shows YOUR_SERVER_ID.

Gemini CLI reads MCP servers from ~/.gemini/settings.json (on Windows %USERPROFILE%\.gemini\settings.json). Add:

{
  "mcpServers": {
    "anythingmcp": {
      "httpUrl": "https://cloud.anythingmcp.com/mcp/YOUR_SERVER_ID",
      "headers": { "X-API-Key": "YOUR_MCP_API_KEY" }
    }
  }
}

1. Create an MCP API key in AnythingMCP under MCP Servers → your server → API keys, and paste it in place of YOUR_MCP_API_KEY.
2. Save the file and restart gemini.
3. Run /mcp inside Gemini CLI (or gemini mcp list in your shell): anythingmcp should show as connected.
4. Start prompting: Gemini CLI can now call the Lightspeed Retail (X-Series) tools.

Available tools

Example prompts

• "How much did each outlet sell yesterday, excluding and including tax?"
• "Which products at the Main Street outlet are below their reorder point? Make me a reorder list grouped by supplier."
• "Find the customer with the email [email protected] and show her loyalty balance and store credit."
• "Record a stock adjustment of minus 3 for SKU TSHIRT-BLK-M at the Main Street outlet with the reason damage. Show it to me before saving."
• "Show me the sale with invoice number 10452 with its lines, discounts and payments."

FAQ

Where does Gemini CLI look for MCP servers? In ~/.gemini/settings.json for your user, or in .gemini/settings.json inside a project. gemini mcp list shows each server and whether it connects.

Next steps

• Connector landing page
• Connect to Claude
• Connect to ChatGPT
• Connect to Cursor
• Connect to Meta Muse
• Connect to Microsoft Copilot