Skip to main content
Glama
OPNsense MCP Server

OPNsense MCP Server

by lucamarien

opn_arp_table

Retrieve the ARP table to map IP addresses to MAC addresses, identify devices on a network segment, and troubleshoot connectivity issues.

Instructions

Get the ARP table showing IP-to-MAC address mappings.

Use this when you need to find which MAC address is associated with an IP, identify devices on a network segment, or troubleshoot connectivity. Returns: dict with 'rows' (list of ARP entries including ip, mac, intf, and hostname fields) and 'rowCount' (total).

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "opn_arp_table"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

A4/5.0
Behavior4/5

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

No annotations exist, so the description carries the full burden, and it does most of the job: 'Get' implies a non-mutating read, and the return body is spelled out (rows with ip, mac, intf, hostname, plus rowCount). It omits whether entries come from the live cache versus static config, or how multiple interfaces are reported, which matters for interpreting results.

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?

Three short, front-loaded sentences: purpose, usage, return shape. The returns sentence partially duplicates the output schema that already exists, but it is compact and does not bloat the definition. No filler wording.

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 zero-parameter read tool with an output schema present, the description covers purpose, when to call, and what comes back — nothing essential is missing. The only real gap is the absent pointer to opn_ndp_table for IPv6 neighbors, which would help in an environment with many similar monitoring tools.

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?

The tool takes zero parameters, so per the baseline this scores 4; there is no parameter meaning the description needs to add. It does explicitly say the query is unfiltered (whole ARP table returned), which usefully implies no scoping arguments.

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 opens with a concrete verb+resource pair, 'Get the ARP table showing IP-to-MAC address mappings', which tells the agent exactly what data comes back. It does not explicitly distinguish itself from the sibling opn_ndp_table (IPv6 neighbor table), leaving that IPv4-vs-IPv6 split to inference from the name.

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

Usage Guidelines4/5

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

'Use this when you need to find which MAC address is associated with an IP, identify devices on a network segment, or troubleshoot connectivity' gives three concrete triggering scenarios. It stops short of exclusions or naming an alternative tool (e.g. opn_ndp_table for IPv6, opn_list_dhcp_leases for lease lookups), so routing to the right sibling is only partly supported.

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

Deploy Server

Other Tools