Skip to main content
Glama

Bsale MCP by usefulapi

List payments

bsale_list_payments
Read-only

List payments received (amount, date, payment type, document, office, user). Filter by payment date, document id, or document tax code plus folio number. GET /v1/payments.json.

Input Schema

NameRequiredDescriptionDefault
limitNoResults per page, 1-50 (default 25).
expandNo
numberNoDocument folio number; combine with code_sii.
offsetNoItems to skip (default 0). Pass the previous reply's next_offset.
paid_onNoOnly payments recorded on this date.
code_siiNoDocument tax code; combine with number.
document_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=true, so the safety profile is covered elsewhere. The description adds the concrete endpoint (GET /v1/payments.json) and the returned field set, but says nothing about pagination behavior beyond what the schema states or about result volume.

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?

Two tight sentences: the first covers output shape, the second covers filtering, and the endpoint closes it out. No filler and the returned-field list 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?

With no output schema, the description usefully compensates by naming the fields returned, and it covers the main filter dimensions. Minor gap: it doesn't mention pagination or expand, though those are schema-documented, so an agent can still call it correctly.

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 71%, so most parameters are already documented, and the description reinforces the paid_on, document_id and code_sii+number pairing. It adds no syntax or format detail beyond the schema and omits limit/offset/expand entirely, so it is a baseline-level contribution.

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 opens with a specific verb and resource ('List payments received') and enumerates the returned fields (amount, date, payment type, document, office, user), so the agent knows exactly what this returns. It does not explicitly differentiate itself from siblings like bsale_list_payment_types or bsale_list_documents, keeping it just short of a 5.

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?

It states the available filters (payment date, document id, tax code plus folio), which implies how to narrow results, but there is no guidance on when to choose this over sibling listing tools or when filters are required. Usage is inferable but not spelled out.

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.