Skip to main content
Glama

Get invoice

crunch_get_invoice
Read-only

Fetch a single sales invoice by ID to inspect customer, dates, line items, VAT, payments received, credit notes, attachments, and status; use raw for the unchanged API object.

Instructions

Get one sales invoice: customer, dates, lines, VAT, payments received, credit notes, attachments and status. raw=true returns the API object.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "invoice_id": "<invoice_id>"
    },
    "name": "crunch_get_invoice"
  }
}

Input Schema

NameRequiredDescriptionDefault
rawNoReturn the API object unchanged
invoice_idYesInvoice ID (see crunch_list_invoices); not the invoice number

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.0

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds real behavioral value by disclosing the breadth of the returned record and the raw=true pass-through mode, though it says nothing about permissions, latency, or behavior for unknown/missing invoice IDs.

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, zero filler, with the resource and its contents front-loaded before the optional mode note.

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 no output schema, the description carries the burden of describing the return shape and does so well by listing the record's sections. Only the absent authorization/error expectations for a 2-parameter read keep it from being fully complete.

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 coverage is 100% and both parameters are already documented in the schema, including that invoice_id is not the invoice number and that raw returns the API object unchanged. The description only echoes raw=true, adding no meaning beyond the structured fields.

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 and resource ("Get one sales invoice") and enumerates the fields it returns — customer, dates, lines, VAT, payments, credit notes, attachments, status — which tells an agent this is the full-detail single-invoice fetch rather than a list or a narrow totals/status view.

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?

Usage is only implied: "one" contrast implicitly with crunch_list_invoices, but the description never explicitly says when to use this instead of crunch_get_invoice_totals, crunch_get_invoice_status or the list tool. No prerequisites or exclusions are given.

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