Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| REDIS_HOST | No | Hostname of Redis server for caching | |
| ENABLE_CACHE | No | Enable Redis caching for improved performance | false |
| OPNSENSE_HOST | Yes | URL of your OPNSense firewall including protocol and port | |
| POSTGRES_HOST | No | Hostname of PostgreSQL server for audit trails | |
| BACKUP_ENABLED | No | Enable automatic configuration backups before changes | false |
| OPNSENSE_API_KEY | Yes | Your OPNSense API key | |
| OPNSENSE_API_SECRET | Yes | Your OPNSense API secret | |
| OPNSENSE_VERIFY_SSL | No | Whether to verify SSL certificates when connecting to OPNSense | true |
Schema
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
| VLANs | List of all configured VLANs |
| Firewall Rules | List of all firewall rules |
| Network Interfaces | Available network interfaces |
| Connection Status | OPNsense connection status |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| configure | Configure OPNsense connection |
| list_vlans | List all VLANs |
| get_vlan | Get VLAN details |
| create_vlan | Create a new VLAN |
| delete_vlan | Delete a VLAN |
| update_vlan | Update VLAN description |
| list_firewall_rules | List all firewall rules |
| get_firewall_rule | Get firewall rule details |
| create_firewall_rule | Create a new firewall rule |
| create_firewall_preset | Create a firewall rule from a preset |
| update_firewall_rule | Update a firewall rule |
| delete_firewall_rule | Delete a firewall rule |
| toggle_firewall_rule | Toggle firewall rule enabled/disabled |
| find_firewall_rules | Find firewall rules by description |
| create_backup | Create a configuration backup |
| list_backups | List available backups |
| restore_backup | Restore a configuration backup |
| test_connection | Test API connection and authentication |
| get_interfaces | List available network interfaces |