Skip to main content
Glama
OPNsense MCP Server

OPNsense MCP Server

by lucamarien

opn_mcp_info

Check the MCP server version, write-mode status, detected OPNsense API version, and savepoint rollback support before managing a firewall.

Instructions

Get MCP server version and runtime configuration.

Use this to check the MCP server version, whether write mode is enabled, the detected OPNsense API version, and whether firewall writes still get savepoint/rollback protection. Version detection runs here if no earlier call triggered it; if the firewall is unreachable, the failure is reported instead of raised. Returns: dict with 'mcp_version', 'write_mode', 'opnsense_version', 'api_style', 'savepoint_support' and, only when detection failed, 'version_detection_error'. 'savepoint_support' is true when the 60-second auto-revert is available, false when OPNsense no longer offers it (26.7+ removed it upstream, so firewall changes are immediate and permanent), and null when no firewall write has probed for it yet.

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

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.6/5.0
Behavior5/5

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

With no annotations, the description carries the full burden and does so: it discloses a non-obvious side effect (lazy version detection triggered by this call), the failure mode ('failure is reported instead of raised' when the firewall is unreachable), and precise tri-state semantics for 'savepoint_support' including the upstream 26.7+ removal. The consequence of that removal ('firewall changes are immediate and permanent') is exactly the kind of risk context an agent needs.

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?

Purpose and usage are front-loaded in the first two sentences, and the detail sentences are all substantive rather than filler. The 'Returns:' block restates field names that an output schema already carries, which is mild redundancy, though the surrounding semantic notes on each field are not redundant.

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

Completeness5/5

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

For a zero-parameter introspection tool, the description covers trigger conditions, side effects, error behavior, and the meaning of every returned field including the conditional 'version_detection_error'. Nothing an agent needs in order to call it correctly or interpret the result is missing.

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 of 4 applies and there is nothing for the description to disambiguate. It correctly adds no invented parameter guidance.

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

Purpose5/5

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

The description opens with a specific verb and resource ('Get MCP server version and runtime configuration') and then enumerates exactly which configuration facets are reported (write mode, detected OPNsense API version, savepoint protection). Every sibling tool operates on firewall/DNS/VPN data, so an agent can immediately tell this is the meta/introspection tool.

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 to check ...' explicitly names the situations that select this tool, and the note that version detection runs here if no earlier call triggered it gives a concrete reason to call it early. There is no explicit when-not or named alternative, but no sibling offers the same server-level information, so the routing decision is unambiguous.

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