create-vendor

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

The description provides no behavioral details beyond 'create'. With no annotations present, it fails to disclose side effects, authorization requirements, or constraints (e.g., whether duplicate vendors are allowed). The agent gains minimal insight into the tool's behavior.

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, short sentence, which is concise. However, it omits essential information about parameters, usage, and behavior, making it under-specified rather than efficiently compact.

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's complexity (nested vendor object, optional company) and lack of output schema, the description is too sparse. It does not mention return values, error conditions, or the impact of missing fields, leaving the agent with insufficient 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 schema has 50% parameter description coverage (only the 'company' field is described). The description adds no additional meaning for the 'vendor' object's properties, leaving many fields (e.g., CountrySubDivisionCode) without explanation. The description does not compensate for the schema's 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 clearly states the action ('Create') and the resource ('a vendor in QuickBooks Online'), making the tool's purpose immediately understandable. However, it does not differentiate from sibling tools like create_customer or create_account, which share the same verb and context.

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 over alternatives (e.g., create_customer, create_vendor_credit). There is no mention of prerequisites, typical use cases, or situations where this tool should be avoided.

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