Skip to main content
Glama
QuickBooks Online MCP Server

QuickBooks Online MCP Server

by NightSquawk

read_invoice

Retrieve a single QuickBooks Online invoice by its ID to inspect details such as line items, amounts, and status.

Instructions

Read a single invoice from QuickBooks Online by its ID.

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": {
      "params": "<params>"
    },
    "name": "read_invoice"
  }
}

Input Schema

NameRequiredDescriptionDefault
paramsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.5/5.0
Behavior3/5

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

With no annotations, the description carries full behavioral burden, but it only establishes that this is a read operation from QuickBooks Online. It does not disclose authentication needs, not-found behavior, returned fields, or the expected ID format, which are relevant for an external-system read.

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 a single front-loaded sentence with no unnecessary wording. Every element (read, single invoice, QuickBooks Online, ID) contributes to understanding the tool.

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 simple one-parameter read tool this is minimally complete, but with no output schema the description could say more about the returned invoice object and error behavior when an ID does not exist. It leaves some contextual gaps that a caller would otherwise have to infer.

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 0%, so the description must compensate. It does identify invoice_id as the invoice's ID, but adds no format details, validation expectations, or other semantics beyond the property name and "by its ID" phrasing.

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?

The description gives a specific verb (read), resource (invoice), scope (single), source system (QuickBooks Online), and lookup key (ID). It implicitly distinguishes itself from search_invoices, but does not explicitly name sibling alternatives such as search_invoices or get_invoice_pdf.

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?

The phrase "by its ID" implies the prerequisite that the caller must already have an invoice ID. However, there is no explicit guidance on when to use this tool versus search_invoices or get_invoice_pdf, and no when-not conditions 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