Skip to main content
Glama

Lightspeed Retail (X-Series) MCP by usefulapi

List users

lightspeedxseries_list_users
Read-only

List the store's users (staff): id, username, display name, email, account type (cashier, manager, admin), enabled flag, restricted outlets. Paginate with next_after. GET /users.

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).
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

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds useful behavioral context beyond that: it's a GET /users read, it's paginated, and it enumerates exactly which fields come back. No auth or rate-limit detail, but that's a minor gap.

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?

One tight sentence plus a short endpoint tag, with the resource and returned fields front-loaded and nothing wasted. Every clause carries information.

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?

There is no output schema, so listing the returned fields is valuable and largely satisfies the return-value need. Pagination is signposted. It could be slightly richer about page termination or ordering, but for a simple read-only list it is close to complete.

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 the schema already documents after, before, and page_size in depth. The description only echoes pagination, and its mention of 'next_after' (a response field) rather than the 'after' parameter name could slightly confuse an agent. Baseline 3 applies.

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 (List) and resource (the store's users/staff), then enumerates the returned fields and the endpoint. It is clearly distinguishable from siblings like get_user_sale_totals or list_customers.

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 description implies usage by noting pagination with next_after, but it never states when to use this list vs. a sibling like get_user_sale_totals, nor any exclusions or prerequisites. Usage is implied rather than explained.

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.