Skip to main content
Glama

List customers

loyverse_list_customers
Read-only

Retrieve loyalty customer records including visit counts, total spend, and points balance. Filter by email, IDs, or creation/update dates to locate specific customers.

Instructions

List loyalty customers with visit counts, total spend and points balance. Filter by email to find one person.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
emailNoExact email match.
limitNo
customer_idsNo
created_at_maxNoISO 8601 timestamp, inclusive upper bound.
created_at_minNoISO 8601 timestamp, inclusive lower bound.
updated_at_maxNoISO 8601 timestamp, inclusive upper bound.
updated_at_minNoISO 8601 timestamp, inclusive lower bound.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, covering the safety profile. The description adds the returned summary fields, but says nothing about pagination, result completeness, or how the openWorldHint applies to this list operation.

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?

Two crisp sentences with no filler. The main purpose is front-loaded, and the email filter use case is stated immediately after, making the description easy to scan and act on.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a list tool with 7 optional parameters, no output schema, and an openWorldHint annotation, the description is functional but thin. It covers the core purpose and output fields, but omits guidance on pagination, parameter combinations, and the relationship to loyverse_get_customer.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The only parameter meaning added beyond the schema is that email can be used to find a single person. The schema already documents email and the timestamp bounds, but `limit` and `customer_ids` remain undocumented in both the schema and description, and filter combination behavior is not explained.

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?

The description uses a specific verb ('List') and resource ('loyalty customers') and adds helpful output detail (visit counts, total spend, points balance). It is distinct enough from siblings like loyverse_get_customer, though it does not explicitly contrast itself with that tool.

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 phrase 'Filter by email to find one person' gives a concrete use case for the tool. However, it does not mention alternatives such as loyverse_get_customer, nor does it explain when not to use this tool versus a get/list sibling.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.