Skip to main content
Glama

Brightpearl MCP by usefulapi

Search customer payments

brightpearl_search_customer_payments
Read-only

Search payments received against sales orders; each row has paymentId, transactionRef, paymentMethodCode, paymentType, orderId, currencyCode, amountAuthorized, amountPaid, paymentDate, createdOn, journalId. GET /accounting-service/customer-payment-search.

Input Schema

NameRequiredDescriptionDefault
order_idsNoOnly payments on these orders (one or more ids).
page_sizeNoRows per page, 1-500 (default 25).
created_toNoCreated: on or before this day (yyyy-mm-dd, whole day included) or ISO 8601 date-time with timezone.
payment_toNoPayment date: on or before this day (yyyy-mm-dd, whole day included) or ISO 8601 date-time with timezone.
payment_idsNoOnly these payments (one or more ids).
created_fromNoCreated: on or after this day (yyyy-mm-dd) or ISO 8601 date-time with timezone.
first_resultNoPosition of the first row to return, from 1 (default 1). Pass the previous reply's next_first_result for the next page.
newest_firstNoNewest (highest id) first. Default: oldest first.
payment_fromNoPayment date: on or after this day (yyyy-mm-dd) or ISO 8601 date-time with timezone.
payment_typeNoPayment type, for example RECEIPT, CAPTURE, AUTH.
transaction_refNoThe payment gateway's transaction reference.
payment_method_codeNoPayment method code (brightpearl_list_payment_methods).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.2/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. The description adds useful value by enumerating the returned fields (no output schema exists) and by giving the underlying endpoint, but it says nothing about paging behavior, result caps, or whether an unfiltered call returns everything.

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 compact clauses: what it searches plus the row shape, then the endpoint. Front-loaded and waste-free, though the field enumeration is dense and could be a structured return description instead.

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?

For a 12-parameter, zero-required, read-only search tool with no output schema, the description does cover output shape, which is the main gap the schema leaves. Filtering strategy (all params optional, results could be huge) and pagination contract are left to the schema, which mostly handles them.

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 every one of the 12 parameters is already documented with format and default details (date handling, page_size 1-500, first_result/next_first_result paging). The description adds no parameter-specific semantics, so the 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+resource plus scope: "Search payments received against sales orders", and enumerates the returned row fields, which lets an agent distinguish it from sibling search tools like brightpearl_search_orders. It does not explicitly name an alternative, but the resource is unambiguous.

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?

The description gives no when-to-use context, no prerequisites, and no alternatives (e.g., search_orders vs. this tool, or how to page through results). The only navigation hint towards a sibling, brightpearl_list_payment_methods, appears in the schema, not the description.

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.