search_docs

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

The annotations already declare readOnlyHint=true, so the risk profile is covered. The description adds some behavioral context, notably one-result-per-section behavior and how the symbols parameter matches code snippet identifiers, but it does not describe pagination, output structure, or any special matching behavior for the regular query.

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?

Two succinct sentences convey the tool's domain, content scope, result granularity, and a special parameter behavior. Every clause earns its place and there is no fluff or resuppLI.

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 is usable for a read-only documentation search, but context is incomplete: the category and repository parameters are undefined, there is no guidance about how the tool relates to the sibling search tools, and the meaning of 'one result per section' is not expanded enough to set why that limitation matters.

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 description coverage is 0%, so the description must compensate. It only explains the symbols parameter; query, limit, category, and repository receive no semantic explanation beyond their raw names and defaults. This leaves a significant gap for an agent choosing how to populate the 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 uses a specific verb 'Search' and identifies a domain/resource, 'VHDL-related documentation', while enumerating content types: coding standards, design guides, conventions. It is clear, though it does not explicitly differentiate itself from the sibling tool search_vhdl.

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 communicates a search scope but does not indicate when to use this tool versus alternatives like search_code, search_knowledge, or the similarly named search_vhdl. There are no explicit conditions or exclusion criteria provided.

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