snmp_walk

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

No annotations provided, so description carries full burden. States 'Retrieves all OIDs' without mentioning timeout, rate limits, or read-only nature. Does not specify if the walk is blocking or any potential side effects on the device. Adequate but lacks depth.

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?

Well-structured with an Args section. Sentences are focused. A bit verbose in the description (e.g., 'Useful for...' could be integrated), but overall efficient at 3 lines of text plus args.

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 3 parameters, no annotations, and an output schema (not shown), the description covers purpose and basic parameter meaning. Lacks information on error handling, pagination, or performance considerations. Could be more complete for a network retrieval tool.

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 description adds critical meaning: 'device' comes from devices.yaml, 'base_oid' defaults to IF-MIB ifTable, 'community' defaults to 'public'. However, it does not explain the format expected for 'device' (e.g., hostname vs IP). Good value but some gaps.

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 defines the action ('Walk an SNMP MIB subtree'), the resource ('network device'), and the scope ('all OIDs under the specified base OID'). Distinguishes effectively from sibling tools like snmp_get (single OID retrieval) and snmp_device_overview (device summary).

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?

Mentions usefulness for 'interface tables, routing tables, etc.', but does not explicitly state when not to use (e.g., for a single OID, where snmp_get would be more appropriate). No comparison to alternatives, so guidance is implied rather than explicit.

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