OPNsense MCP Server

Overview Schema Source Related Servers Discussions Admin

opn_download_config

Downloads the full OPNsense config.xml backup as raw XML with sensitive data redacted by default. Use for complete archival or when a full snapshot is required, while scanning individual sections for targeted analysis.

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. Returns: dict with 'config_xml' (str), 'stripped' (bool), 'size_bytes' (int).

Input Schema

TableJSON Schema

Name	Required	Description	Default
`include_sensitive`	No

Output Schema

TableJSON Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.4.0Jun 10, 2026

TDQS

A4.6/5.0

Behavior4/5

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

Discloses that sensitive data is redacted by default, and describes the return structure. Without annotations, this provides necessary behavioral context, though could mention more about side effects.

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?

Concise, front-loaded with action, no redundant sentences.

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?

Covers purpose, usage alternatives, return type, and redaction. Could be more complete (e.g., prerequisites), but output schema exists to fill some gaps.

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?

Only one boolean parameter; description explains redaction default behavior, adding meaning beyond the schema. Schema coverage is 0% but the narrative compensates sufficiently.

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?

Clearly states it downloads config.xml backup as raw XML, distinguishes from siblings like opn_scan_config and opn_get_config_section.

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?

Explicitly states when to use (full backup) and when not (use opn_scan_config then opn_get_config_section for specific sections), naming alternatives.

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

Deploy Server