Skip to main content
Glama

Customers List

tiendanube_customers_list
Read-onlyIdempotent

Retrieve and filter a Tiendanube store's customer list by email, name, document, spend, marketing consent, or dates, with pagination and selectable fields.

Instructions

List customers. HTTP: GET /customers Required scope: read_customers API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Input Schema

NameRequiredDescriptionDefault
qNoSearch by name, email or document
pageNoPage number (default 1). Orders: page * per_page must be <= 10000
emailNoExact email
fieldsNoComma-separated list of fields to return, to reduce payload size (e.g. 'id,name,variants')
per_pageNoItems per page (default 30, max 200; max 50 for external invoices)
since_idNoOnly return records with an ID greater than this value (cursor pagination)
created_at_maxNoCreated at or before (ISO 8601)
created_at_minNoCreated at or after (ISO 8601, e.g. 2025-01-31T00:00:00-03:00)
updated_at_maxNoUpdated at or before (ISO 8601)
updated_at_minNoUpdated at or after (ISO 8601)
response_formatNoOutput format: 'json' (default, full data) or 'markdown' (human-readable)json
total_spent_minNoMinimum total spent
accepts_marketingNoFilter by marketing consent

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.5/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive, openWorld), and the description adds genuinely useful context they don't carry: the required read_customers scope and the pinned API version 2025-03. It also discloses the return envelope (count, page, per_page, has_more, next_page, items[]), which no output schema provides here.

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?

Five short lines, front-loaded with the verb+resource, followed by endpoint, scope, version, and return shape — each line earning its place. The telegraphic style drops connective context (e.g. what 'count' counts against) but wastes no words.

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 description usefully spells out the response envelope including pagination fields, and it names the required OAuth scope for a 13-parameter read tool. It falls short only on pagination guidance for a 10000-record page ceiling and on distinguishing itself from sibling customer tools.

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% with 13 well-documented parameters, so the schema does the heavy lifting and baseline 3 applies. The description adds nothing about filter semantics — notably it never explains cursor pagination via since_id or how date cursors interact with page — so it neither compensates nor detracts.

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?

States a specific verb and resource ('List customers') plus the underlying endpoint GET /customers, so the operation is unambiguous. It does not explicitly contrast with siblings such as tiendanube_customers_get or tiendanube_price_tables_customers_list, but the verb/resource pairing is distinct enough to be told apart by name.

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

Usage Guidelines2/5

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

The description gives no when-to-use / when-not-to-use guidance and never references an alternative tool. An agent must infer from the name alone that this is the bulk-retrieval path versus customers_get for a single record; nothing in the text states that routing rule.

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

Deploy Server

Other Tools