wazuh_compliance_report

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

No annotations provided, so description must carry behavioral info. It accurately describes output as a report without side effects. Could mention it does not modify state, but implied by 'report'.

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?

Three sentences: action, output details, use case. Every sentence adds distinct value with no redundancy. Front-loaded with key info.

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?

With an output schema present, description does not need to detail return format. It names key fields (agent, scores, failed-check counts, policy). Missing mention of data freshness or limits, but sufficient for decision-making.

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 100% with a parameter description clarifying comma-separated agent IDs/groups. The tool description adds minimal extra meaning beyond that; baseline score holds.

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?

Clearly specifies the tool generates a compliance summary report and details what it shows (SCA enabled, scores, failed-check counts grouped by policy). Distinct from siblings like wazuh_sca_checks which focus on individual checks.

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?

States 'Ideal for audit prep' giving a clear use case, but does not explicitly mention when to use alternatives like wazuh_sca_status or wazuh_sca_checks for finer detail.

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