Skip to main content
Glama
nubiia-dev
by nubiia-dev

list_documents

List Holded documents by type with cursor pagination, optional field projection, and summary-only counts for lighter responses.

Instructions

List documents of a specific type (Holded API v2). Cursor-paginated: pass the previous response nextCursor as cursor. Response fields are snake_case; amounts are strings with decimal comma. NOTE: purchaserefund is not listable in v2 — only creation is supported (POST /purchases/refund).

Input Schema

NameRequiredDescriptionDefault
limitNoMax items per page (server-paginated; use limit to control page size)
cursorNoCursor from a previous response nextCursor for the next page
fieldsNoProject only these fields per item (e.g. ["id", "contact_name", "total"]). Reduces response size.
docTypeYesType of document to list
summaryNoReturn only count and pagination metadata without items (default: false)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed11 schema fields changedv2.0.3
    • removedInput schema / properties / approved
      Removed value: -{
      -  "description": "Filter by approval state: 0=not approved, 1=approved. Maps to Holded `filter=approved-<n>`. Independent of the Paid/Pending badge and of paymentsPending.",
      -  "enum": [
      -    "0",
      -    "1"
      -  ],
      -  "type": "string"
      -}
    • removedInput schema / properties / billed
      Removed value: -{
      -  "description": "Filter by billed status: 0=not billed, 1=billed",
      -  "enum": [
      -    "0",
      -    "1"
      -  ],
      -  "type": "string"
      -}
    • removedInput schema / properties / contactid
      Removed value: -{
      -  "description": "Filter documents by contact ID",
      -  "type": "string"
      -}
    • addedInput schema / properties / cursor
      Added value: +{
      +  "description": "Cursor from a previous response nextCursor for the next page",
      +  "type": "string"
      +}
    • removedInput schema / properties / endtmp
      Removed value: -{
      -  "description": "Ending timestamp (Unix timestamp) for filtering documents by date",
      -  "type": "string"
      -}
    • changedInput schema / properties / fields / description
      Previous value: -"Select specific fields to return (e.g., [\"id\", \"contactName\", \"total\"]). Reduces response size by 70-90%. If not provided, returns default fields: id, contact, contactName, date, tax, total, status, paymentsPending"New value: +"Project only these fields per item (e.g. [\"id\", \"contact_name\", \"total\"]). Reduces response size."
    • changedInput schema / properties / limit / description
      Previous value: -"Maximum number of items to return (default: 50, max: 500)"New value: +"Max items per page (server-paginated; use limit to control page size)"
    • removedInput schema / properties / page
      Removed value: -{
      -  "description": "Page number for pagination (optional)",
      -  "type": "number"
      -}
    • removedInput schema / properties / paid
      Removed value: -{
      -  "description": "Filter by payment status: 0=not paid, 1=paid, 2=partially paid",
      -  "enum": [
      -    "0",
      -    "1",
      -    "2"
      -  ],
      -  "type": "string"
      -}
    • removedInput schema / properties / sort
      Removed value: -{
      -  "description": "Sort order by creation date",
      -  "enum": [
      -    "created-asc",
      -    "created-desc"
      -  ],
      -  "type": "string"
      -}
    • removedInput schema / properties / starttmp
      Removed value: -{
      -  "description": "Starting timestamp (Unix timestamp) for filtering documents by date",
      -  "type": "string"
      -}
  2. Changed2 schema fields changedv1.7.0
    • addedInput schema / properties / approved
      Added value: +{
      +  "description": "Filter by approval state: 0=not approved, 1=approved. Maps to Holded `filter=approved-<n>`. Independent of the Paid/Pending badge and of paymentsPending.",
      +  "enum": [
      +    "0",
      +    "1"
      +  ],
      +  "type": "string"
      +}
    • changedInput schema / properties / fields / description
      Previous value: -"Select specific fields to return (e.g., [\"id\", \"contactName\", \"total\"]). Reduces response size by 70-90%. If not provided, returns default fields: id, contact, contactName, date, tax, total, status"New value: +"Select specific fields to return (e.g., [\"id\", \"contactName\", \"total\"]). Reduces response size by 70-90%. If not provided, returns default fields: id, contact, contactName, date, tax, total, status, paymentsPending"
  3. First observedv1.6.0

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations provided, the description carries the behavioral burden and discloses important traits: cursor pagination, snake_case response fields, decimal-comma amount strings, and the purchaserefund limitation. It does not cover auth, rate limits, or default ordering, so it is useful but not fully exhaustive.

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?

The description is compact and front-loaded: purpose first, then pagination mechanics, response-format caveats, and the purchaserefund exception. Every sentence adds operational value.

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 five-parameter list tool with no output schema, the description supplies useful pagination and response-format context. It is nearly complete, though it could mention default ordering or error behavior.

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

Parameters4/5

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

Schema coverage is 100%, so the schema already documents all five parameters. The description adds meaningful semantics beyond the schema by clarifying cursor usage and warning that purchaserefund appears in the enum but is not listable in v2.

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 states a specific verb and resource: list documents of a specific type via the Holded API v2. It clearly distinguishes this from single-document siblings such as get_document by emphasizing listing and pagination.

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?

It explains how to paginate by passing the previous response nextCursor as cursor and explicitly warns that purchaserefund is not listable in v2. It does not name alternative tools such as get_document or create_document, but the usage context is otherwise clear.

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

Deploy Server

Other Tools