Skip to main content
Glama

List checkouts

list_checkouts
Read-only

Retrieve a list of checkouts with filters for status, product, date range, and search query. Supports pagination to manage large result sets.

Instructions

List checkouts with filters and pagination. Requires scope merchant_read.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
qNoSubstring match on id + description.
toNoUTC timestamp upper bound (created_at <=).
fromNoUTC timestamp lower bound (created_at >=).
limitNo
offsetNo
statusNo
product_idNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitYes
statsYes
offsetYes
has_moreYes
checkoutsYes
Behavior3/5

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

Annotations already declare readOnlyHint and openWorldHint. The description adds the scope requirement but does not disclose additional behaviors like pagination defaults or ordering.

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 concise with two sentences and no unnecessary words. It front-loads the main action and requirements.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Despite having 7 optional parameters and a rich schema, the description provides minimal context. It lacks explanation of default behavior, response structure (though output schema exists), or filter examples.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With only 43% schema description coverage, the description does not compensate by explaining any parameters. It only says 'with filters and pagination', adding no value beyond the schema.

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 clearly states 'List checkouts with filters and pagination', specifying the verb and resource. However, it does not explicitly differentiate from siblings like 'get_checkout' or 'list_product_checkouts'.

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 mentions required scope 'merchant_read', which is useful, but provides no guidance on when to use this tool vs alternatives like 'list_product_checkouts' or the single 'get_checkout'.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/depixapp/depix-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server