Skip to main content
Glama
@cmssy/mcp-server

@cmssy/mcp-server

Official

List records

list_records
Read-only

List records of a data model by id or slug with filtering, sorting, and pagination. Find records by field value, link to live storefront URLs, and page through results.

Instructions

List the records (entries) of a data model, by the model's id or slug. Supports filtering (per key: scalar equality, $in, $gte/$lte, $regex as a literal substring match), sort, and pagination. Each record includes its full data, so you can find a record by a field value (e.g. sku) without extra lookups. Paginated: while hasMore is true, pass nextCursor back as cursor while it is set; if hasMore is true but nextCursor is null, page with the offset instead, and past offset 10000 narrow the filter. Each record carries url: its live storefront link, built by the server from the model's urlPattern and the site's public site URL. Use it whenever you link to a record and never build a storefront URL yourself (not from a slug, not from the site address). When url is null or missing, say why instead of guessing: the model has no urlPattern (set it with update_model), the model is not delivered (deliveryAccess none, or it is the login model), the site has no public site URL, or the record - or one it links to - is unpublished.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "modelIdOrSlug": "<modelIdOrSlug>"
    },
    "name": "list_records"
  }
}

Input Schema

NameRequiredDescriptionDefault
sortNo'<fieldKey>_asc' or '<fieldKey>_desc', e.g. createdAt_desc, price_asc. Built-in keys: createdAt, updatedAt, status; any other key must be a field of the model. Omitted: the model's default sort, else newest first.
limitNo
cursorNonextCursor from the previous page. The page continues after it in the same filter and sort; leave the skip/offset at 0 when you pass it
filterNoFilter on record data fields (or "status"). Supported per key: scalar equality {sku: "ABC-1"}, {"$in": [...]}, {"$gte"/"$lte": ...} ranges, {"$regex": "term", "$options": "i"} - a literal substring match ("i" for case-insensitive), not a regular expression: |, \, [], .*, ^ and $ are rejected, so search one term per call. Anything else is rejected.
localeNoLanguage for translatable fields, e.g. 'pl'. Their values come back as plain strings in that language, and a filter on one matches that language. Defaults to the workspace's default language.
offsetNoHow many rows to skip, at most 10000; page past that with cursor
populateNoRelation field keys to populate
modelIdOrSlugYesThe model's id or slug (from list_models)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.146.2
    • addedInput schema / properties / cursor
      Added value: +{
      +  "description": "nextCursor from the previous page. The page continues after it in the same filter and sort; leave the skip/offset at 0 when you pass it",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / offset / description
      Added value: +"How many rows to skip, at most 10000; page past that with cursor"
    • changedInput schema / properties / offset / maximum
      Previous value: -9007199254740991New value: +10000
    • changedInput schema / properties / offset / minimum
      Previous value: --9007199254740991New value: +0
  2. Changed7 schema fields changedv0.73.2
    • addedInput schema / additionalProperties
      Added value: +false
    • changedInput schema / properties / filter / description
      Previous value: -"Filter on record data fields (or \"status\"). Supported per key: scalar equality {sku: \"ABC-1\"}, {\"$in\": [...]}, {\"$gte\"/\"$lte\": ...} ranges, {\"$regex\": \"term\", \"$options\": \"i\"}. Anything else is rejected."New value: +"Filter on record data fields (or \"status\"). Supported per key: scalar equality {sku: \"ABC-1\"}, {\"$in\": [...]}, {\"$gte\"/\"$lte\": ...} ranges, {\"$regex\": \"term\", \"$options\": \"i\"} - a literal substring match (\"i\" for case-insensitive), not a regular expression: |, \\, [], .*, ^ and $ are rejected, so search one term per call. Anything else is rejected."
    • removedInput schema / properties / limit / default
      Removed value: -50
    • removedInput schema / properties / offset / default
      Removed value: -0
    • changedInput schema / properties / sort / description
      Previous value: -"Sort expression, e.g. 'createdAt' or '-updatedAt'"New value: +"'<fieldKey>_asc' or '<fieldKey>_desc', e.g. createdAt_desc, price_asc. Built-in keys: createdAt, updatedAt, status; any other key must be a field of the model. Omitted: the model's default sort, else newest first."
    • addedInput schema / properties / sort / pattern
      Added value: +"^(.+)_(asc|desc)$"
    • addedInput schema / required
      Added value: +[
      +  "modelIdOrSlug"
      +]
  3. First observedv0.73.1

TDQS

A4.4/5.0
Behavior5/5

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

Annotations declare readOnlyHint=true and destructiveHint=false, and nothing here contradicts that. The description goes well beyond them: it discloses the two-mode pagination contract (hasMore/nextCursor/offset), the 10000-offset ceiling, that `url` is server-derived from urlPattern and must never be built by hand, and it enumerates the exact four reasons url can be null so the agent can explain rather than guess. That is the kind of behavioral detail annotations cannot carry.

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?

The description is front-loaded with purpose and capabilities, then moves to pagination and finally the url contract, so the reading order matches likely agent needs. The final sentence is a long comma-chained list of null-url causes, but every clause there is actionable. No filler sentences, though the filter-capability recap duplicates the schema.

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?

There is no output schema, and the description compensates by describing the return shape: each record carries full data plus a server-built `url`, and pagination state arrives as hasMore/nextCursor. Combined with 88% schema coverage on eight parameters and read-only annotations, an agent has everything needed to call this correctly and to interpret the response.

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 88%, so the schema already documents sort, cursor, filter operators, locale, offset limits, and populate in detail. The description largely restates the filter capabilities ($in, ranges, $regex as literal substring) and pagination parameters rather than adding new semantics. Baseline 3 is appropriate when the schema does the heavy lifting.

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?

The opening sentence names a specific verb and resource ('List the records (entries) of a data model'), states the addressing scheme (model id or slug), and immediately enumerates the supported operations: filter, sort, pagination. An agent can distinguish this from list_models (which supplies the id) or bulk_update_records without opening a schema.

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

Usage Guidelines4/5

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

It gives concrete situational guidance: search by field value instead of doing extra lookups, use the returned `url` whenever linking, and page with `nextCursor` when present or fall back to `offset` otherwise. It even routes to a sibling ('set it with update_model') when urlPattern is missing. What it lacks is an explicit statement of when NOT to use this tool versus the many other list_* siblings (e.g. list_products), so it stops short of a full 5.

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