Skip to main content
Glama

List documents

booqable_list_documents
Read-only

List invoices, quotes and contracts, with totals and payment status. Filter by type, order, customer or status. Booqable: GET /api/4/documents.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
qNoFree-text search.
pageNoPage number (1-based). Default 1.
sortNoSort, comma-separated attributes; prefix with - for descending, e.g. -created_at.
statusNoOnly documents in this status (values depend on document type).
includeNoComma-separated relationships to sideload, e.g. customer,order.
order_idNoOnly documents for this order.
page_sizeNoResults per page, 1-100 (Booqable default 25).
customer_idNoOnly documents for this customer.
document_typeNoOnly this document type.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior3/5

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

readOnlyHint=true already establishes this as a safe read, so the bar is lower. The description usefully adds that results include totals and payment status, but says nothing about pagination defaults, result size, or sideload behavior beyond what the schema states.

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, front-loaded with the resource and payload, followed by filters and the backing endpoint. No wasted text.

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 read-only list endpoint with full schema coverage and no output schema, the description covers resource, payload contents, and filter dimensions. Only minor gaps remain regarding pagination and sideloading, which the schema partly covers.

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 parameter is already documented in the schema (including enums for status and document_type). The description's filter listing adds no syntax or format detail beyond that, so the baseline 3 applies.

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?

States a specific verb (List) and resource (invoices, quotes, contracts) plus what each record carries (totals, payment status). This clearly distinguishes it from siblings like booqable_list_orders and booqable_list_payments.

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 names the filter dimensions (type, order, customer, status), which implies when the tool is useful, but gives no explicit when-to-use/when-not guidance or alternatives among the many list_* 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.