Search detection rules

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

The annotations already declare readOnlyHint, idempotentHint, and destructiveHint, so the safety profile is covered. The description adds no additional behavioral details such as pagination behavior, permissions, or rate limits beyond the read-only search intent.

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?

The description is three sentences and every sentence adds value: it defines the tool, lists concrete use cases, and gives examples. No fluff or redundant phrasing.

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 has 12 parameters and a detailed schema, and the description covers primary use cases while parameter descriptions clarify filtering semantics. It is complete enough for effective use, though it could mention that wazuh_get_rule is the more targeted option for a single known rule.

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?

Parameter descriptions are helpful and go beyond raw schema types, e.g., level supports '10' or '10-15', compliance_value explains omitting it matches any rule in the framework, and query provides a raw filter example. With 83% schema coverage, most parameters are well explained, though a couple like offset and limit rely on defaults rather than added semantics.

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 'Search the manager's ruleset' and gives concrete use cases like explaining why an alert fired, finding compliance-related rules, and auditing high-severity rules. It is distinguishable from siblings like wazuh_get_rule, though it does not explicitly contrast itself with single-rule retrieval.

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?

The description provides clear when-to-use guidance with three specific scenarios: alert explanation, compliance mapping, and high-severity auditing. It does not explicitly mention when not to use the tool or point to alternatives such as wazuh_get_rule for individual rule details.

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