opn_security_audit

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

No annotations are provided, so the description fully carries the burden. It transparently describes the audit scope (11 areas), output structure (findings with severity, recommendations, compliance references), and implies it is a read-only assessment. It provides sufficient behavioral context.

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 well-structured with a clear title sentence, bullet-like list, and usage guidance. It is concise, front-loading the main purpose, and every sentence serves a purpose.

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 the complexity of a security audit covering multiple areas and the existence of an output schema, the description provides a complete picture of what the tool does and what the output contains (structured report with severity, recommendations, compliance). No 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?

The input schema has zero parameters (coverage 100%), so baseline is 4. The description adds no parameter-specific meaning, which is appropriate since there are none. It correctly focuses on tool behavior.

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 it runs a comprehensive security audit of OPNsense firewall, listing 11 specific security areas checked and mentioning compliance frameworks. It distinguishes itself from sibling tools (which perform individual management operations) by being a holistic audit tool.

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 explicitly states when to use the tool: 'assess the security posture, identify misconfigurations, or perform a routine health check.' While it doesn't explicitly list when not to use or alternatives, the unique audit purpose makes usage clear.

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