Skip to main content
Glama
OPNsense MCP Server

OPNsense MCP Server

by lucamarien

opn_download_config

Download a full OPNsense config.xml backup as raw XML for archival; sensitive values are redacted by default, and unparseable configs are refused rather than returned.

Instructions

Download OPNsense config.xml backup as raw XML.

Use this ONLY when you need a full XML backup for archival purposes. For analyzing specific config sections, use opn_scan_config to build a cached inventory, then opn_get_config_section to query individual sections.

By default, sensitive data (passwords, keys, secrets) is redacted; a config that cannot be parsed for redaction is refused, never returned raw. include_sensitive=true additionally requires OPNSENSE_ALLOW_SENSITIVE=true in the server environment — without it, the call is refused. Returns: dict with 'config_xml' (str), 'stripped' (bool), 'size_bytes' (int), or 'error'/'error_type' when the config cannot be parsed.

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

Input Schema

NameRequiredDescriptionDefault
include_sensitiveNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

A5/5.0
Behavior5/5

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

With no annotations provided, the description carries the full burden and does so: it discloses default redaction of secrets, the fail-closed behavior when the config cannot be parsed (refused, never returned raw), and the environment prerequisite OPNSENSE_ALLOW_SENSITIVE=true for include_sensitive. These are exactly the safety facts an agent needs before invoking a config-exfiltration-style tool.

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?

Front-loaded with the one-line purpose, then usage constraint, then safety semantics, then return shape. Every sentence carries distinct information; nothing is restated from the schema or annotations.

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?

A single-parameter tool with an output schema and no annotations is fully covered: purpose, alternatives, redaction/refusal behavior, env precondition, and response keys are all present. The return-value sentence is mildly redundant given the output schema but adds error-key detail that aids handling.

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

Parameters5/5

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

Schema coverage is 0% and the single parameter has no schema description, so the description must compensate — and it does, explaining include_sensitive's default, its interaction with the server env var, and the refusal outcome when the env var is absent. That is meaning well beyond the bare boolean type and default in the schema.

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?

States a specific verb and resource ('Download OPNsense config.xml backup as raw XML'), including the output format, and explicitly names the sibling tools (opn_scan_config, opn_get_config_section) that serve adjacent purposes. An agent can distinguish this from the section-query siblings without opening any schema.

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

Usage Guidelines5/5

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

Gives an explicit when-to-use constraint ('ONLY when you need a full XML backup for archival purposes') plus a concrete alternative path for the other common case: opn_scan_config then opn_get_config_section. When-not and alternatives are both spelled out.

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