Skip to main content
Glama

list_sales_payment_links

Read-onlyIdempotent

List up to 100 payment links, including whether they accept payments and their received totals. Filter by ID or whether the link is active. Amounts are minor units in the link currency.

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": "list_sales_payment_links"
  }
}

Input Schema

NameRequiredDescriptionDefault
idNo
activeNo
offsetNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

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, non-destructive, closed-world behavior, so the safety profile is covered. The description adds genuinely new facts — the 100-item cap, the returned fields, and that amounts are minor units in link currency — but omits how to page past the cap despite an offset parameter existing.

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?

Three short sentences, front-loaded with the resource and cap, then filters, then the unit convention. No filler, though the unit note could be folded more tightly into the field listing.

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 no output schema, the description does some return-value work (active status, received totals, minor units). For a filtered list tool with a hard result cap, the missing explanation of offset-based pagination and of ordering is a real gap.

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 0%, so the description must compensate. It explains the semantics of 'id' and 'active' (filtering) but says nothing about the 'offset' parameter, leaving the pagination mechanism — critical given the stated 100-record limit — undocumented in both schema and description.

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?

Specific verb+resource ('List ... payment links') with the result cap and returned fields stated up front. It does not name a sibling to distinguish itself from (e.g., list_payment_link_payments), 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 Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description names the two filter axes (ID, active status), which implies how the tool is used, but it never states when to reach for this versus list_payment_link_payments or create_sales_payment_link, and offers no exclusions or preconditions.

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.

Resources