Skip to main content
Glama
OPNsense MCP Server

OPNsense MCP Server

by lucamarien

opn_gateway_status

Retrieve OPNsense gateway status and dpinger health checks to verify WAN availability, latency, packet loss, and failover state.

Instructions

Get gateway status including dpinger health checks.

Use this when you need to check if WAN gateways are up, their latency, packet loss, or failover state. Returns: dict with gateway items including status, loss, and delay fields. (If the API answers with a bare array, it arrives wrapped in the 'rows'/'rowCount' envelope.)

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

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.9/5.0
Behavior3/5

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

There are no annotations, so the description must carry the full burden of behavioral disclosure. It says the tool is a read-style getter and discloses the return shape ('gateway items including status, loss, and delay fields') plus a concrete envelope quirk, which adds real value, but it omits whether all gateways or only WAN gateways are included, and whether authentication or permissions matter.

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 definition leads with purpose, then use cases, then the return shape. Each sentence contributes, and there is no filler; even the parenthetical about the array envelope carries information an agent would otherwise have to discover at runtime.

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?

An output schema exists, so the description need not enumerate return fields, yet it summarises them briefly and explains the envelope fallback. It is complete for a zero-parameter read tool, missing only scope details such as whether only WAN gateways are covered or what an empty result looks like.

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. The description correctly implies that no filtering input is required, and its mention of a 'rows'/'rowCount' wrapper clarifies output structure rather than input semantics.

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 uses a specific verb and resource ('Get gateway status'), then narrows it further with 'including dpinger health checks'. This distinguishes it from siblings such as opn_system_status, opn_interface_stats, and opn_pf_states, though it never names a sibling explicitly.

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?

It gives clear use cases (WAN gateways up, latency, packet loss, failover state), so the agent can decide when the tool applies. It stops short of stating exclusions or naming alternatives; for example, it does not say which tool to choose for interface-level versus gateway-level health.

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