Skip to main content
Glama
coreyhines

coreyhines/opnsense-mcp

by coreyhines

alias

Manage firewall named address and port groups referenced by rules. Create, update, list, or toggle these groups to organize network objects.

Instructions

Manage firewall aliases, the named address and port groups rules reference. Call action='help' for each action's fields and rules.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNo[create] Alias name
typeNo[create] Alias type, one of: host, network, port, url, urltable, geoip, networkgroup, mac, asn, dynipv6host, authgroup, internal, external
uuidNoRecord to act on, identified by a list action.
applyNoApply now rather than leaving the change staged. The default differs by action; action='help' reports each one.
actionYesOperation to run. 'help' lists fields.
searchNo[list] Filter by alias name, type, or content
confirmNoToken returned by the previous call, to confirm.
contentNo[create, update] Members: addresses, networks, ports or codes
enabledNoTarget state, set explicitly rather than flipped.
descriptionNoFree-text note stored on the record.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.0.0

TDQS

B3.3/5.0
Behavior2/5

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

There are no annotations, so the description carries the full burden of behavioral disclosure. It says 'Manage' but does not disclose staging/apply semantics, destructive operations, confirmation requirements, or return behavior. The schema hints at apply and confirm, but the description itself is silent.

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?

Two sentences, front-loaded with purpose and a direct next-step instruction. There is no filler, and the help guidance earns its place.

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 10-parameter, multi-action tool with no output schema and no annotations, the description is thin. However, the explicit 'call action=help' hand-off mitigates some gaps. It still omits staging/apply behavior, deletion confirmation, and return-value expectations, so it is 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 baseline is 3 even without parameter details in the description. The 'action=help' hint is a useful addition, but the description does not explain individual parameters beyond what the schema already provides.

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 names a specific resource ('firewall aliases') and clarifies that these are the named address and port groups that rules reference. This distinguishes it from siblings like fw_rule, though the verb 'Manage' is broad and does not enumerate the concrete actions.

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 instruction to call action='help' is actionable and gives the agent a path to discover each action's fields and rules. However, it does not explicitly contrast with sibling tools or state when this tool should be preferred over them; the context implies alias management but not exclusions.

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