snmp_device_overview

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

Describes what data it retrieves (system MIB, interface counts, uptime) and that it's a single request. However, with no annotations, it does not disclose potential side effects, rate limits, or authentication nuances beyond the community string.

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?

Concise two-paragraph structure with front-loaded purpose and clear parameter listing. No extraneous text, though could be more structured with bullet points.

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?

Covers tool purpose, data gathered, and parameter semantics. Output schema handles return values. However, lacks guidance on when to prefer over sibling SNMP tools or limitations.

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?

With 0% schema description coverage, the 'Args' section adds crucial context: device is from 'devices.yaml' and community is for 'SNMPv2c'. This compensates for the schema's lack of descriptions.

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 gets a 'quick SNMP-based overview' of a device, specifying it polls system MIB, interface counts, and uptime. This distinguishes it from sibling tools like snmp_get (specific OIDs) and snmp_walk (subtree walk).

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?

Implied usage for a quick overview via SNMP, but no explicit guidance on when to use this over alternatives like snmp_get or show_interfaces. Lacks 'when not to use' or specific context.

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