Skip to main content
Glama
OPNsense MCP Server

OPNsense MCP Server

by lucamarien

opn_interface_stats

Retrieve per-interface traffic counters (bytes in/out, packets, errors) to monitor network utilization, diagnose interface errors, and compare traffic across OPNsense interfaces.

Instructions

Get per-interface traffic statistics (bytes in/out, packets, errors).

Use this when you need to see network utilization, check for interface errors, or compare traffic across interfaces. Returns: dict with 'statistics' (per-interface counters keyed by interface label).

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_interface_stats"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

A3.8/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full burden. 'Get' implies a safe read and the return shape is disclosed, but it says nothing about permissions, data freshness/sampling window, or whether counters are cumulative vs. rate-based – details that matter for interpreting traffic stats.

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 sentences, front-loaded with the verb and resource, with a separate 'Returns:' line. Slightly duplicative given an output schema exists, but nothing is wasted.

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 parameterless read tool with an output schema, the description covers purpose, usage and return shape adequately. The only meaningful gap is behavioral context around what the counters represent (interval, reset behavior), which annotations would normally have covered.

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 the baseline is 4. Nothing in the description misleads about inputs, and it correctly implies no filtering arguments exist.

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?

States a specific verb and resource ('Get per-interface traffic statistics') and enumerates the counters returned (bytes in/out, packets, errors). An agent can distinguish it from siblings like opn_pf_states or opn_system_status, though the description never explicitly names those alternatives.

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?

Gives concrete triggers: 'when you need to see network utilization, check for interface errors, or compare traffic across interfaces.' That is clear usage context, but there are no explicit exclusions or pointers to sibling tools for adjacent needs.

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