quickbooks_query

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

With no annotations, the description carries the full burden of behavioral disclosure. It mentions routing through /api/tools/invoke with JWT scope, but does not specify whether the operation is read-only, mutating, or what side effects (if any) occur. Critical behavioral traits like rate limits or required permissions are omitted.

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 very concise (two sentences plus a parameter line), but it is too sparse to be considered well-structured. It could use more organized formatting, such as listing key behaviors or constraints, while remaining concise.

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 complexity of a generic Quickbooks query tool and the absence of annotations, the description is incomplete. It does not explain what queries are possible, how to structure the arguments JSON, or any constraints like pagination. The presence of an output schema partially mitigates the need for return value documentation, but the overall context is insufficient for effective agent 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?

The single parameter `arguments` is described as a 'JSON string of arguments for the connector operation,' but the description does not elaborate on the expected structure, allowed fields, or constraints. Since schema coverage is 0%, the description should compensate but fails to provide meaningful semantic detail.

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 states it is a Quickbooks connector operation `query`, but does not clarify what types of queries are supported (e.g., OData, SQL, or specific API endpoints). The purpose is somewhat clear but lacks specificity to distinguish it from more specialized sibling tools like quickbooks_report or quickbooks_list_accounts.

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 provided on when to use this generic query tool versus more specific alternatives (e.g., quickbooks_list_invoices, quickbooks_get_entity). The description does not mention any prerequisites, limitations, or recommended usage context.

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