Skip to main content
Glama

Sellsy MCP by usefulapi

Search payments

sellsy_search_payments
Read-onlyIdempotent

Search payments by status (pending/confirmed/rejected/failed/refund) or related company/individual. Needs payments.read.

Input Schema

NameRequiredDescriptionDefault
embedNoRelated objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"].
fieldNoOnly return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small.
limitNoRecords per page, 1-100 (default 25).
orderNoSort field: id, paid_date.
offsetNoPaging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.
filtersNoSearch filters as an object. Unknown keys are refused by Sellsy. Keys: status ["pending"|"confirmed"|"rejected"|"failed"|"refund"], related_objects [{type,id}].
directionNoSort direction (default asc).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent and non-destructive, so the safety profile is covered. The description adds one genuinely useful operational fact — the payments.read scope requirement — but says nothing about paging behavior or result shape beyond what the schema already documents.

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 short sentences with no filler, and the searchable facets are front-loaded before the auth requirement. Efficient, though the second sentence is a bare credential note rather than structured guidance.

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 7 parameters, nested filters, and no output schema, the description should at least sketch what a result looks like (payment record fields, pagination envelope) and how it differs from list_invoice_payments. The rich schema compensates for parameter gaps, but the return-shape and sibling-routing gaps remain.

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 100%, so every parameter is already documented in detail, including status enum values and paging semantics. The description only restates the status values and the company/individual filter idea, adding no syntax or format detail beyond the schema; 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?

States a specific verb and resource (search payments) plus the two axes it searches on (status, related company/individual), which is clear beyond the title. It does not differentiate from the sibling sellsy_list_invoice_payments, so an agent cannot tell from the description which of the two to pick.

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?

Usage is only implied: it names the filters available, which hints that this is used when narrowing payments by status or counterparty. There is no explicit when/when-not guidance and no mention of the alternative sibling list tool, leaving the choice to inference.

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.