Skip to main content
Glama

Invoice Ninja MCP by usefulapi

List clients

invoiceninja_list_clients
Read-only

List clients with balances and contacts, optionally searched by name, email or number. Invoice Ninja: GET /api/v1/clients.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoOnly clients whose name matches.
pageNoPage number, starting at 1.
sortNoSort as "column|asc" or "column|desc", e.g. "number|desc" or "balance|desc".
emailNoOnly the client with a contact at this email.
filterNoFree-text search across name, id number, contact names/emails/phones and custom fields.
numberNoOnly the client with this client number.
statusNoComma-separated record state: active, archived, deleted (e.g. "active"). Omit for all.
balanceNoBalance comparison "op:value", op one of lt, lte, gt, gte, eq, e.g. "gt:0".
per_pageNoRecords per page, 1-100 (API default 20).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observed

TDQS

A3.5/5.0
Behavior3/5

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

readOnlyHint=true already establishes this is a safe read. The description adds that results carry balances and contacts, which is useful context beyond the annotation, but says nothing about default page size, sorting defaults, or the shape of the paginated response.

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?

Two tight sentences, front-loading the resource and returned fields before the filter options. The trailing API endpoint reference is slightly redundant but harmless and aids traceability.

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 no output schema, the description usefully names what each record contains (balances, contacts) so the agent knows the return payload. Missing only pagination and ordering defaults for a nine-parameter list tool.

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 description coverage is 100%, so all nine parameters are already documented in the schema with examples (e.g. 'balance' operator syntax, per_page range). The description only echoes name/email/number search, adding nothing beyond the structured data; baseline 3 is correct.

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 (List) and resource (clients) and names the fields returned plus the three searchable dimensions. It clearly separates itself from create/update/get_client in intent, though it doesn't explicitly state the difference from get_client.

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

Usage Guidelines3/5

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

The phrase 'optionally searched by name, email or number' implies when the filters apply, but there is no explicit guidance on when to use this over invoiceninja_get_client for a single lookup, nor any mention of pagination limits or rate limits.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.