Skip to main content
Glama

Get an invoice

get_invoice
Read-only

Retrieve one invoice by its ID along with line items, redacting sensitive details unless contact details are explicitly requested.

Instructions

One invoice by id with its line items. Line-item titles and invoice notes are the practice's own text and go through the redaction unless include_contact_details is set.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
invoice_idYes
include_contact_detailsNoInclude the Patient Portal payment link, and stop redacting email addresses, phone numbers, NHS-number-shaped digit groups and UK postcodes typed into names and other text

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so safety is covered. The description adds genuinely useful behavioral context beyond that: line-item titles and invoice notes are the practice's own free text and are subject to redaction unless include_contact_details is set. It does not disclose not-found/error behavior, but it meaningfully extends the annotation profile.

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 waste. The core capability (one invoice by id with line items) is front-loaded, and the redaction caveat follows immediately. Nothing is repeated from the schema or annotations verbatim.

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?

No output schema exists, so the description appropriately states what is returned (the invoice plus its line items) and explains the redaction behavior that affects the response. For a read-only, 2-parameter tool this is nearly complete; only not-found/error behavior is unaddressed.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 50%: invoice_id carries only a UUID pattern while include_contact_details has a rich schema description. The prose compensates by explaining that free-text fields (line-item titles, notes) are the redaction target, which clarifies the practical effect of include_contact_details beyond the schema's own wording.

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+resource+scope: 'One invoice by id with its line items', which clearly distinguishes a single-record fetch from the sibling list_invoices. It falls short of 5 only because it never names the sibling explicitly and 'get/one' is left implicit rather than stated as a verb.

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 implied by 'by id' — you fetch a specific invoice when you already have its id — but there is no explicit when-to-use guidance and no exclusion or alternative named (e.g., use list_invoices to find an id first). Adequate but leaves routing to inference.

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