Skip to main content
Glama
aweher

invoiceninja-mcp

by aweher

invoiceninja_list_products

Read-onlyIdempotent

List products from Invoice Ninja with filtering, sorting, and pagination. Retrieve IDs for full product records.

Instructions

List products from Invoice Ninja with filtering, sorting and pagination. extra_filters keys: product_key; created_between / updated_between ('YYYY-MM-DD,YYYY-MM-DD'), tag_ids (comma separated), assigned_user_ids. Use invoiceninja_get_product 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)
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

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is fully covered by structured data. The description's only behavioral addition is the extra_filters key semantics and the follow-up get_product hint, which is useful but modest for a read-only list tool.

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?

Three sentences, all load-bearing: purpose first, then the extra_filters syntax, then the follow-up tool. No filler, and the most important routing information is front-loaded.

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 9-parameter, zero-required list tool with full schema coverage and annotations, the description supplies the missing extra_filters vocabulary and the natural next step (get_product). No output schema exists, but response_format is self-documented in the schema, so nothing essential 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 description coverage is 100%, so the baseline is 3, but the description genuinely earns extra credit by spelling out the extra_filters keys (product_key, created_between / updated_between with 'YYYY-MM-DD,YYYY-MM-DD' format, tag_ids, assigned_user_ids) that the schema only gestures at with 'see the tool description'.

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?

Opens with a specific verb+resource ('List products from Invoice Ninja') and enumerates the supported operations (filtering, sorting, pagination). The resource name distinguishes it from the many sibling list_* tools, though it does not explicitly contrast itself with list_records or search.

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 forward: 'Use invoiceninja_get_product with an id from this list for the full record,' which is a clear when-to-use-this-vs-that instruction. It also documents the extra_filters vocabulary, though it gives no guidance on when to prefer this over the generic search or list_records tools.

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