Skip to main content
Glama

Search payments

search_payments
Read-only

Find account payments by status, external reference, payer email, or date range, with sorting and paging. Returns compact summaries by default for quick review.

Instructions

Search payments on the account by status, external_reference, payer email, and date range. Returns paging info and compact summaries unless compact=false.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "search_payments"
  }
}

Input Schema

NameRequiredDescriptionDefault
sortNoSort fielddate_created
limitNoPage size (1-100)
rangeNoDate field that begin_date/end_date apply to. Defaults to date_created
offsetNoResults to skip
statusNoFilter by payment status
compactNoReturn a short summary per payment instead of the full payload
criteriaNoSort directiondesc
end_dateNoEnd of the range: ISO 8601 or NOW. Defaults to NOW when begin_date is set
begin_dateNoStart of the range: ISO 8601 or relative like NOW-7DAYS. Date-only values use 00:00 UTC
payer_emailNoFilter by payer email
external_referenceNoYour own order reference sent when the payment was created

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds useful behavior the schema does not state: the response includes paging info, and results are compact summaries unless compact=false. It omits auth requirements, result caps, or what happens when zero matches are found.

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 sentences, zero filler, filters stated up front and the return-shape caveat second. Minor gap: the second sentence could be tightened by naming 'paging info' fields, but nothing is redundant.

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?

For an 11-parameter, multi-filter search tool with no output schema and no required params, the definition covers purpose and default compactness but leaves the return structure mostly implicit. It is adequate to invoke correctly but thin on what the caller gets back and how large result sets behave.

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% with 11 fully documented parameters including enums and defaults, so the description's listing of four filter families adds little beyond the schema. No extra semantics (e.g. how begin_date/end_date interact with range, or how status filters combine) are provided.

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 on the account') and enumerates the filter dimensions (status, external_reference, payer email, date range). It does not explicitly distinguish itself from the nearest sibling, get_payment (single-payment fetch), so an agent must infer the list-vs-single distinction from the names alone.

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 filter-based phrasing implies this is the tool for lookup by status/reference/email/date, which is real usage context, but there is no explicit 'use X when'/'use get_payment instead when' guidance or statement of prerequisites. Usage must be inferred rather than read.

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