Skip to main content
Glama
aweher

invoiceninja-mcp

by aweher

invoiceninja_list_recurring_invoices

Read-onlyIdempotent

List recurring invoices from Invoice Ninja with filtering, sorting, and pagination. Filter by status, frequency, dates, tags, and assigned users to find specific records.

Instructions

List recurring invoices from Invoice Ninja with filtering, sorting and pagination. client_status values: all, draft, active, paused, completed. extra_filters keys: number, product_key, frequency_id (1 daily … 5 monthly … 10 annually), next_send_between ('YYYY-MM-DD|YYYY-MM-DD'); created_between / updated_between ('YYYY-MM-DD,YYYY-MM-DD'), tag_ids (comma separated), assigned_user_ids. Related names are resolved automatically (client_name). Use invoiceninja_get_recurring_invoice 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_idNoOnly records of this client (hashed id)
client_statusNoBusiness status filter, comma separated; one or more of: all, draft, active, paused, completed
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/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/openWorld/non-destructive, so the safety profile is covered. The description adds real behavioral context beyond that: automatic resolution of related names (client_name) and the exact accepted key/value formats for extra_filters. It does not describe pagination limits or result size, keeping it out of 5 territory.

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 action, then organized into scannable lines for client_status, extra_filters keys, and the related-tool pointer. Dense but every line carries operational information; only the client_status line duplicates the schema description.

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 an 11-parameter read-only list tool with no output schema, the description covers the non-obvious parameter semantics and the follow-up tool. Response shape is left to the schema's response_format field, which is acceptable given no output schema exists, but nothing explains default ordering or pagination behavior.

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 baseline is 3, but the description genuinely adds meaning: the schema for extra_filters explicitly defers ('see the tool description'), and the description supplies the allowed keys, the frequency_id enumeration (1 daily … 10 annually) and the differing date-range separators for next_send_between vs created_between/updated_between. It also restates client_status values. It does not add anything for the remaining nine parameters, so not a 5.

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 ('List recurring invoices from Invoice Ninja') plus the supported operations (filtering, sorting, pagination). It is clearly separable from invoiceninja_list_invoices and invoiceninja_get_recurring_invoice, though it never names those siblings explicitly.

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_recurring_invoice with an id from this list for the full record,' which tells the agent when this list tool is the right entry point vs. the get tool. It gives no exclusion guidance (e.g. when to prefer invoiceninja_search), so it stops short of a 5.

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