Skip to main content
Glama

List document blocks

billingo_list_document_blocks
Read-onlyIdempotent

List document blocks to retrieve invoice number ranges and block IDs required for creating invoices. Use paging to find the block that matches your document numbering.

Instructions

Lists document blocks (invoice number ranges). Every document belongs to a block; you need a block id to create an invoice.

Input Schema

NameRequiredDescriptionDefault
pageNoPage number, starting at 1.
per_pageNoResults per page (1-100, default 25).

Output Schema

NameRequiredDescriptionDefault
dataYes
totalNo
per_pageNo
last_pageNo
current_pageNo
next_page_urlNo
prev_page_urlNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.1.3
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": {},
      +  "properties": {
      +    "current_page": {
      +      "type": [
      +        "number",
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "data": {
      +      "items": {
      +        "additionalProperties": {},
      +        "properties": {
      +          "id": {
      +            "type": "number"
      +          },
      +          "name": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "prefix": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "type": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          }
      +        },
      +        "required": [
      +          "id"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "last_page": {
      +      "type": [
      +        "number",
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "next_page_url": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "per_page": {
      +      "type": [
      +        "number",
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "prev_page_url": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "total": {
      +      "type": [
      +        "number",
      +        "string",
      +        "null"
      +      ]
      +    }
      +  },
      +  "required": [
      +    "data"
      +  ],
      +  "type": "object"
      +}
  2. First observedv0.1.0

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and openWorldHint, so the safety profile is covered. The description adds genuine domain context beyond that — that blocks are invoice number ranges and that every document belongs to one — which explains the data model rather than repeating the schema.

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 short sentences, front-loaded with the definition and followed by the practical reason to call it. Nothing here is padding.

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?

With an output schema present and both parameters documented, the description only needs to convey the concept and the use case, which it does. A note on result volume or typical block count would have closed the remaining gap.

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% (page and per_page are fully documented in the schema), so the baseline is 3. The description adds no pagination or filtering semantics of its own.

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 ('Lists document blocks') and immediately glosses the domain term as 'invoice number ranges', which is the key disambiguation. It does not name any sibling tool, but no sibling deals with blocks, so the risk of confusion is low.

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?

Gives a concrete use condition: 'you need a block id to create an invoice', which tells the agent why and when to call it. It stops short of explicit when-not-to-use guidance or naming an alternative, so it lands at clear context rather than full routing.

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