Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| UNIFI_API_KEY | Yes | API key from your UniFi Console | |
| UNIFI_BASE_URL | Yes | Your UniFi Console URL (e.g., https://192.168.1.1) |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| unifi_get_info | Get application information including version and whether it's a UniFi OS Console |
| unifi_list_sites | List all sites available to the API key |
| unifi_list_devices | List all adopted devices at a site |
| unifi_get_device | Get a specific device by ID |
| unifi_get_device_statistics | Get latest statistics for a device |
| unifi_adopt_device | Adopt a pending device |
| unifi_restart_device | Restart a device |
| unifi_locate_device | Enable or disable the locate function (flashing LED) on a device |
| unifi_list_pending_devices | List devices pending adoption (global, not site-specific) |
| unifi_power_cycle_port | Power cycle a specific port on a device (PoE restart) |
| unifi_list_clients | List all connected clients (wired, wireless, VPN) at a site |
| unifi_get_client | Get a specific client by ID |
| unifi_authorize_guest | Authorize a guest client on a hotspot network |
| unifi_list_networks | List all networks at a site |
| unifi_get_network | Get a specific network by ID |
| unifi_create_network | Create a new network |
| unifi_update_network | Update an existing network |
| unifi_delete_network | Delete a network |
| unifi_get_network_references | Get references to a network (what WiFi broadcasts, firewall zones, etc. use this network) |
| unifi_list_wifi | List all WiFi broadcasts (SSIDs) at a site |
| unifi_get_wifi | Get a specific WiFi network by ID |
| unifi_create_wifi | Create a new WiFi network (SSID) |
| unifi_update_wifi | Update an existing WiFi network |
| unifi_delete_wifi | Delete a WiFi network |
| unifi_list_vouchers | List all hotspot vouchers at a site |
| unifi_get_voucher | Get a specific hotspot voucher by ID |
| unifi_create_voucher | Create hotspot vouchers |
| unifi_delete_voucher | Delete a hotspot voucher |
| unifi_bulk_delete_vouchers | Bulk delete hotspot vouchers based on filter criteria (e.g., 'expired.eq(true)' to delete all expired vouchers) |
| unifi_list_firewall_zones | List all firewall zones at a site |
| unifi_get_firewall_zone | Get a specific firewall zone by ID |
| unifi_create_firewall_zone | Create a new custom firewall zone |
| unifi_update_firewall_zone | Update a firewall zone |
| unifi_delete_firewall_zone | Delete a custom firewall zone |
| unifi_list_acl_rules | List all ACL (firewall) rules at a site |
| unifi_get_acl_rule | Get a specific ACL rule by ID |
| unifi_create_acl_rule | Create a new ACL (firewall) rule |
| unifi_update_acl_rule | Update an ACL rule |
| unifi_delete_acl_rule | Delete an ACL rule |
| unifi_list_traffic_matching_lists | List all traffic matching lists at a site (port groups, IP groups) |
| unifi_get_traffic_matching_list | Get a specific traffic matching list by ID |
| unifi_create_traffic_matching_list | Create a new traffic matching list |
| unifi_update_traffic_matching_list | Update a traffic matching list |
| unifi_delete_traffic_matching_list | Delete a traffic matching list |
| unifi_list_wans | List all WAN interfaces at a site |
| unifi_list_vpn_tunnels | List all site-to-site VPN tunnels at a site |
| unifi_list_vpn_servers | List all VPN servers at a site |
| unifi_list_radius_profiles | List all RADIUS profiles at a site |
| unifi_list_device_tags | List all device tags at a site (used for WiFi broadcast assignments) |
| unifi_list_dpi_categories | List all DPI (Deep Packet Inspection) categories for traffic identification |
| unifi_list_dpi_applications | List all DPI applications for traffic identification and filtering |
| unifi_list_countries | List all countries/regions for geo-based rules (ISO codes and names) |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |