freshbooks_list_payments

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

Annotations already indicate readOnlyHint=true, so the safe-read profile is covered. The description adds useful behavioral context: it supports pagination, passes raw FreshBooks filters verbatim, and returns items plus page/pages/total—details not encoded in the 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?

Two sentences with no filler. The core action is front-loaded, and the second sentence efficiently covers pagination, filter passthrough, and the return shape.

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?

There is no output schema, so the description correctly provides a minimal return contract ('items plus page/pages/total'). The parameters are fully documented in the schema, and the read-only nature is covered by annotations. It lacks error-case or default-pagination detail, but for a list tool this is not a major gap.

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 description coverage is 100%, so the schema already documents page, per_page, and search well. The description's mention of pagination and raw filter params mirrors the schema without adding new meaning; it stays at the baseline because no additional parameter nuance is provided.

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 uses a specific verb ('List') and resource ('payments') and scopes it to the authenticated FreshBooks account. It distinguishes well from siblings like freshbooks_get_payment (single item) and freshbooks_record_payment (write operation).

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 listing usage with pagination and raw filter params, but it does not explicitly state when to choose this over freshbooks_get_payment or mention any exclusions. The verb and context make the primary use clear, but no direct alternative guidance is given.

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