Skip to main content
Glama

List entities

list_entities
Read-only

List a customer's entities with cursor pagination and optional filters. Autumn API: POST /v1/entities.list. Returns { list, next_cursor }.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoPage size, 1-5000. Default 50.
plansNoFilter by plan: array of { id, versions? } objects.
searchNoSearch entities by id or name.
processorsNoFilter by parent customer processor: stripe, revenuecat, vercel.
customer_idYesRestrict the response to entities owned by this customer id.
start_cursorNoPagination cursor from a prior response's `next_cursor` (omit / empty for first page).
subscription_statusNoFilter by status: "active" or "scheduled". Defaults to both.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, and the description adds that this is a paginated list call returning { list, next_cursor }. This goes beyond the annotation by clarifying the response shape and pagination behavior without contradicting it.

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 tight sentences deliver the core action, scope, API endpoint, and return shape with no filler. The most important information is front-loaded.

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 operation with a rich schema and readonly annotation, the description is nearly sufficient. It states the resource, pagination, and return format, though it does not explicitly guide the agent between this and related list/get 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 coverage is 100%, so all seven parameters are described in the input schema. The description only refers generically to 'optional filters', adding no parameter-specific semantics beyond what the schema already provides.

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 uses a specific verb ('List') and resource ('a customer's entities'), and even identifies the exact API endpoint. This clearly separates it from sibling list tools such as list_customers and get_entity.

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 first sentence establishes the intended use case: listing entities belonging to a customer, with pagination and filters. It does not explicitly name alternatives or exclusions, so it falls short of a 5, but the context is clear enough for selection among siblings.

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.