search_vhdl

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

Annotations already mark this as read-only, and the description adds valuable behavioral details: the search is hybrid semantic/exact, symbols restrict to chunks referencing identifiers, and category/repository narrow results. It does not describe index-freshness limitations, but output schema and read-only promise reduce that burden.

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 front-loaded with purpose, then dives into parameter semantics with backtick highlighting and a concrete `symbols` example. Every sentence contributes value, though the combination of hybrid-search jargon and parameter explanations makes it dense rather than simple.

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?

For a read-only search tool, the description covers the core behavior and all non-obvious filters. The presence of an output schema means the return-value structure is already handled externally. A brief note on indexed-repository freshness or when to prefer search_code would improve completeness, but this is enough 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?

Given the input schema has 0% description coverage, the description compensates for `symbols`, `category`, and `repository` with concrete semantics and a useful example. `query` is naturally explained by the search purpose, and `limit` has an obvious default and title, leaving no major ambiguous parameters.

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 opens with a clear action and resource: 'Search VHDL source: entities, architectures, processes, packages, functions'. It also distinguishes the tool from generic search siblings by confining it to VHDL and promising a hybrid semantic/exact-identifier behavior.

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 VHDL-specific phrase immediately signals when to use the tool—when searching VHDL source constructs—but no alternative tools or exclusions are named. This is clear context, yet lacks the explicit sibling routing that would earn a 5.

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