freshbooks_list_payments

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

The description adds behavioral context beyond the readOnlyHint annotation: it mentions raw filter params passed verbatim, pagination, and return shape (items/page/pages/total). This discloses non-obvious behavior (verbatim passing, return structure), adding value beyond annotations.

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

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

The description is three short sentences, each adding distinct information: purpose, features, output. Front-loaded with the verb and resource, no redundant or filler content.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a list operation with no output schema, the description covers key aspects: what it lists, pagination, filters, and return fields. It omits error handling or rate limits, but given the simplicity and annotations, it is sufficiently complete for expected use.

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

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

Schema coverage is 100% with descriptions for page, search, and per_page. The description's mention of pagination and 'raw FreshBooks filter params' aligns with schema but does not add new parameter-level meaning beyond what the schema already provides.

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

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

The description clearly states 'List payments for the authenticated FreshBooks account' with a specific verb and resource. It distinguishes itself from sibling tools like get_payment (single payment) and list_invoices (different resource).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

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

The description implies usage: list payments with pagination and filter params, but does not explicitly exclude alternatives like get_payment. It gives clear context that this is the list operation for payments, though no explicit when-not-to-use guidance.

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