Skip to main content
Glama
AIops-tools

io.github.AIops-tools/network-aiops

get_snmp_information

Read-only

Read SNMP metadata (chassis ID, contact, location) from a configured network device. Community strings are redacted for safe, read-only queries.

Instructions

[READ] SNMP metadata: chassis id, contact, location. Community strings redacted.

Args: target: Device name from config.

Input Schema

NameRequiredDescriptionDefault
targetNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.8.0

TDQS

A3.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds a genuinely useful, non-obvious behavioral fact — that community strings are redacted in the output — plus the field-level contents, which goes beyond what the annotation provides.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the key fact (what it returns and the redaction), then a compact Args block. Short and mostly waste-free, though the Args section is minimal enough that it barely earns its lines.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple single-parameter read tool with no output schema, the description adequately conveys the data returned and a key privacy behavior. The only gap is the semantics of the optional target default, which is minor for this tool's complexity.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description carries the burden, and it does clarify that 'target' is a device name from config. However, it says nothing about what happens when target is omitted (the schema shows a default of null) or accepted formats.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific resource (SNMP metadata) and enumerates the fields returned (chassis id, contact, location), which distinguishes it from the many sibling get_* tools that retrieve other device data. The verb is carried by the tool name rather than the description, but the scope is unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no statement of when to use this tool versus alternatives such as device_facts or get_environment, nor any exclusions or prerequisites. The '[READ]' tag hints at read-only context but doesn't route the agent among siblings.

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