vyos_docs_search

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

With no annotations, the description carries the full burden. It states it returns results ranked by relevance but does not disclose pagination, error handling, rate limits, or authentication requirements, which limits transparency.

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 concise, with the purpose in the first line, then a one-liner about results, a pointer to the sibling, and a brief parameter list. Every sentence earns its place without redundancy.

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 well-rounded given the context: parameters are explained, a sibling tool is referenced, and an output schema exists (though not shown). It could mention potential limitations like result count but is otherwise complete for a search tool.

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?

Since schema description coverage is 0%, the description effectively explains both parameters: 'query' with examples like 'firewall group' and 'max_results' with a default value. This adds significant meaning beyond the bare schema.

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 it searches VyOS documentation for a topic, returns matching doc pages ranked by relevance, and distinguishes itself from the sibling vyos_docs_read by directing users to use that tool for fetching full content.

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 explicitly mentions using vyos_docs_read to fetch full content, implying that this tool is for searching only. This provides clear context, though it lacks explicit when-not-to-use or alternative scenarios beyond the sibling.

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