create_vendor_credit

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

The description notes that the tool performs automatic name-to-ID lookups and returns credit details plus a QuickBooks link, which adds useful behavioral context. However, it does not disclose whether the operation is destructive, idempotent, or requires specific permissions, leaving some gaps given the lack of annotations.

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 extremely concise: two sentences that front-load the primary action and key features. Every sentence adds critical information without redundancy or fluff.

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 (10 parameters, no output schema, no annotations), the description explains the basic concept and return value adequately. However, it omits details like error handling, the default for 'draft', or how to structure lines more precisely, leaving some gaps for a fully informed agent.

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 already covers 100% of parameters with descriptions, so the baseline is 3. The description enhances understanding by explaining that name fields are for automatic ID lookup and that lines represent credit amounts applied to expense accounts, adding value 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?

The description clearly states the tool's action ('Create a vendor credit') and specifies the key resource and behavior: accepting names with automatic ID lookup and representing lines as credit amounts applied to expense accounts. This distinctly sets it apart from sibling tools like create_bill or create_expense, which have different purposes.

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 does not provide explicit guidance on when to use this tool versus alternatives (e.g., create_bill for vendor payments). While the name and context imply its use for vendor credits, an AI agent would benefit from additional context like 'Use this when you need to record a credit from a vendor, not an expense or bill.'

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