search_documents

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

No annotations exist, so the description must carry full behavioral disclosure. It reveals that the tool searches 'inside all documents' (implying potentially broad scope) and returns line numbers, but lacks details on case sensitivity, regex support, performance implications, or whether it is read-only. Minimal transparency beyond core functionality.

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 sentences with no fluff. The structure is straightforward but could be improved by separating the parameter description from the main purpose sentence. Still, it's efficient for a simple tool.

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?

Given a single parameter and existence of an output schema, the description adequately states return format (matching lines with line numbers). However, it omits behavioral context like search scope limitations, performance impact, or how results are ordered. Sufficient for basic use but not fully complete.

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 defines 'query' as 'the search term or keyword to find', but this adds little beyond the parameter name. No format, syntax, or usage constraints are explained, leaving the agent with insufficient semantic guidance.

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 the verb 'Searches' and the resource 'documents', and specifies the result 'matching lines with line numbers'. This distinguishes it from siblings list_documents and read_document, which serve different purposes.

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?

No explicit guidance on when to use this tool versus siblings or alternatives. The purpose implies usage for keyword searching, but no exclusions or context comparing with list_documents or read_document are provided.

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