Skip to main content
Glama

InvoiceIn

by io.github.peculiar-systems
OverviewDiscussionsAdmin

Read invoice

read_invoice
Read-onlyIdempotent

Parse one European or UAE (PINT AE) e-invoice into canonical EN 16931 JSON and validate it against the official rule sets in the same call. Use it when you need the invoice content (seller, buyer, lines, totals, payment) together with the verdict; use validate_invoice for a verdict-only answer, invoice_to_html / invoice_to_csv / invoice_to_datev for renderings. Input: XML (UBL, CII, XRechnung, Peppol BIS 3, UAE PINT AE, FatturaPA, KSeF FA(2)/FA(3)) or a ZUGFeRD/Factur-X hybrid PDF up to 25 MB; plain or scanned PDFs without embedded XML are rejected (no OCR). Returns the parsed invoice, the validation report with fix hints in lang, and timings; an unreadable file returns ok=false with error.code/message/hint instead of raising. A FatturaPA lot returns only its first invoice, with a note. For a Polish KSeF invoice, pass the KSeF number in ksef: it is checked against the invoice and returned on payment.ksef_number. Costs one invoice credit per call; without an API key the anonymous quota is 20 invoices per day per IP. Nothing is stored.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ksefNoPoland only: the KSeF number the National e-Invoice System gave this invoice — 35 characters, NNNNNNNNNN-RRRRMMDD-FFFFFFFFFFFF-FF — or the collective identifier covering it (NNNNNNNNNN-IZRRRRMM-FFFFFFFFFFFF-FF). KSeF assigns it on acceptance, so it is never inside the FA(2)/FA(3) XML: it arrives beside the invoice in the KSeF API response, the UPO or the QR code on a visualisation. Pass it and it is checked against the invoice and returned on payment.ksef_number, the reference a Polish buyer must quote in the bank transfer title from 2027-01-01. Leave empty for invoices from any other country.
langNoLanguage of the fix hints in the validation report and of the labels in HTML output. Default en.en
pathNoAbsolute path of the invoice file on the machine running the server, used instead of file_base64. Only honoured over stdio (`python -m invoicein.mcp_server`); the hosted server at invoicein-api.peculiar.systems ignores it and answers with an error asking for file_base64.
file_base64NoInvoice file content, base64-encoded (standard alphabet). Accepted content: XML in UBL 2.1, CII D16B, XRechnung, Peppol BIS Billing 3, FatturaPA 1.2 or KSeF FA(2)/FA(3) syntax, or a ZUGFeRD 1.0/2.x or Factur-X hybrid PDF (the embedded XML is used). Max 25 MB decoded. Required unless `path` is given.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
okYesFalse when the file could not be read; then only `error` is set
noteNoSet when the file is a lot of several invoices: only the first is returned
errorNoPresent when ok is false: code, message, hint
sourceNoDetected syntax, format, profile and container
invoiceNoCanonical EN 16931 JSON: document, seller, buyer, lines, tax_breakdown, totals, payment, attachments, extensions; field names carry BT/BG numbers in /v1/schema
timings_msNoProcessing time per stage: detect, map, validate, total
validationNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / ksef
      Added value: +{
+  "default": "",
+  "description": "Poland only: the KSeF number the National e-Invoice System gave this invoice — 35 characters, NNNNNNNNNN-RRRRMMDD-FFFFFFFFFFFF-FF — or the collective identifier covering it (NNNNNNNNNN-IZRRRRMM-FFFFFFFFFFFF-FF). KSeF assigns it on acceptance, so it is never inside the FA(2)/FA(3) XML: it arrives beside the invoice in the KSeF API response, the UPO or the QR code on a visualisation. Pass it and it is checked against the invoice and returned on payment.ksef_number, the reference a Polish buyer must quote in the bank transfer title from 2027-01-01. Leave empty for invoices from any other country.",
+  "title": "Ksef",
+  "type": "string"
+}
  2. Changed22 schema fields changed
    • removedInput schema / properties / file_base64 / anyOf
      Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
    • changedInput schema / properties / file_base64 / default
      Previous value: -nullNew value: +""
    • changedInput schema / properties / file_base64 / description
      Previous value: -"The invoice file, base64-encoded: XML (UBL, CII, XRechnung, Peppol, FatturaPA, KSeF FA(3)) or a ZUGFeRD/Factur-X hybrid PDF. Up to 25 MB decoded."New value: +"Invoice file content, base64-encoded (standard alphabet). Accepted content: XML in UBL 2.1, CII D16B, XRechnung, Peppol BIS Billing 3, FatturaPA 1.2 or KSeF FA(2)/FA(3) syntax, or a ZUGFeRD 1.0/2.x or Factur-X hybrid PDF (the embedded XML is used). Max 25 MB decoded. Required unless `path` is given."
    • addedInput schema / properties / file_base64 / type
      Added value: +"string"
    • changedInput schema / properties / lang / description
      Previous value: -"Language of the fix hints and rendering labels: en, de, pl, it or fr."New value: +"Language of the fix hints in the validation report and of the labels in HTML output. Default en."
    • addedInput schema / properties / lang / enum
      Added value: +[
+  "en",
+  "de",
+  "pl",
+  "it",
+  "fr"
+]
    • removedInput schema / properties / lang / pattern
      Removed value: -"^(en|de|pl|it|fr)$"
    • removedInput schema / properties / path / anyOf
      Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
    • changedInput schema / properties / path / default
      Previous value: -nullNew value: +""
    • changedInput schema / properties / path / description
      Previous value: -"Local file path instead of file_base64; only honoured when the server runs over stdio on the same machine."New value: +"Absolute path of the invoice file on the machine running the server, used instead of file_base64. Only honoured over stdio (`python -m invoicein.mcp_server`); the hosted server at invoicein-api.peculiar.systems ignores it and answers with an error asking for file_base64."
    • addedInput schema / properties / path / type
      Added value: +"string"
    • addedOutput schema / $defs / Validation / properties / errors / description
      Added value: +"Number of failed rules with severity error"
    • addedOutput schema / $defs / Validation / properties / issues / description
      Added value: +"Failed rules, each with a fix hint"
    • addedOutput schema / $defs / Validation / properties / notes / description
      Added value: +"Informational notes about the validation run"
    • changedOutput schema / $defs / Validation / properties / rule_sets / description
      Previous value: -"Rule sets applied, with versions"New value: +"Rule sets applied, with versions (XSD, EN 16931, XRechnung, Peppol, FatturaPA, KSeF, arithmetic)"
    • addedOutput schema / $defs / Validation / properties / valid / description
      Added value: +"True when no rule of severity error failed"
    • addedOutput schema / $defs / Validation / properties / warnings / description
      Added value: +"Number of failed rules with severity warning"
    • changedOutput schema / properties / invoice / description
      Previous value: -"Canonical EN 16931 JSON: document, seller, buyer, lines, tax_breakdown, totals, payment, attachments, extensions"New value: +"Canonical EN 16931 JSON: document, seller, buyer, lines, tax_breakdown, totals, payment, attachments, extensions; field names carry BT/BG numbers in /v1/schema"
    • addedOutput schema / properties / note
      Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null,
