io.github.teefloo/asuswrt-mcp

السجل الرسمي أخرى

Secure AsusWRT router administration via SSH — 42+ tools, guarded mutations

ماذا يمكنك أن تفعل مع io.github.teefloo/asuswrt-mcp؟

  • confirm: true parameter
  • ASUSWRT_ALLOW_MUTATIONS=true environment variable
  • Support for dry_run: true to preview changes

التثبيت

أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: ‏.cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).

PYPI package asuswrt-mcp
Claude Code
claude mcp add asuswrt-mcp -e 'ASUSWRT_HOST=<ASUSWRT_HOST>' -e 'ASUSWRT_SSH_USERNAME=<ASUSWRT_SSH_USERNAME>' -e 'ASUSWRT_SSH_PASSWORD=<your asuswrt_ssh_password>' -e 'ASUSWRT_SSH_KEY_FILE=<ASUSWRT_SSH_KEY_FILE>' -e 'ASUSWRT_ALLOW_MUTATIONS=<ASUSWRT_ALLOW_MUTATIONS>' -- uvx asuswrt-mcp==0.1.1
إعداد JSON (Claude Desktop وCursor وVS Code)
{
    "mcpServers": {
        "asuswrt-mcp": {
            "command": "uvx",
            "args": [
                "asuswrt-mcp==0.1.1"
            ],
            "env": {
                "ASUSWRT_HOST": "<ASUSWRT_HOST>",
                "ASUSWRT_SSH_USERNAME": "<ASUSWRT_SSH_USERNAME>",
                "ASUSWRT_SSH_PASSWORD": "<your asuswrt_ssh_password>",
                "ASUSWRT_SSH_KEY_FILE": "<ASUSWRT_SSH_KEY_FILE>",
                "ASUSWRT_ALLOW_MUTATIONS": "<ASUSWRT_ALLOW_MUTATIONS>"
            }
        }
    }
}

متغيرات البيئة

  • ASUSWRT_HOST إلزامي Router IP address (e.g., 192.168.1.1)
  • ASUSWRT_SSH_USERNAME إلزامي SSH username for router authentication
  • ASUSWRT_SSH_PASSWORD إلزامي سري SSH password for router authentication
  • ASUSWRT_SSH_KEY_FILE Path to SSH private key file (alternative to password)
  • ASUSWRT_ALLOW_MUTATIONS Enable mutation tools (default: false)

التوثيق

مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.

المحتويات
  1. AsusWRT MCP Server
  2. Overview
  3. Features
  4. Prerequisites
  5. Installation
  6. Usage
  7. Development
  8. Project Structure
  9. License
  10. Acknowledgments

AsusWRT MCP Server

mcp-name: io.github.teefloo/asuswrt-mcp

Model Context Protocol (MCP) server for secure, controlled administration of AsusWRT and AsusWRT-Merlin routers via SSH.

Overview

This MCP server provides AI assistants (like Claude, Cursor, etc.) with a safe interface to monitor and manage AsusWRT routers. It operates exclusively over SSH using allowlisted operations—no arbitrary command execution, no firmware modifications, and no factory resets.

Features

Read-Only Monitoring (42 tools)
CategoryTools
Identity & HealthRouter model, firmware version, uptime, load, memory
NetworkLAN/WAN details, DNS config, IPv6 status, routing table
ClientsConnected clients, DHCP leases, ARP neighbors
WirelessRadio status, SSIDs, guest networks, client counts per band
ServicesRunning processes, open ports, cron jobs
StorageUSB devices, mounts, partitions, filesystem usage
SecurityUPnP, DDNS, Samba status, conntrack usage
VPNOpenVPN server, WireGuard, VPN client profiles
AdministrationWeb admin ports, SSH/telnet access settings
DiagnosticsSSH TCP/banner/auth diagnostics, config snapshot
Mutation Tools (with safety guards)

All mutation tools require:

  • confirm: true parameter
  • ASUSWRT_ALLOW_MUTATIONS=true environment variable
  • Support for dry_run: true to preview changes
ToolDescription
asuswrt_restart_serviceRestart allowlisted services (httpd, firewall, wireless, dnsmasq, etc.)
asuswrt_dhcp_serverEnable/disable DHCP server
asuswrt_upnpEnable/disable UPnP
asuswrt_radioEnable/disable Wi-Fi radio bands
asuswrt_guest_wifiEnable/disable guest Wi-Fi
asuswrt_guest_lan_accessToggle LAN access for guest Wi-Fi
asuswrt_port_forwardingList, add, remove, enable/disable port forwarding rules
asuswrt_vpn_serverEnable/disable OpenVPN server
asuswrt_parental_accessList, block, unblock, remove parental control rules
asuswrt_parental_block_allToggle block-all mode
asuswrt_dhcp_reservationList, add, remove DHCP static reservations
Safety Model
  • No arbitrary SSH: Only allowlisted commands are executed via NVRAM and service calls
  • No firmware operations: No flash, reset, or bootloader access
  • Secret redaction: Passwords and sensitive data are never exposed in tool responses
  • Dry-run support: Every mutation can be previewed before applying
  • Confirmation required: Mutations require explicit confirm=True
  • SSH-only transport: No exposure of the router's web API

