search_vendor_credits

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

The description only says 'Search', implying a read-only operation, but does not disclose if it returns a list, pagination behavior, or any side effects. Since no annotations are provided, the description carries the full burden of behavioral disclosure and fails to provide meaningful detail.

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 sentence, making it concise. However, it is too sparse and lacks structured information (e.g., behavior, parameters). While it earns its place, it does not effectively front-load key details for an AI agent.

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 no output schema, the description should explain what the search returns (e.g., list of vendor credits, total count). It also fails to differentiate from 'get_vendor_credit' or align with sibling search tools. The context signals (2 params, 50% coverage) highlight gaps that the description does not address.

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 provides descriptions for 'vendor_ref' and 'limit' inside the 'params' object, but the 'params' object itself lacks a description. The tool description ('Search for vendor credits') adds no parameter meaning beyond the schema. With 50% schema coverage at top level, the description should compensate but does not.

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 ('Search') and resource ('vendor credits in QuickBooks Online'). However, it does not differentiate from sibling tools like 'get_vendor_credit' or 'create_vendor_credit', which could confuse an AI agent about which tool to use for listing vs. retrieving a single credit.

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 like 'get_vendor_credit' or other search tools. There are no exclusions, prerequisites, or context about using vendor_ref or limit parameters.

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