netsuite_search_vendors_by_name

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

With no annotations provided, the description carries the full burden of disclosure. It adds important behavioral details beyond the schema, such as using RQL on the vendor list, enriching results with full vendor details, and supporting case-insensitive partial matching. This goes beyond a minimal statement but could further disclose pagination or rate limit 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 two sentences, both earning their place. The first sentence states the core purpose and matching behavior; the second explains internal mechanism and optional filtering. No redundancy or filler.

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 there is no output schema, the description compensates by stating that it enriches with full vendor details. It covers the search scope and optional filter, but it does not explicitly mention the default limit behavior or return format (e.g., list vs. single record). This is reasonable for a search tool but leaves a small gap.

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 already provides 100% coverage for all three parameters, so the baseline is 3. The description adds meaningful semantics for the 'name' parameter by specifying it's case-insensitive and partial-match, which the schema's 'Vendor name to search for' does not convey. It also mentions the optional subsidiaryId filter, but limit semantics remain schema-covered.

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 verb 'Search', the resource 'NetSuite vendors', and the specific scope 'by name' with matching semantics (case-insensitive, partial match). This distinguishes it from sibling tools like netsuite_get_vendors, which likely returns full lists rather than name-based searches.

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 implies usage when you need to find vendors by a name fragment, but it does not explicitly state when to use this tool versus alternatives, nor does it mention any when-not scenarios. The context is clear but lacking explicit exclusions or comparisons.

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