yara_scan

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

Declares 'Read-only' and output format, but no annotations provided. Lacks details on parameter constraints (e.g., 'target' format, 'rules_text' validity) and error behavior.

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, 48 words. Front-loaded purpose and output, second sentence adds use cases and read-only flag. No 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?

Output schema exists, so return values are covered. However, parameter details are missing and no prerequisites or edge cases are described. Adequate but not thorough.

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 coverage is 0% and description only restates parameter names ('rules_text is the YARA rule source') without adding format, examples, or constraints.

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?

Clear verb 'sweep' and resource 'evidence object' with specific output 'matches with offsets'. Distinguishes from siblings like 'mem_cmdline' or 'fs_find' as it is dedicated to YARA scanning.

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?

Explicitly states use cases: 'hunt webshell signatures, packer stubs, or campaign IOCs'. Does not mention when not to use or alternatives, but gives clear context.

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