opn_wireguard_status

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

Discloses return type (dict) and key fields (endpoints, transfer stats). Requires plugin is noted. No annotations, so description carries full burden; it sufficiently conveys a read-only, side-effect-free operation.

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: purpose, usage context, return info plus note. Front-loaded, no redundancy, every sentence adds value.

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?

For a status tool with no parameters and an output schema, description covers purpose, usage, return structure, and a prerequisite. No gaps given the tool's simplicity.

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?

No parameters exist; schema coverage is 100% vacuously. Description adds no parameter info, but baseline for zero parameters is 4. No additional value needed.

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?

Description starts with 'Get WireGuard VPN tunnel and peer status', a specific verb-resource pair. Lists concrete outcomes (health, handshake times, bytes, endpoints), distinguishing it from sibling status tools like opn_openvpn_status or opn_ipsec_status.

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 this when you need to check WireGuard tunnel health...', providing clear context. Also notes plugin requirement. Lacks explicit when-not-to-use but differentiation from siblings is clear.

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