Skip to main content
Glama

opn_settings

Read or update an OPNsense controller’s full settings model: merge partial data, save changes, and optionally apply service reconfigure.

Instructions

Read a controller's whole settings model (controller/get), or change part of it: data is merged into the model and saved with controller/set, e.g. opn_settings("unbound/settings", {"general": {"port": "53"}}). apply=true then runs the service reconfigure.

Input Schema

NameRequiredDescriptionDefault
dataNo
applyNo
dry_runNo
controllerYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/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 disclose the key non-obvious behavior: data is merged into the model rather than replacing it, and apply triggers a service reconfigure. It omits whether the operation is reversible, what permissions are required, and what dry_run actually changes about the call, leaving the mutation's risk profile partially undisclosed.

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?

Compact and front-loaded, leading with the read case before the write case, with a single inline example that earns its place. The 'or change part of it:' clause is slightly awkward but not wasteful.

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?

For a mutation tool with no annotations, no output schema, and zero schema description coverage, the description covers the essential read/merge/apply flow but leaves dry_run unexplained and gives no sense of the return value or error behavior. Adequate, but there are clear gaps an agent would want filled.

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%, so the description must compensate. It explains data's merge semantics and gives a concrete example, and explains apply's effect, but says nothing about dry_run or the required controller parameter, leaving two of four parameters with no semantics anywhere.

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?

States a specific verb pair (read vs. change) against a concrete resource ('a controller's whole settings model') and names the underlying endpoints controller/get and controller/set. It does not differentiate itself from siblings such as opn_api or opn_service, which plausibly also touch configuration, so it stops short of a 5.

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?

The description implicitly defines two modes: omit data to read, supply data to merge-and-save, and apply=true to run the reconfigure. That is useful implied routing, but there is no explicit when-not guidance, no mention of dry_run as a safer alternative, and no pointer to sibling tools for arbitrary endpoints.

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