mcquest_search_docs

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

No annotations exist, so the description carries the full burden. Explicitly labeling it 'READ ONLY' and describing the outputs (exact file paths, line numbers, matching lines, limited surrounding context) gives the agent actionable behavioral expectations beyond the tool name.

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 short sentences with no filler, and the safety-relevant 'READ ONLY' is front-loaded. Every sentence contributes.

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 tool's output and read-only behavior are clear, and the output schema plus default-valued parameters fill some gaps. However, with six parameters at 0% schema description coverage, the description should explain more about how path, file_pattern, context_lines, and max_results shape the search.

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 for parameter meanings, but it mentions only pattern ('regex or text pattern') and only indirectly 'limited surrounding context'. It leaves path, max_results, file_pattern, context_lines, and case_sensitive unexplained beyond their schema names and defaults.

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 names a specific verb and resource: it Searches Markdown documentation using a regex or text pattern. It also enumerates the return content, and the phrase 'Prefer this for finding specific topics across all documentation' distinguishes it from generic doc listing/reading siblings.

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 provides a clear use case: 'Prefer this for finding specific topics across all documentation.' It does not explicitly name sibling alternatives or state when not to use it, but the guidance is clear enough to route an agent to the correct tool.

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