veroq_search_suggest

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

No annotations are provided, so the description carries the full burden. It describes return types (headline and entity suggestions with details), cost (1 credit), and constraints, offering good behavioral insight for a read-like operation.

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?

Description is well-structured with labeled sections (WHEN TO USE, RETURNS, COST, EXAMPLE, CONSTRAINTS). Every sentence adds value, and it is front-loaded for quick understanding.

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 simple schema (one parameter, no output schema), the description covers purpose, usage, return details, cost, and constraints comprehensively, leaving no significant gaps.

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?

Schema coverage is 100% with the parameter 'query' described as 'Partial search query (minimum 2 characters).' The description adds an example but does not provide additional meaning beyond the schema, hence baseline 3.

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?

Description starts with 'Get search autocomplete suggestions — matching headlines and entities for a partial query,' clearly stating the verb and resource. It distinguishes from sibling 'veroq_search' by advising to use it before running a search.

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?

Explicitly states when to use: 'To find the right search terms before running veroq_search.' Includes constraints (minimum 2 characters) and an example. Lacks explicit when-not-to-use scenarios, but the guidance is clear and practical.

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