Skip to main content
Glama

list_pull_payments

Retrieve all pull payments for a store, including donations, subscriptions, and payroll setups, with optional archived entries.

Instructions

List all pull payments (donations, subscriptions, payroll) for the store.

Args: include_archived: Whether to include archived pull payments. Default: False.

Pull payments allow you to set up payment links that others can claim. Common uses: donations, recurring payouts, payroll.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
include_archivedNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior3/5

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

With no annotations provided, the description must carry the full burden of behavioral disclosure. It successfully documents the archival filtering behavior (default false) and store-level scope, but fails to confirm the read-only nature of the operation or mention pagination/response limits that agents should be aware of when listing resources.

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?

The description is appropriately front-loaded with the core action, followed by parameter details and conceptual explanation. The structure mixing narrative with an 'Args:' section is slightly unconventional but efficient. No sentences are redundant, though the conceptual explanation of pull payments could arguably be separated from the tool invocation description.

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?

Given the low complexity (single boolean parameter) and existence of an output schema, the description is sufficiently complete. It successfully explains the domain-specific term 'pull payments' which is critical for correct tool selection, and covers the parameter gap left by the schema. A perfect score would require explicit read-only confirmation or pagination notes.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 0% description coverage (only title and type). The description compensates by documenting the single parameter include_archived with its semantics ('Whether to include archived pull payments') and default value ('False'). The 'Args:' formatting is slightly technical but functionally adequate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with the specific verb 'List' and clear resource 'pull payments', immediately establishing the tool's function. The parenthetical examples '(donations, subscriptions, payroll)' effectively distinguish this from sibling tools like list_invoices or list_payment_requests by clarifying the specific use cases for pull payments.

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?

While the description explains what pull payments are conceptually ('payment links that others can claim'), it lacks explicit guidance on when to use this tool versus siblings like create_pull_payment or list_payouts. It provides domain context but no explicit when-to-use or when-not-to-use directives.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/ThomsenDrake/btcpay-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server