Skip to main content
Glama

Get a list of salesbook invoices

list_salesbook_invoices
Read-onlyIdempotent

Retrieve paginated salesbook invoices with their line items. Filter by status, edit date, or relation, and sort to find specific records.

Instructions

Get a list of salesbook invoices.

Get a paginated list of all salesbook invoices with their line items.

[Salesbook] GET /salesbook

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number (default = 1).
sortNoSort order. Format: field.direction (e.g. date.desc). Available fields: created, name, number, date, amount, invoiceAmountPaid, invoiceAmountOpen.
filterNoFilter salesbook invoices by status.
recordsNoNumber of records per page.
last_editNoOnly return salesbook invoices edited after this date (format: YYYY-mm-dd).
relation_idNoOnly return salesbook invoices for the relation with this ID.
administrationNoThe client administration to act on. Only one is configured: default.
Install Server

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, covering the safety profile. The description adds that results are paginated and include line items, which is useful but does not disclose other behaviors like response format or rate limits. Neutral given annotation coverage.

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?

The description is concise with two main sentences and an endpoint line. However, the first sentence 'Get a list of salesbook invoices' repeats the title, but the second sentence adds value. No filler, well front-loaded.

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?

For a read-only list tool with full schema coverage and annotations, the description is adequate but not complete. It does not explain the return structure (no output schema) or clarify how to use filters/sorting beyond what is in the schema. The lack of usage context also weakens completeness.

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 all parameters have descriptive text in the schema. The description itself does not add any parameter-specific meaning beyond the schema. Baseline 3 is appropriate.

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: 'Get a paginated list of all salesbook invoices with their line items.' It clearly distinguishes this from sibling tools like list_sales_invoices by naming the 'salesbook' resource. The endpoint reference further reinforces the purpose.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No explicit guidance on when to use this tool versus alternatives. The description implies it is for salesbook invoices, but there is no mention of when to choose this over list_sales_invoices or other list tools. Lacks actionable usage context.

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

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/vladxyz/informer-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server