Skip to main content
Glama

Payhip: List orders

payhip_list_orders
Read-only

Payhip: Orders from the Customers page with buyer email, items, amounts, status and date. Returns the same filters as the Filter Orders button on the Customers page: email, product, order date, order ID, status and shipping. Orders come newest first and every date is in UTC. Pass the cursor to read the next page. Needs the user's Cotlet API key with access to this app.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
toNoOrders on or before this date (UTC).
fromNoOrders on or after this date (UTC).
emailNoBuyer email.
limitNo1 to 100. Default: 25.
cursorNoNext page cursor from the previous call.
statusNocompleted, refunded or partially_refunded.
order_idNoFind one order by ID.
shippingNounshipped (orders with unshipped items) or shipped (fully shipped), for physical products.
product_idNoOnly orders that include this product.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already cover safety (readOnlyHint, destructiveHint=false, openWorldHint), so the bar is lower. The description still adds real value beyond them: ordering ('newest first'), timezone ('every date is in UTC'), pagination mechanics ('pass the cursor to read the next page'), and an auth prerequisite (Cotlet API key with app access).

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?

Front-loads the resource and its returned fields, then adds ordering, timezone, pagination, and auth in sequence. Slightly wordy with mild redundancy (the Customers page referenced twice), but every sentence carries information and none is filler.

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?

No output schema exists, yet the description names the returned fields well enough for an agent to know what comes back, and it covers pagination, ordering, timezone, and authentication for a nine-parameter read tool. Only a fuller return-value or error description is missing.

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 the schema already documents all nine parameters including the two enums. The description restates the filter list (email, product, order date, order ID, status, shipping) but adds little syntax or format detail beyond what the schema provides, warranting the baseline 3.

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?

States a specific verb and resource ('Orders from the Customers page') and enumerates the returned fields (buyer email, items, amounts, status, date), so an agent understands exactly what a call yields. It does not explicitly distinguish itself from siblings like payhip_get_order or payhip_get_sales_report, but the list-shaped purpose is unambiguous.

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?

Describes the available filter set (email, product, order date, order ID, status, shipping) which implies the retrieval use case, and explains pagination via cursor. However it never states when to prefer this over payhip_get_order for a single lookup or payhip_get_sales_report for aggregates, so no exclusions or alternatives are offered.

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