logs_search

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

No annotations are provided, so the description must carry the full burden. It says 'search' but does not disclose whether this is a read-only operation, performance implications, output format, or any limits beyond maxMatches. It doesn't state what happens if no matches are found or whether it scans the entire file.

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?

A single sentence that conveys the core purpose without waste. It could be more specific but is appropriately brief.

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?

No output schema, no annotations, and the description doesn't mention what the tool returns (matching lines? count?), whether it's a read-only operation, or any performance considerations. For a log search tool, the agent needs to know the expected output format. The lack of behavior disclosure beyond 'search' leaves gaps.

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 covers the 'pattern' parameter with a description, but 'maxMatches' is undocumented in schema. The description doesn't explain that pattern is a regex (it repeats the schema) or clarify maxMatches semantics (e.g., maximum number of lines to return). Schema coverage is only 50%, so description should compensate but doesn't.

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 ('search') and resource ('logs/latest.log') and specifies that it matches lines by regex pattern. It distinguishes from sibling tools like logs_tail by focusing on regex search, though it doesn't explicitly contrast with them.

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 guidance on when to use this tool versus alternatives like logs_tail or server_status. It doesn't state any exclusions or prerequisites, leaving the agent to infer from the name and description.

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