Skip to main content
Glama

Get invoice

get_invoice
Read-onlyIdempotent

Returns one invoice by its Paidnice id: number, contact, dates, amounts due and paid, status, and links to the accounting system and the customer payment portal. Use list_invoices to find the id. Read only.

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": {
      "organisationId": "<organisationId>",
      "id": "<id>"
    },
    "name": "get_invoice"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes
organisationIdYesId of the organisation to act on, from list_organisations

Output Schema

NameRequiredDescriptionDefault
idYes
frozenYes
numberNo
statusYes
dueDateYes
currencyYes
contactIdYes
dueAmountYes
issueDateYes
portalUrlYes
referenceNo
taxAmountYes
paidAmountYes
contactNameNo
totalAmountYes
exchangeRateYes
depositAmountYes
creditedAmountYes
discountAmountYes
lastSyncedDateNo
sentToCustomerYes
subtotalAmountYes
accountingSystemIdYes
accountingSystemOnlineUrlNo
accountingSystemExchangeRateNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior3/5

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

The annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so "Read only" adds nothing new. The description does add useful context by naming the shape of the returned payload, but since an output schema already exists, that value is partly redundant and no error behavior (unknown id, wrong organisation) is disclosed.

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 short sentences, front-loaded with the purpose and returned fields, followed by the id-provenance hint and safety note. No filler or repetition beyond the minor "Read only" restatement.

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?

For a two-parameter read tool with a full output schema and rich annotations, the description covers what is fetched, how to get the id, and that the call is safe. Minor gaps remain around org scoping and not-found behavior, but nothing an agent needs to invoke it correctly is missing.

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 only 50%: organisationId is documented in-schema but id carries only format/pattern metadata. The description compensates by naming the id as a "Paidnice id" and pointing to list_invoices as its source, which is real semantic meaning not in the schema. It says nothing about organisationId scoping, keeping it below a 5.

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?

Specific verb-and-resource ("Returns one invoice by its Paidnice id") followed by an enumeration of the returned fields: number, contact, dates, amounts due and paid, status, and accounting/portal links. This clearly separates it from the sibling list_invoices, which returns a collection.

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?

Explicitly routes the agent to list_invoices to obtain the id, which is the practical prerequisite for calling this tool. It stops short of stating exclusions (e.g., when to prefer list_invoices with a filter over a single fetch), but the sequencing guidance is clear enough to act on.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources