Skip to main content
Glama
aweher

invoiceninja-mcp

by aweher

invoiceninja_list_purchase_orders

Read-onlyIdempotent

List purchase orders from Invoice Ninja with filters for status, dates, vendors, sorting, and pagination; use an id from results to fetch the full order record.

Instructions

List purchase orders from Invoice Ninja with filtering, sorting and pagination. client_status values: all, draft, sent, accepted, cancelled. extra_filters keys: date_range ('YYYY-MM-DD,YYYY-MM-DD' on the document date, or 'due_date,YYYY-MM-DD,YYYY-MM-DD' for another column), date (on/after YYYY-MM-DD), due_date (on/before YYYY-MM-DD), number, vendor_id; created_between / updated_between ('YYYY-MM-DD,YYYY-MM-DD'), tag_ids (comma separated), assigned_user_ids. Related names are resolved automatically (vendor_name). Use invoiceninja_get_purchase_order with an id from this list for the full record.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number, starting at 1
sortNoSort as 'column|asc' or 'column|desc', e.g. 'date|desc'
fieldsNoJSON format only: return just these top-level fields (id is always included), e.g. ['number', 'client_name', 'balance', 'due_date']
filterNoFree-text search across the main columns (number, name, contacts, notes…)
statusNoLifecycle filter, comma separated: active, archived, deleted (e.g. 'active' to skip archived and deleted records)
includeNoExtra relations to embed, comma separated (e.g. 'payments,activities')
per_pageNoRecords per page (1-100)
client_statusNoBusiness status filter, comma separated; one or more of: all, draft, sent, accepted, cancelled
extra_filtersNoAdditional API query filters as name -> value (see the tool description)
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

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and openWorldHint, so the safety profile is handled. The description adds behavioral context the annotations lack: related names such as vendor_name are resolved automatically, and it spells out the filtering semantics of the extra_filters object. It stops short of describing pagination/rate-limit behavior or the returned record shape.

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?

Front-loaded with the core purpose, then dense but well-organized detail on filter values and the get-sibling routing. Every line carries information; the extra_filters enumeration is long but necessary given the schema's deferral. Slightly packed, but no filler.

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?

With 10 optional parameters, no output schema and no required args, the description supplies the missing filter-key vocabulary and the follow-up tool for full records. It leaves the actual response shape for a list call unspecified, but that is a minor gap for a paging list tool covered by readOnly annotations.

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 100%, so the baseline is 3, but the description earns extra credit because the extra_filters schema entry merely says 'see the tool description' and defers entirely to this text. The description then enumerates the accepted keys and value formats (date_range, due_date, created_between, tag_ids, etc.), which is genuinely additive rather than duplicative.

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 and resource ('List purchase orders from Invoice Ninja') plus the capabilities it supports (filtering, sorting, pagination). It explicitly distinguishes itself from the sibling invoiceninja_get_purchase_order, so an agent can route without opening either schema.

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?

The closing sentence gives a clear when-to-use-this-vs-that rule: list here, then call invoiceninja_get_purchase_order with an id for the full record. It does not address when to prefer this over invoiceninja_search or invoiceninja_list_records, but the primary routing decision is covered.

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