+  "description": "Set when the file is a lot of several invoices: only the first is returned",
+  "title": "Note"
+}
    • addedOutput schema / properties / ok / description
      Added value: +"False when the file could not be read; then only `error` is set"
    • addedOutput schema / properties / source / description
      Added value: +"Detected syntax, format, profile and container"
    • addedOutput schema / properties / timings_ms / description
      Added value: +"Processing time per stage: detect, map, validate, total"
  3. First observed

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already declare readOnlyHint and idempotentHint, and the description adds substantial context: it states nothing is stored, costs one credit per call, has an anonymous quota, returns ok=false with error details instead of raising, handles FatturaPA lots with a note, and explains KSeF handling. No contradiction with annotations; the description enriches the safety and operational profile.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is long but every sentence carries useful information. It opens with the purpose, then usage routing, then input constraints, then behavior, then special cases, then costs. It is structured and front-loaded; the length is justified by the tool's complexity. It loses a point only for being slightly dense, though not wasteful.

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?

Given the tool's complexity (many formats, validation, credit costs, special cases) and the presence of an output schema, the description covers everything an agent needs to decide and invoke correctly: input formats, size limits, rejection criteria, return shape, error handling, cost, and storage. It does not need to repeat output schema details, and it doesn't.

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

Parameters5/5

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

Schema coverage is 100% with detailed descriptions, yet the description adds meaningful context beyond the schema: it explains the KSeF number format and why it's not in the XML, clarifies that path is ignored on the hosted server, and details file size limits and accepted formats. This goes well beyond the baseline of 3 and fully compensates for any potential ambiguity.

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?

The description states a specific verb (parse + validate) and a specific resource (e-invoices), and explicitly distinguishes itself from siblings by naming what validate_invoice and rendering tools do. An agent can immediately tell this is the content+verdict tool, not the verdict-only or rendering alternative.

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?

It gives explicit when-to-use ('when you need the invoice content together with the verdict') and names the alternatives with their distinct purposes ('use validate_invoice for a verdict-only answer, invoice_to_html / invoice_to_csv / invoice_to_datev for renderings'). It also clarifies input constraints and rejection cases, so an agent knows exactly when to select this tool.

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

All InvoiceIn toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources