Zyxel USG FLEX MCP Server
This server does not currently have a deployable release on Glama. Follow the repository's setup instructions to install and configure it for your MCP client, including any required credentials and local dependencies.
Zyxel USG FLEX MCP Server (zyxel-usg-mcp)
A production-ready Model Context Protocol (MCP) server written in TypeScript for Zyxel USG FLEX H Series (uOS V1.40: 50H / 100H / 200H / 500H / 700H) and USG FLEX / ATP Series (ZLD) firewalls.
Unlike mock-only CLI wrappers, zyxel-usg-mcp connects to real Zyxel hardware over Serial Console (COM3 / /dev/ttyUSB0 in ~0.5s) and SSH (hmac-sha2-256 interactive PTY), while bundling the complete 13,000+ line Zyxel uOS V1.40 CLI Reference Guide, CLI Cheatsheet, and 7 Official Zyxel SNMP MIB files for sub-5ms local V8 regex search.
Key Features
Real Hardware Execution (Serial + SSH):
Ultra-Fast Serial Console (
~0.5s): Direct Win32COM3(kernel32ctypes) & Linux/WSL2/dev/ttyUSB0(pyserial) support with automaticusbipddetection and zero PowerShell overhead.Zyxel SSH Compatibility: Automatically negotiates
MACs=hmac-sha2-256and interactive PTY (zysh/uOSCLI) with automatic--More--pagination handling.Concurrency Mutex Queue: Serializes concurrent tool calls so multiple requests or shared lab users never collide on the Serial/SSH session.
Dual MCP Transport (
Stdio&Streamable HTTP):Local
Stdiomode (default): Zero-dependency setup for Claude Desktop, Claude Code, Antigravity, and Cursor.Shared Lab
Streamable HTTPmode (--http --port 8787): Expose a connected lab USG FLEX 500H overhttp://<lab-host>:8787/mcpwith optional Bearer token authentication (USG_MCP_TOKEN) and Read-Only guardrails (USG_READONLY=true).
Built-in Knowledge Base (
Resources& V8 Search):Full Zyxel USG FLEX H Series uOS V1.40 CLI Reference Guide (
13,091lines with Alphabetical Index).Curated uOS V1.40 CLI Cheatsheet (CLI modes, PoE, UTM Signatures, Nebula Production/Gamma troubleshooting, packet flow exploration).
7 Official Zyxel SNMP MIBs:
ZYXEL-HW-MONITOR-MIB,ZYXEL-ZW-COMMON,ZYXEL-ZW-SMI,ZYXEL-ES-COMMON,ZYXEL-ES-SMI,ZYXEL-ES-WIRELESS,ZYXEL-ES-CAPWAP.
Related MCP server: Zyxel Switch MCP Server
MCP Tools
Tool Name | Description |
| One-call status inspection for preset modules: |
| Execute one or more read-only / diagnostic CLI commands on a Zyxel USG FLEX H ( |
| Safely execute configuration commands inside |
| Sub-5ms V8 regex/keyword search across the 13,091-line |
| Search the 7 bundled official Zyxel SNMP MIB files by OID name, object identifier, or keyword. |
| Check status, attach, or detach the FTDI USB-to-Serial Console cable ( |
MCP Resources
zyxel://docs/uos-cli-cheatsheet— USG FLEX H Series (uOS V1.40) Quick Cheatsheetzyxel://docs/uos-cli-index— USG FLEX H Series (uOS V1.40) Alphabetical Command Indexzyxel://live/poe-status— Live PoE Port Status from the connected USG FLEX firewallzyxel://live/signatures— Live IPS, App Patrol, IP Reputation, System Protection, Geo-IP, and Cloud Helper signature statuszyxel://mibs/<filename>— Official Zyxel SNMP MIB files
MCP Prompts
usg_health_audit— Full hardware, interface, PoE, and UTM signature health check workflowusg_nebula_troubleshoot— Nebula Control Center (NCC) Callhome (TCP 4335&d2.nebula.zyxel.com) troubleshooting workflowusg_safe_config_change— Guidededit running->diff->commit->copy running startupworkflow
Quick Start
1. Build from Source
git clone https://github.com/JamesChan-Zy/zyxel-usg-mcp.git
cd zyxel-usg-mcp
npm run build2. Authentication Setup
Store your firewall admin password in ~/.ssh/.usg_pass (recommended, permissions 0600) or pass USG_PASSWORD in environment variables:
echo 'YOUR_FIREWALL_PASSWORD' > ~/.ssh/.usg_pass
chmod 600 ~/.ssh/.usg_pass3. Configure MCP Client (mcp_config.json)
Option A: Local Stdio Mode (Antigravity / Claude Desktop / Claude Code / Cursor)
{
"mcpServers": {
"zyxel-usg-mcp": {
"command": "node",
"args": ["/path/to/zyxel-usg-mcp/dist/index.js"],
"env": {
"USG_TRANSPORT": "serial",
"USG_COM_PORT": "COM3",
"USG_SERIAL_DEV": "/dev/ttyUSB0",
"USG_HOST": "192.168.201.254",
"USG_USER": "admin"
}
}
}
}Option B: Shared Lab Streamable HTTP Mode
Start the server on the lab host connected to the USG FLEX firewall:
USG_READONLY=false USG_MCP_TOKEN=your-secret-token node dist/index.js --http --port 8787Connect from any team member's MCP client:
{
"mcpServers": {
"zyxel-usg-lab": {
"url": "http://<lab-host-ip>:8787/mcp"
}
}
}Environment Variables
Variable | Default | Description |
|
| Default transport ( |
|
| Windows Serial COM port |
|
| Linux / WSL2 Serial device path |
|
| Serial baud rate ( |
|
| Default SSH IP address |
|
| Default SSH port |
|
| Firewall administrator username |
| (from | Optional password override |
|
| Path to file containing password on line 1 |
|
| Set |
| (none) | Optional Bearer token for |
License
MIT
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
This server cannot be deployed
Maintenance
Related MCP Connectors
AI helper for choosing and speccing network & security products from Cisco, Arista, Juniper and more
AI network lab: build and validate real multi-vendor router and switch labs from a prompt.
- DNS-DATA RemoteDeprecatedcom.dns-data
Connect AI assistants to authorized Windows and macOS devices for files, commands, and management.
Protocol-native energy infrastructure orchestration for AI data centers. Provides 46 MCP tools across 8 grid protocols (IEC-61850, DNP3, Modbus, OCPP, OpenADR, IEEE 2030.5, IEC 60870-5-104, ICCP) with 5 core API primitives: connect, dispatch, settle, comply, and intel. Enables AI agents to programmatically interact with substations, grid interfaces, and energy assets for real-time workload-grid coordination.
Related MCP Servers
- AlicenseBqualityDmaintenanceEnables AI applications to interact with Zyxel managed switches for network configuration, monitoring, and management using authentic CLI commands.19MIT
- AlicenseBqualityDmaintenanceEnables AI applications to interact with Zyxel switches via CLI for network configuration, monitoring, and management, supporting SSH/Telnet sessions and MCP-compliant tools, resources, and prompts.19MIT
- AlicenseNot gradedqualityDmaintenanceEnables AI assistants to manage FortiGate firewalls from bootstrap to production, with safe preview/apply changes and secure credential handling. Covers inventory, VDOMs, interfaces, routing, firewall policies, VPN, security analysis, and documentation generation.MIT
- AlicenseBqualityCmaintenanceEnables AI assistants to programmatically generate Huawei eNSP .topo files that include USG6000V firewalls and S3700 switches, and then, once devices are started in eNSP, deliver configurations, run verification, and diagnose faults over Telnet. Ships with one-click health self-checks and topology-generation skills for natural-language-driven lab setup.312MIT