Skip to main content
Glama

opn_config_history

List OPNsense configuration backups newest first and compare any chosen backup with the newest configuration using its ID.

Instructions

Config history (newest first: id, time, description, user). With diff_with=, the diff between that backup and the newest one.

Input Schema

NameRequiredDescriptionDefault
limitNo
diff_withNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior3/5

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

With no annotations supplied, the description usefully discloses newest-first ordering, the listed fields, and the exact comparison performed in diff mode. However, it does not explicitly establish that the operation is read-only or describe the diff's output form and behavior when an ID is invalid.

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 description is compact and front-loaded, covering the default result, ordering, fields, and alternate diff behavior in two efficient sentences. There is no unnecessary wording.

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?

For a simple two-parameter tool, the description supplies most of what an agent needs to invoke both modes correctly, which is especially valuable without an output schema. The remaining gaps are the undocumented limit parameter, unspecified diff representation, and lack of an explicit read-only guarantee.

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 0%, but the description compensates well for diff_with by identifying its value as a backup ID and explaining the comparison target. It adds nothing about limit beyond its name, such as confirming that it caps the number of returned history entries.

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 clearly identifies the resource as configuration history and explains its two capabilities: listing backups and producing a diff against the newest backup. It also specifies ordering and history fields, although it does not explicitly differentiate the tool from siblings such as opn_config_revert.

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?

The default history-listing context is clear, and "With diff_with=<id>" explicitly identifies when the diff mode is used. There is no guidance about when history or diff output is useful relative to other tools, such as inspecting a backup before reverting, nor any exclusions.

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