mockzilla_docs_search

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

With no annotations, the description carries the burden of behavioral disclosure. It clearly states this is a search operation that returns best-matching sections and gives the exact fields returned. It also notes the docs describe the current product, which is useful context. It doesn't mention edge cases like empty results, but for a read-only docs search this is adequate.

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?

Three concise sentences, each earning its place: what the tool does, what it returns, and when to use it. The key information is front-loaded in the first sentence.

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 low-complexity tool with two parameters and no output schema, the description covers purpose, return shape, and usage context. It could be slightly stronger by explicitly pointing to mockzilla_docs_read for fetching full sections, but the phrase 'so you know which topics to read' implies the next step.

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 documents the query parameter with an example. The description reinforces that search is by keyword but adds no new meaning. The limit parameter is not mentioned in the description, though its name, default, and bounds in the schema make its role reasonably inferable.

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 states a specific verb and resource ('Search the Mockzilla docs by keyword') and defines the return shape ({topic, title, heading, snippet}). It also differentiates itself from mockzilla_docs_topics by explicitly naming when that sibling should be preferred, so an agent can distinguish the tools.

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?

It gives an explicit when-to-use rule: use this when no topic title from mockzilla_docs_topics clearly fits. It also gives a behavioral directive to answer from docs rather than memory, which clarifies the tool's role in the workflow.

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