getGatewayWanStatus

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

Lists specific return values (WAN IP, DNS, uptime, etc.) indicating read-only nature. No annotations present, so description carries full burden; missing details on errors or rate limits but sufficient for typical use.

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: first defines purpose, second provides actionable prerequisite. 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?

No output schema, but description lists key return fields. Implies multiple WAN ports but doesn't specify output format (list vs object). Adequate for 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?

Schema covers 100% of parameters with descriptions; description adds no new param meaning beyond schema (e.g., the prerequisite is already in gatewayMac description).

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 'Get' and resource 'WAN port status and connectivity information'. Distinguishes from siblings like getGatewayLanStatus and getGatewayDetail by specifying WAN focus.

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?

Provides explicit prerequisite 'Use listDevices to find the gatewayMac.', but lacks when-not-to-use guidance or comparison with alternative tools.

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