Skip to main content
Glama

List orders

booqable_list_orders
Read-only

List rental orders. Filter by free-text search (order number, customer name/email/address, tags, custom fields), status, payment status, customer, or rental-period range. Booqable: GET /api/4/orders.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
qNoSearch: order number (exact), customer name, e-mail, address, tags, custom field values.
tagNoOnly orders carrying this tag.
pageNoPage number (1-based). Default 1.
sortNoSort, comma-separated attributes; prefix with - for descending, e.g. -created_at.
statusNoOnly orders with this simplified status.
includeNoComma-separated relationships to sideload, e.g. customer,start_location,stop_location.
page_sizeNoResults per page, 1-100 (Booqable default 25).
customer_idNoOnly orders for this customer id.
stops_at_gteNoRental ends at or after this datetime (ISO 8601).
stops_at_lteNoRental ends at or before this datetime (ISO 8601).
starts_at_gteNoRental starts at or after this datetime (ISO 8601).
starts_at_lteNoRental starts at or before this datetime (ISO 8601).
payment_statusNoOnly orders with this payment status.

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?

readOnlyHint=true already tells the agent this is a safe read, so the bar is lower. The description adds only the upstream endpoint (GET /api/4/orders), which is mild context, and says nothing about pagination behavior, defaults, auth scope, or result ordering beyond what the schema already declares.

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, no filler, and the scope statement is front-loaded before the filter list. The trailing API path is compact enough not to bloat the definition.

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?

Filter selection is well covered, but with no output schema the description should at least hint at the response shape (order objects, page/page_size pagination) and it does not. For a 13-parameter list tool the filtering story is complete while the return story is absent.

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 every one of the 13 parameters is already documented with type, defaults and enums. The description's filter recap (q, status, payment status, customer, rental period) merely restates what the schema provides, earning 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 (List) and resource (rental orders), and enumerates the filter dimensions, which makes it immediately distinguishable from the singular booqable_get_order and from other list_* siblings. It stops short of naming any sibling explicitly, so it lands at clear-but-not-differentiating.

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?

The description implies when the tool is useful by listing filterable facets, but it never states when to prefer this over booqable_get_order or the other list_* endpoints, nor does it give any exclusions or prerequisites. Usage is inferable rather than spelled out.

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.