This server (mcp-server-vyos) provides an MCP interface to manage and monitor a VyOS router via its HTTPS REST API, covering configuration, diagnostics, system operations, and live documentation lookup.

Configuration & State Reading

• vyos_retrieve — Read configuration at any path

• vyos_return_values — Get multi-valued config node values

• vyos_exists — Check if a configuration path exists

• vyos_config_diff — Compare running config vs. saved config or a specific revision

• vyos_config_history — List revision history with timestamps, users, and methods

Configuration Changes

• vyos_configure — Apply a batch of set/delete operations atomically with commit-confirm (auto-reverts in 5 min unless confirmed)

• vyos_confirm — Confirm a pending commit-confirm to make changes permanent

• vyos_validate — Validate config syntax without persisting

• vyos_save / vyos_load / vyos_merge — Save, load, or merge configuration files

Operational / Show Commands

• vyos_info — Get system info

• vyos_show — Run any operational show command

• vyos_traceroute — Traceroute with structured MTR report

• vyos_interface_stats — RX/TX counters, errors, and link state

• vyos_system_resources — CPU, memory, storage, and uptime snapshot

• vyos_route_table — View routing table filtered by family and protocol

• vyos_firewall_stats — Firewall and NAT rule hit counters

• vyos_bgp_summary — BGP neighbor summary (state, uptime, prefixes received)

System Operations

• vyos_generate — Generate keys, certificates, etc.

• vyos_reset — Run reset commands (e.g., reset BGP peers)

• vyos_reboot / vyos_poweroff — Reboot or power off the router (with warnings)

• vyos_image_add / vyos_image_delete — Manage system images

Documentation

• vyos_docs_search — Search live VyOS documentation by topic

• vyos_docs_read — Read a specific VyOS documentation page (cached 1 hour)

Safety Features

• Read-only mode (VYOS_READ_ONLY=true) restricts the server to non-mutating tools

• Config changes use commit-confirm by default, auto-reverting if not confirmed within 5 minutes

• Destructive operations include explicit warning descriptions

• Accepts self-signed TLS certificates by default

Fetches and searches live VyOS documentation from the vyos-documentation repository on GitHub to provide documentation lookup tools.

1. Click on "Install Server".

2. Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.

3. In the chat, type @ followed by the MCP server name and your instructions, e.g., "@vyos-mcp show me the current interfaces and the active routing table"

That's it! The server will respond to your query, and you can continue using it as needed.

Here is a step-by-step guide with screenshots.