Skip to main content
Glama

List records

list_records
Read-only

List records in one collection, with their fields. Optional query narrows by title.

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": {
      "app": "<app>",
      "collection": "<collection>"
    },
    "name": "list_records"
  }
}

Input Schema

NameRequiredDescriptionDefault
appYesThe app's id, or its name as shown in Bionic Forms
limitNoHow many (default 25, at most 200)
queryNoOnly records whose title contains this text
offsetNoSkip this many, to page
collectionYesA collection's id or label, from describe_app

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

The annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds that returned records carry their fields, which is a useful return-content hint, but it says nothing about ordering, the hard 200 cap, or how paging behaves when offset exceeds the result set.

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 short sentences with the primary action front-loaded and the optional filter second. No filler, no repetition of the title, and the schema carries all the detail that would otherwise bloat the text.

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 simple read-only list tool with full schema coverage and no output schema, the description is close to sufficient, but it omits any mention of result ordering or the fact that pagination is required past 200 records, and it does not differentiate from the overlapping search_records sibling.

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 all five parameters including default/cap limits and the collection lookup via describe_app are already documented. The description's note that query narrows by title merely restates the schema, adding no new meaning; baseline 3 applies.

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 states a specific verb and resource ('List records in one collection') and adds scope ('in one collection'), so the agent knows it enumerates within a single collection rather than across the app. It never names or contrasts with the sibling search_records, which is the closest alternative, so differentiation is left implicit.

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?

Usage is only implied: the tool lists one collection and the optional query narrows by title. There is no explicit statement of when to prefer this over search_records or get_record, and no exclusion of the cross-collection case, so the agent must infer routing from the tool names alone.

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.

Resources