qbo_vendor_credits_create

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

No annotations are present, and the description only states 'Create' without detailing side effects, required permissions, or impact on vendor balances or AP accounts. It fails to disclose what happens to the vendor's outstanding balance or other behavioral traits.

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, efficient sentence with no wasted words. While concise, it could benefit from a second sentence to improve structure and context, but it remains appropriately sized given the schema's detailed parameter descriptions.

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?

Without an output schema, the description fails to mention return values, confirmation behavior, or validation checks. It also does not explain how a vendor credit differs from other transactions (e.g., bill credits), leaving the agent with incomplete context for correct invocation.

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 covers 100% of parameters with descriptions (e.g., VendorRef, Line, TxnDate), so the tool description adds no extra meaning beyond what the schema provides. The schema already explains parameter details adequately.

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 clearly states the action (Create) and resource (VendorCredit record), distinguishing it from get, update, and list siblings. However, it does not differentiate from other credit-related create tools like qbo_bills_create or qbo_purchases_create, missing context on when a vendor credit vs. a bill or purchase is appropriate.

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 tool versus alternatives such as bills or credit memos. The description does not mention prerequisites, business context, or situations where a vendor credit is appropriate, leaving the agent with no decision support.

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