List vendors

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

With no annotations provided, the description carries the full burden but only adds that listing is scoped to the working company and that search does substring matching. It does not disclose pagination behavior, default limits, or return format, but the read-only nature is reasonably implied by 'List'.

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 consists of two concise sentences with no redundant filler. The main purpose is front-loaded, and the search usage note is useful and directly actionable.

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?

The description, combined with the fully documented schema, is adequate for basic invocation of listing vendors. However, there is no output schema and no annotations, and the description does not mention default paging, response shape, or when to use bc_query for more flexible queries, leaving some gaps for a tool with four parameters.

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 has 100% description coverage for all four parameters, so the baseline is 3. The description adds only a redundant hint about search, which the schema already documents as 'Substring match on displayName', so no additional parameter semantics are provided.

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 uses the specific verb 'List' with the resource 'vendors' and scopes it to the working company, making the tool's purpose immediately clear. This distinguishes it from sibling tools like bc_list_customers and bc_list_items.

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 gives some parameter guidance ('Use `search` for a name substring match') and implies the tool is for listing vendors in the working company. However, it does not explicitly discuss when to prefer this tool over alternatives like bc_query or other list tools, nor does it state exclusions.

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