Prerequisites

  • Python 3.11+
  • An AsusWRT or AsusWRT-Merlin router with SSH access enabled
  • Network connectivity from the MCP client to the router

Installation

1. Clone and setup
git clone https://github.com/Teeflo/asuswrt-mcp.git
cd asuswrt-mcp

# Create virtual environment
python -m venv .venv

# Activate (Linux/macOS)
source .venv/bin/activate

# Activate (Windows)
.venv\Scripts\activate

# Install dependencies
pip install -e .
2. Configure environment
# Copy example configuration
cp .env.example .env

# Edit with your router credentials
# Use your favorite editor:
notepad .env        # Windows
nano .env           # Linux/macOS
3. Configure .env
# Required: Router connection
ASUSWRT_HOST=192.168.1.1
ASUSWRT_SSH_USERNAME=admin
ASUSWRT_SSH_PASSWORD=your_password

# Optional: SSH key authentication
# ASUSWRT_SSH_KEY_FILE=~/.ssh/id_rsa

# Optional: Enable mutations (disabled by default)
# ASUSWRT_ALLOW_MUTATIONS=true

# Optional: Connection settings
# ASUSWRT_SSH_PORT=22
# ASUSWRT_TIMEOUT_SECONDS=10

Usage

Run the MCP server
# Standard stdio mode
python -m asuswrt_mcp.server

# Or use the entry point
asuswrt-mcp
Configure in Claude Desktop / Cursor

Add to your claude_desktop_config.json:

{
  "mcpServers": {
    "asuswrt-mcp": {
      "command": "C:\\path\\to\\asuswrt-mcp\\.venv\\Scripts\\python.exe",
      "args": ["-m", "asuswrt_mcp.server"],
      "env": {
        "ASUSWRT_HOST": "192.168.1.1",
        "ASUSWRT_SSH_USERNAME": "admin",
        "ASUSWRT_SSH_PASSWORD": "your_password"
      }
    }
  }
}
Using with npx Inspector (development)
npx @modelcontextprotocol/inspector python -m asuswrt_mcp.server

Development

Run tests
pip install -e ".[dev]"
pytest
Run with live router integration tests
ASUSWRT_TEST_ROUTER=1 pytest

Project Structure

asuswrt-mcp/
├── src/asuswrt_mcp/
│   ├── server.py          # FastMCP entrypoint & tool definitions
│   ├── service.py         # Business logic & router operations
│   ├── config.py          # Settings management
│   ├── clients/
│   │   └── ssh.py         # SSH client wrapper
│   ├── nvram.py           # NVRAM parsing utilities
│   ├── ssh_parsers.py     # Output parsers for SSH commands
│   ├── security.py        # Mutation guards & redaction
│   ├── validators.py      # Input validation
│   ├── responses.py       # Tool response formatting
│   ├── errors.py          # Custom exceptions
│   └── serialization.py   # Safe serialization
├── tests/                 # Test suite (69 tests)
├── .env.example           # Example configuration
├── pyproject.toml         # Project metadata
└── README.md              # This file

License

MIT License - see LICENSE for details.

Acknowledgments

الأسئلة الشائعة

ما هو io.github.teefloo/asuswrt-mcp؟

Secure AsusWRT router administration via SSH — 42+ tools, guarded mutations

كيف أثبّت io.github.teefloo/asuswrt-mcp؟

يعمل على جهازك. في Claude Code: claude mcp add asuswrt-mcp -e 'ASUSWRT_HOST=<ASUSWRT_HOST>' -e 'ASUSWRT_SSH_USERNAME=<ASUSWRT_SSH_USERNAME>' -e 'ASUSWRT_SSH_PASSWORD=<your asuswrt_ssh_password>' -e 'ASUSWRT_SSH_KEY_FILE=<ASUSWRT_SSH_KEY_FILE>' -e 'ASUSWRT_ALLOW_MUTATIONS=<ASUSWRT_ALLOW_MUTATIONS>' -- uvx asuswrt-mcp==0.1.1. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.

هل يحتاج io.github.teefloo/asuswrt-mcp إلى مفتاح API؟

نعم. يتطلب ASUSWRT_HOST, ASUSWRT_SSH_USERNAME, ASUSWRT_SSH_PASSWORD، وتضبطها في إعداداته.

هل io.github.teefloo/asuswrt-mcp مفتوح المصدر؟

نعم. شيفرته متاحة على GitHub بترخيص MIT.

من يصون io.github.teefloo/asuswrt-mcp؟

ينشره teefloo. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.

من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.