freshbooks_list_invoices

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

The readOnlyHint annotation already establishes that this is a safe read operation. The description adds valuable behavioral detail beyond the annotation: pagination is supported, raw FreshBooks filter params are passed through verbatim, and the response contains items plus page/pages/total. This helps the agent understand the return envelope and filter behavior without an output schema.

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?

Three concise sentences, each earning its place: what the tool lists, how pagination/filtering behaves, and what the return envelope contains. No fluff or repetition of schema details.

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 paginated list operation with no required parameters and no output schema, the description covers scope, pagination, filtering, and the top-level response shape. It is complete enough for an agent to call correctly, though it could further detail default pagination behavior or the structure of each invoice item.

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 explains page, search, and per_page well. The description only reinforces that pagination and raw filter params exist without adding meaningful semantic details beyond the schema.

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?

States a specific action ('List') and resource ('invoices') for the authenticated FreshBooks account, clearly distinguishing it from single-invoice retrieval (freshbooks_get_invoice) and mutation tools like freshbooks_create_invoice or freshbooks_update_invoice. The scope is unambiguous.

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 this is the tool for retrieving multiple invoices rather than a single one, and it mentions pagination/filter support, which signals common list-operation usage. However, it does not explicitly state when to prefer this over freshbooks_get_invoice or any other sibling, nor does it mention exclusions like 'use get_invoice for a specific invoice ID.'

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