Skip to main content
Glama
aweher

invoiceninja-mcp

by aweher

invoiceninja_get_invoice

Read-onlyIdempotent

Retrieve a single invoice's complete details, including line items, by its hashed ID. Filter returned fields or embed related records like payments.

Instructions

Get one invoice by its hashed id, with all details (line items included).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesHashed record id, e.g. 'Opnel5aKBz'
fieldsNoJSON format only: return just these top-level fields (id is always included), e.g. ['number', 'client_name', 'balance', 'due_date']
includeNoExtra relations to embed, comma separated (e.g. 'payments,activities')
response_formatNo'markdown' (default) for a readable summary, 'json' for complete machine-readable data (empty fields removed)markdown

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, so the safety profile is covered. The description adds that all details including line items are returned, which is useful, though it sits in mild tension with the schema's markdown-default summary behavior.

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?

A single short sentence with zero filler, front-loading the verb, resource and access key. Nothing is wasted and nothing important is buried.

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?

There is no output schema, but the description tells the agent what comes back (full invoice detail with line items), which is the key missing piece. The one gap is that it doesn't reconcile 'all details' with the markdown-default response_format that trims data.

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 100%, so id, fields, include and response_format are fully documented in the schema itself. The description's only semantic contribution ('hashed id') merely restates what the schema already says, so the baseline 3 applies.

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 and resource ('Get one invoice') and pins the identifier type ('by its hashed id'), which cleanly separates it from the plural list_invoices sibling. It doesn't explicitly name that sibling, so it falls just short of a 5.

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: an agent can infer this is the detail-fetch counterpart to invoiceninja_list_invoices, but the description never says when to use it versus a list or search. 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.