Skip to main content
Glama
cmssy-io

@cmssy/mcp-server

Official
by cmssy-io

list_records

Fetch entries of a data model using its ID or slug, with filters, sorting, and pagination to find records by any field value.

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

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sortNoSort expression, e.g. 'createdAt' or '-updatedAt'
limitNo
filterNoFilter 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.
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.
offsetNo
populateNoRelation field keys to populate
modelIdOrSlugNoThe model's id or slug (from list_models)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.73.1

TDQS

A4.2/5.0
Behavior4/5

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

No annotations are provided, so the description carries the behavioral burden. It discloses that all records for a model are returned, that filtering supports specific operators, and that full record data is included so records can be found by field value. This is substantial behavioral transparency for a read/list tool, though it does not cover defaults or error cases.

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 sentences with no filler. The core action and model identifier are front-loaded, then capabilities are listed compactly, and the practical use case closes the description without redundancy.

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?

For a list tool with seven parameters and no output schema, the description covers the essential lambda: what it lists, how it identifies the model, filtering operators, sort, pagination, and return richness. It is not exhaustive about defaults or edge cases, but the schema fills in several of those gaps.

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 71%, and the schema already documents the main parameters such as filter, locale, sort, and modelIdOrSlug. The description adds high-level meaning like 'by model id or slug' and 'full data,' but it does not go beyond the schema for individual parameters. Baseline 3 is appropriate.

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 description opens with a specific verb and resource: 'List the records (entries) of a data model, by the model's id or slug.' It clearly distinguishes from get_record by emphasizing plural listing plus filter/sort/pagination, and it adds the useful behavior that records include full data.

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?

The description gives clear context for when to use the tool: to list records of a model, filter them, sort them, paginate, and locate a record by field value without extra lookups. It does not explicitly name an alternative or state when not to use it, but the usage context is clear enough to route an agent correctly.

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