Skip to main content

MCP server to manage NAT / port forwarding on ZTE ZXHN F680 routers

Project description

zte-f680-mcp

zte-f680-mcp banner

MCP Server (Model Context Protocol) to manage NAT / port forwarding on a ZTE ZXHN F680 GPON router from any MCP-compatible client (Claude Desktop, Claude Code, Cursor, Windsurf, OpenAI Agents SDK, Cline, Continue, etc.).

Control your router port forwarding rules conversationally, without opening the web UI.

Features

Tool Description
zte_get_port_forwards List all NAT rules
zte_open_port Quick-open a port with smart defaults (auto-detect local IP, same port both sides)
zte_get_local_ip Return the host IP in the router's subnet (cross-platform)
zte_add_port_forward Add a rule with full control (ranges, custom internal IP/port)
zte_modify_port_forward Modify an existing rule by index
zte_delete_port_forward Delete a rule by index
zte_get_device_info Device model, serial, firmware, hardware, bootloader, WiFi chipsets
zte_get_wan_status WAN IP, DNS, MAC, connection type, uptime
zte_get_wifi_info Both bands (SSID, channel, PSK, BSSID, stats)
zte_get_dhcp_leases Connected devices (IP, MAC, hostname, connection)
zte_get_dmz DMZ status and destination host
zte_get_wifi_clients WiFi-associated clients with RSSI (signal strength)
zte_run_page Fetch and parse any page from the router (generic)

Quick-open flow (v0.2.0+)

Ask your assistant plainly and it will confirm before touching the router:

You: open port 8080 Assistant: Your local IP is 192.168.1.128. Should I forward 8080 → 192.168.1.128:8080? You: yes Assistant: ✓ Rule added.

Under the hood the assistant calls zte_get_local_ip (to pick the correct interface even on multi-homed hosts) and then zte_open_port(port=8080). If you want a different internal port or IP, just say so and the assistant switches to zte_add_port_forward with your values.

Requirements

  • Python 3.10+
  • A ZTE ZXHN F680 router reachable on the local network
  • The admin credentials of the router's web panel

Install & configure

The easiest way is with uv (or pipx). No cloning, no venv.

Claude Desktop

Edit claude_desktop_config.json:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
{
  "mcpServers": {
    "zte": {
      "command": "uvx",
      "args": ["zte-f680-mcp@latest"],
      "env": {
        "ZTE_HOST": "192.168.1.1",
        "ZTE_USER": "1234",
        "ZTE_PASSWORD": "your_password_here"
      }
    }
  }
}

Tip: @latest makes uvx check PyPI on every launch and use the newest version, so users get updates automatically. Remove @latest (just "zte-f680-mcp") to pin to whatever was installed first.

Claude Code (CLI)

claude mcp add zte \
  --env ZTE_HOST=192.168.1.1 \
  --env ZTE_USER=1234 \
  --env ZTE_PASSWORD=your_password_here \
  -- uvx zte-f680-mcp@latest

Cursor / Windsurf / Cline / Continue

Add the same block as Claude Desktop in the corresponding MCP settings file of each client.

OpenAI Agents SDK (Python)

from agents.mcp import MCPServerStdio

zte = MCPServerStdio(
    params={
        "command": "uvx",
        "args": ["zte-f680-mcp@latest"],
        "env": {
            "ZTE_HOST": "192.168.1.1",
            "ZTE_USER": "1234",
            "ZTE_PASSWORD": "your_password_here",
        },
    }
)

Upgrading existing installs

If you registered the server before and want to jump to the newest release:

# Option 1: force-refresh the cache
uvx --refresh zte-f680-mcp

# Option 2: wipe the cache for this package only
uv cache clean zte-f680-mcp

After this, the next time your MCP client launches the server, uvx will fetch the latest version.

Alternative: classic pip install

pip install --upgrade zte-f680-mcp

Then point your MCP client at the installed script:

{
  "mcpServers": {
    "zte": {
      "command": "zte-f680-mcp",
      "env": {
        "ZTE_HOST": "192.168.1.1",
        "ZTE_USER": "1234",
        "ZTE_PASSWORD": "your_password_here"
      }
    }
  }
}

Configuration

The server reads three environment variables (or a local .env file):

Variable Default Description
ZTE_HOST 192.168.1.1 Router IP
ZTE_USER 1234 Admin username
ZTE_PASSWORD (none) Admin password (required)

Example prompts

Once the MCP is registered you can ask your assistant things like:

List the NAT rules on my ZTE router
Open TCP port 8080 forwarded to 192.168.1.100
Delete port forwarding rule number 2
Show the DHCP leases from my router

How it works

  • Auth: SHA256(password + random) with dynamic tokens (Frm_Logintoken, Frm_Loginchecktoken) extracted from the login page.
  • Session: Expires ~60 s idle. The server re-authenticates automatically every 45 s.
  • Anti-CSRF: Each write operation requires a fresh _SESSION_TOKEN fetched from the page.
  • Protocol codes: 0 = TCP+UDP, 1 = UDP, 2 = TCP.
  • Transport: MCP over stdio.

Stack

Development

git clone https://github.com/Picaresco/MCP-ZTE-F680.git
cd MCP-ZTE-F680
python -m venv venv && . venv/Scripts/activate   # Windows
# source venv/bin/activate                         # Linux / macOS
pip install -e .
cp .env.example .env   # fill in your credentials
python -m zte_f680_mcp.server

License

MIT © Alberto Diaz

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zte_f680_mcp-0.3.0.tar.gz (17.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

zte_f680_mcp-0.3.0-py3-none-any.whl (20.0 kB view details)

Uploaded Python 3

File details

Details for the file zte_f680_mcp-0.3.0.tar.gz.

File metadata

  • Download URL: zte_f680_mcp-0.3.0.tar.gz
  • Upload date:
  • Size: 17.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.7

File hashes

Hashes for zte_f680_mcp-0.3.0.tar.gz
Algorithm Hash digest
SHA256 aad27c9f16485fd6b09109eb6bdb87a5d55dbc8005967317264f943be6313af8
MD5 2c37014af42b35114ed887256c099753
BLAKE2b-256 6fd60664029279d727af1ae213ab2747e22896647d2850b265956b5389bc9f02

See more details on using hashes here.

File details

Details for the file zte_f680_mcp-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: zte_f680_mcp-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 20.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.7

File hashes

Hashes for zte_f680_mcp-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 081f1f3ef888dca83adc7722bc0137b598203d19732544ff1011471622868f3f
MD5 20dd398fc527d8f14db0c24e16f7c544
BLAKE2b-256 b4a934e9c0cc768c7ddc3da59133fed36346da7e338e6e78a6c37360d92868b9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page