Skip to main content
Glama
coreyhines

coreyhines/opnsense-mcp

by coreyhines

config_backup

Back up and restore OPNsense configurations: list revision history, diff changes, download configs, and create boot environment snapshots.

Instructions

Configuration backups, revision history and boot environment snapshots. Call action='help' for each action's fields and rules.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo[list] Maximum revisions to return (default 25)
rev_aNo[diff] Older revision id, from list_config_backups
rev_bNo[diff] Newer revision id, from list_config_backups
actionYesOperation to run. 'help' lists fields.
providerNo[diff, download, list] Backup provider id (default 'this')
revisionNo[download] Revision id to fetch; omit for the running config
descriptionNoFree-text note stored on the record.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.0.0

TDQS

C2.9/5.0
Behavior2/5

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

With no annotations, the description must carry the behavioral disclosure burden, but it only names resource areas and points to help. It does not reveal which actions are mutating, whether snapshots affect the boot environment, any side effects, or return behavior. There is no contradiction with annotations because none are provided.

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?

The description is two short front-loaded sentences with no filler, and the second sentence gives a concrete next step. It is concise, though the first sentence is a noun fragment rather than a complete purpose statement.

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

Completeness3/5

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

The tool is complex with 7 parameters and no output schema, and the description is not self-contained. However, the explicit action='help' instruction provides a viable discovery path for action-level rules, and the schema documents every parameter. It still lacks return shapes and side-effect warnings, making it adequate but not complete.

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

Parameters3/5

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

Schema description coverage is 100%, so the schema already documents each parameter with action-scoped tags such as [list], [diff], and [download]. The description adds only the pointer to action='help' for action-specific fields and rules, which is a discovery aid rather than new parameter semantics; baseline 3 is appropriate.

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

Purpose3/5

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

The description identifies the domain—configuration backups, revision history, and boot environment snapshots—and distinguishes it from sibling config-editing tools by resource type. However, it provides no verb: it never states what the tool does with these resources (e.g., create, diff, download, list), so the purpose must be inferred from the action enum in the schema.

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

Usage Guidelines3/5

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

It gives an explicit entry strategy: call action='help' to get each action's fields and rules, which is useful for an agent unsure of sub-action semantics. It does not, however, explain when to choose config_backup over sibling tools or which scenarios call for backups/revisions versus live configuration changes.

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