quickbooks_list_vendor_credits

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

No annotations are provided, and the description does not disclose behavioral traits such as read-only status, pagination, filtering, or scope of results. The routing details do not compensate for missing behavioral context.

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 short but front-loads technical routing information that is not the primary purpose. It lacks a clear statement of what the tool does, wasting space on implementation 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?

Given the single parameter and lack of output schema description, the tool is incomplete. It does not cover return format, pagination, or filtering, which are typical for list operations. The sibling tools indicate many similar QuickBooks list operations, but no differentiation is provided.

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 single parameter 'arguments' is a string with no description of its expected structure or content. The schema coverage is 0%, and the description adds no information about how to format the arguments for the connector operation.

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 only provides technical routing details and does not explicitly state that the tool lists vendor credits. The name hints at the purpose, but the description fails to articulate the core function.

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?

No guidance is given on when to use this tool versus other QuickBooks list tools (e.g., list_bills, list_invoices). There is no mention of prerequisites or alternative tools.

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