Skip to main content
Glama

preview-invoice

Read-only

Get one invoice by ID with its full stored details: status, customer and recipient, dates, currency, line items, totals and taxes, payment methods, credit notes and document links once generated. Works for any status, including drafts. Use it to check a draft before submit-invoice, or get-invoice-document-links when you only need the links.

Input Schema

NameRequiredDescriptionDefault
idYesInvoice ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, destructiveHint=false, and openWorldHint=false, so safety is covered. The description adds behavioral context beyond annotations: it works for any invoice status including drafts, and document links appear only 'once generated,' which helps the agent interpret return state.

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?

Front-loads the core action and return scope, then adds status coverage and routing guidance in two efficient sentences. No filler; every sentence adds needed information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a one-parameter read-only tool with no output schema and safety annotations already in place, the description supplies purpose, when-to-use, alternatives, return contents, and status behavior. Nothing essential is missing.

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 the single 'id' parameter is fully documented as 'Invoice ID' with a pattern. The description adds no syntax or format meaning beyond the schema, so the baseline of 3 applies.

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 ('Get') and resource ('one invoice by ID') and enumerates the full stored details returned. Distinguishes itself from siblings like get-invoice-document-links by scoping to the complete invoice record rather than just links.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly says when to use it: 'to check a draft before submit-invoice' and when not to use it: 'get-invoice-document-links when you only need the links.' It also clarifies it works for any status, including drafts, removing ambiguity.

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