Skip to main content
Glama

list_payments

Retrieve payment records from FreshBooks to track transactions, monitor cash flow, and manage financial data for accounting purposes.

Instructions

List all payments.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNo
per_pageNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The implementation of the list_payments MCP tool which fetches a list of payments via the Freshbooks client and returns a summarized string.
    async def list_payments(
        page: int = 1,
        per_page: int = 25,
    ) -> str:
        """List all payments."""
        result = await client.accounting_list("payments/payments", page, per_page)
        return _summarize_list(result, "payments", ["id", "invoiceid", "amount", "date", "type"])
Behavior2/5

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

With no annotations provided, the description carries full burden but only states the action without disclosing behavioral traits like pagination behavior (implied by parameters but not described), authentication needs, rate limits, or what 'list' returns. It's minimal and lacks operational context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely concise with a single sentence, 'List all payments,' which is front-loaded and wastes no words. It's appropriately sized for a simple tool, though this brevity contributes to gaps in other dimensions.

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?

Given low complexity, 2 parameters with 0% schema coverage, no annotations, but an output schema exists, the description is incomplete. It doesn't explain the pagination behavior hinted by parameters or what the output contains, though the output schema may cover return values. It's minimally adequate but with clear gaps.

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, but it adds no meaning beyond the schema. Parameters 'page' and 'per_page' are undocumented in the description, though their presence implies pagination. Baseline is 3 as the schema provides structure, but the description fails to explain parameter roles.

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

Purpose3/5

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

The description 'List all payments' states a clear verb ('List') and resource ('payments'), but it's vague about scope and doesn't differentiate from sibling tools like 'get_invoice' or other list tools. It lacks specificity about what 'all' means in context.

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?

No guidance is provided on when to use this tool versus alternatives like 'get_invoice' for specific payment details or 'list_invoices' for related resources. The description offers no context about prerequisites or exclusions.

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/AlexlaGuardia/MCP-Freshbooks'

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