Skip to main content
Glama
coreyhines

coreyhines/opnsense-mcp

by coreyhines

routing

Create, delete, list, and toggle static routes and gateways, check gateway status, and apply changes now or stage them. Use help to see each action's fields and rules.

Instructions

Static routes and gateways. Note routes use enabled and gateways use disabled, so a toggle means the opposite thing on each. Call action='help' for each action's fields and rules.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNo[create_gateway] Gateway name
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.
confirmNoToken returned by the previous call, to confirm.
enabledNoTarget state, set explicitly rather than flipped.
gatewayNo[create_gateway, create_route] Next hop address
networkNo[create_route] Destination prefix, for example 172.20.2.0/24
interfaceNo[create_gateway] Interface identifier
ipprotocolNo[create_gateway] inet or inet6 (default inet)
descriptionNoFree-text note stored on the record.
far_gatewayNo[create_gateway] Next hop outside the interface subnet
monitor_disableNo[create_gateway] Turn off monitoring, usual for a point-to-point transit

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.0.0

TDQS

A3.6/5.0
Behavior3/5

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

With no annotations, the description carries the behavioral disclosure burden. It discloses a genuinely important quirk: routes use 'enabled' while gateways use 'disabled,' so toggling means the opposite thing on each. However, it does not warn that delete/toggle operations are mutating, that changes may be staged, or that confirmation tokens are needed, so the behavioral picture remains incomplete.

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?

Three short sentences, each earning its place: the first states scope, the second warns about a non-obvious toggling asymmetry, and the third tells the agent how to get action-specific rules. There is no filler or repetition.

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: 13 parameters, 10 actions, and no output schema, so the description alone is light. The action='help' directive mitigates this by pointing to authoritative per-action rules, but the description does not cover overall workflows like list-then-confirm or whether changes apply immediately. It is adequate as a pointer but not fully self-sufficient.

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?

Schema description coverage is 100%, so the baseline is 3. The description adds crucial parameter semantics by explaining that 'enabled' vs 'disabled' has inverted meaning for routes vs gateways, which is not obvious from the schema's 'Target state, set explicitly rather than flipped.' It also directs the agent to action='help' for per-action field details.

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 identifies the resource domain as 'Static routes and gateways,' which clearly distinguishes it from dynamic routing siblings like bgp. It lacks an explicit verb like 'manage' or 'configure,' but the action enum in the schema supplies the operation vocabulary.

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 phrase 'Static routes and gateways' implies when this tool should be used, but it never names an alternative or states when not to use it. The instruction to call action='help' for each action's fields and rules is useful for learning the tool, but it is not guidance about selecting between sibling tools.

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