Skip to main content
Glama

Get invoice status

crunch_get_invoice_status
Read-only

Retrieve an invoice's current status, number, amounts, outstanding balance, and due date by invoice ID for a quick status check without fetching the full invoice.

Instructions

Get an invoice's current state (status, number, amounts, outstanding balance, due date), which is lighter than crunch_get_invoice.

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_status"
  }
}

Input Schema

NameRequiredDescriptionDefault
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

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered. The description adds genuinely useful behavioral context by listing what fields come back (a lightweight projection rather than the full invoice), which matters because there is no output schema. It says nothing about auth requirements, rate limits, or what happens for a missing/voided invoice.

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?

One compact sentence with the returned fields parenthesized and the sibling comparison front-loaded after the core purpose. Nothing is wasted, though the parenthetical field list makes it slightly dense.

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 one-parameter read tool with no output schema, enumerating the returned fields covers the main gap. However, idempotentHint=false is set on an ostensibly read-only getter and the description says nothing about repeat-call behavior, and it omits any statement about failure or empty-result handling.

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 the single parameter already documents that it is the ID, not the invoice number, with a pointer to crunch_list_invoices. The description adds no parameter meaning beyond that; the phrase "an invoice's" is the only nod to it. Baseline 3 applies since the schema does the work.

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 an invoice's current state") and enumerates the returned fields (status, number, amounts, outstanding balance, due date). It explicitly contrasts itself with the sibling crunch_get_invoice as the lighter option, so an agent can distinguish the two without opening either schema.

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?

The comparison "which is lighter than crunch_get_invoice" gives a clear routing signal toward this tool when a summary suffices. It stops short of stating an explicit when-to-use / when-not-to-use rule or naming the conditions under which the fuller tool is required, so it is a strong hint rather than a complete decision rule.

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