Skip to main content
Glama
AIops-tools

io.github.AIops-tools/network-aiops

get_arp_table

Read-only

Fetches ARP table entries (interface, IP, MAC, age) from a target network device to troubleshoot connectivity and verify IP-to-MAC address mappings.

Instructions

[READ] ARP table entries: interface, IP, MAC, age.

Args: target: Device name from config.

Input Schema

NameRequiredDescriptionDefault
targetNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.8.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, and the description's '[READ]' marker is consistent. It adds the returned fields, which is useful, but does not disclose target omission behavior or any other operational detail beyond the safety annotation.

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

Conciseness5/5

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

The description is front-loaded with the key resource and returned fields, followed by a compact Args section. Every part is useful, with no filler.

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

Completeness3/5

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

For a simple read tool with a readOnly annotation and no output schema, the description covers the resource, returned fields, and parameter meaning. However, it leaves the behavior when target is omitted unspecified, which could matter since the parameter is optional.

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

Parameters4/5

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

Schema description coverage is 0%, so the description must carry the load. It does explain the single parameter: 'target: Device name from config,' which adds meaning beyond the bare string/null schema, though it omits optional/default behavior.

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 states a specific resource – ARP table entries – and enumerates the fields returned (interface, IP, MAC, age). It is clear what the tool retrieves, though it does not explicitly distinguish itself from siblings like get_mac_address_table.

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?

No when-to-use context, prerequisites, or alternatives are given. The description only states what the tool returns; an agent must infer that this is for ARP inspection when needed.

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