Skip to main content
Glama
Invoice Ninja MCP Server

Invoice Ninja MCP Server

by TETRA-2023

List payments

in_list_payments
Read-only

List Invoice Ninja payments with optional free-text search, client filter, status, sorting, and pagination to locate and review payment records.

Instructions

List payments with optional search/client filter.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "in_list_payments"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNoPage number for pagination.
sortNoSort directive, e.g. 'date|desc'.
filterNoFree-text search across the entity's searchable columns.
statusNoRecord state (default 'active'). 'all' also returns archived and deleted records.
per_pageNoRows per page (capped server-side, default 20).
client_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.0

TDQS

C2.9/5.0
Behavior2/5

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

Annotations declare readOnlyHint=true, so safety is covered and the bar is lower. The description adds only the existence of filters; it says nothing about pagination behavior, default record state, or server-side caps even though the schema shows defaults of 'active' and 20 rows per page.

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?

A single short sentence, front-loaded with the verb and resource. It is efficient, though it is arguably too terse for a six-parameter list tool.

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

Completeness3/5

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

With a read-only annotation, no output schema, and high schema coverage, the definition is barely adequate. It omits any note on default filtering to active records or result shape, which matters for a payments listing an agent may interpret as complete.

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 coverage is 83%, so the schema documents nearly all parameters already. The description implies filter and client_id semantics but adds no detail on status values, sorting syntax, or pagination beyond what the schema states. Baseline 3 applies.

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?

The description states a specific verb and resource ("List payments") matching the title, and mentions optional search/client filtering. It is distinguishable from siblings like in_list_invoices and in_get_invoice by the payments resource, though it doesn't explicitly contrast with them.

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

Usage Guidelines2/5

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

No when-to-use guidance, no exclusions, and no routing to alternatives such as in_get_invoice or in_list_invoices. The word "optional" hints at defaults but nothing tells the agent under what circumstances this tool should be selected.

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