Skip to main content
Glama

PayPing: list invoices

payping_list_invoices
Read-onlyIdempotent

Retrieve PayPing invoices with paging and filters for status, customer, or search text to review amounts, due dates, and payment states.

Instructions

List invoices: code, number, title, status (0 draft, 1 awaiting payment, 2 paid, 3 overdue, 4 cancelled), total (Toman), due and paid dates, customer.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoItems to return, 1-50 (PayPing's maximum is 50).
offsetNoSkip this many items (paging).
searchNoText to search for.
statusNo
customer_codeNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is covered. The description adds the returned field set and a status-code legend (0 draft ... 4 cancelled), which is useful context, but it never explains filtering behavior, paging semantics, or that the numeric status legend does not match the string enum in the schema.

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 front-loaded sentence that leads with the verb and resource, with no filler or redundant preamble. The inline status legend is slightly verbose but readable and earns its place as field semantics.

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

Completeness2/5

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

An output schema exists, so return values need not be spelled out — yet the description's entire content is a return-field list. For a five-parameter filtered list tool, the description omits how to filter, how to page, and when to prefer it over payping_get_invoice or payping_list_transactions, leaving real gaps.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is only 60%, and the description contributes zero parameter information — it never mentions limit, offset, search, status, or customer_code. It spends its budget on return fields instead, leaving the filtering interface under-documented relative to the coverage gap.

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 ('invoices') and enumerates the fields returned, so the agent knows this is a paginated collection read rather than a single-record fetch. It does not explicitly distinguish itself from siblings like payping_get_invoice or payping_list_transactions, but the list/get distinction is inferable from the name.

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 statement, no named alternatives, and no mention that the tool supports filtering by status, customer_code, or search despite those params existing. The agent must infer usage entirely from the name.

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