quickbooks_customers

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

No annotations are provided, so the description must convey behavioral traits. It only states 'Query', leaving out important details like read-only nature, authentication requirements (implicit from required params but not stated), rate limits, or pagination behavior. This is insufficient for an informed agent.

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 a single sentence, which is concise but under-specified. It communicates the basic purpose without waste, but lacks detail that would make it more useful. It is not excessively long, but it is too brief for the tool's complexity.

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?

Given the tool has 6 parameters and no output schema, the description is incomplete. It does not explain the return format, how to use filters, or any default behavior. The agent would need to rely solely on the schema and external knowledge.

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?

The input schema has 50% description coverage, with some parameters (like limit, offset, sandbox) lacking descriptions. The tool description does not add any parameter semantics or clarify how to use the 'where' clause, limit, or offset. It fails to compensate for the schema gaps.

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 'Query QuickBooks Online customers' uses a specific verb and resource, clearly indicating the tool's function. However, it does not differentiate from sibling QuickBooks tools like quickbooks_invoices or quickbooks_items, which also have generic descriptions. The name itself helps, but the description could be more explicit about the type of query (e.g., list, search).

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 provides no guidance on when to use this tool versus alternatives, such as other QuickBooks tools. No prerequisites, exclusions, or context about the use case are mentioned.

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