mcp-server-vyos

MCP-Server für die Verwaltung von VyOS-Routern über die HTTPS-REST-API. Bietet sowohl Tools zur Router-Verwaltung als auch den Zugriff auf die aktuelle VyOS-Dokumentation.

Installation

pip install mcp-server-vyos

Konfiguration

Umgebungsvariablen festlegen:

• VYOS_URL — Router-API-Endpunkt (z. B. https://vyos.example.com)

• VYOS_API_KEY — API-Schlüssel für die Authentifizierung

• VYOS_READ_ONLY — Auf true setzen, um alle verändernden Tools zu deaktivieren (Konfigurationsänderungen, Neustart, Ausschalten usw.)

Einrichtung des VyOS-Routers

Aktivieren Sie die HTTPS-API auf Ihrem VyOS-Router:

configure
set service https api keys id my-mcp-key key <your-api-key>
set service https api rest
commit
save

Claude Code

Fügen Sie dies zu Ihrer MCP-Client-Konfiguration hinzu:

{
  "mcpServers": {
    "vyos": {
      "command": "mcp-server-vyos",
      "env": {
        "VYOS_URL": "https://vyos.example.com",
        "VYOS_API_KEY": "your-api-key"
      }
    }
  }
}

Schreibgeschützter Modus

Für einen sicheren, reinen Lesezugriff (Überwachung, Untersuchung, Dokumentationssuche) aktivieren Sie den schreibgeschützten Modus:

{
  "mcpServers": {
    "vyos": {
      "command": "mcp-server-vyos",
      "env": {
        "VYOS_URL": "https://vyos.example.com",
        "VYOS_API_KEY": "your-api-key",
        "VYOS_READ_ONLY": "true"
      }
    }
  }
}

Dies registriert nur nicht-verändernde Tools: vyos_info, vyos_retrieve, vyos_return_values, vyos_exists, vyos_config_diff, vyos_show, vyos_docs_search und vyos_docs_read.

Tools

Router-Verwaltung

Dokumentation

Die Dokumentation wird live aus dem vyos-documentation Repository abgerufen und bleibt somit mit den neuesten VyOS-Releases synchron. Ergebnisse werden für 1 Stunde zwischengespeichert.

Sicherheit

• Konfigurationsänderungen verwenden standardmäßig commit-confirm -- Änderungen werden nach 5 Minuten automatisch rückgängig gemacht, sofern sie nicht mit vyos_confirm bestätigt werden

• Destruktive Operationen (vyos_reboot, vyos_poweroff, vyos_image_delete) enthalten Warnbeschreibungen

• API-Schlüssel werden niemals protokolliert oder in Tool-Ausgaben aufgenommen

• Selbstsignierte TLS-Zertifikate werden standardmäßig akzeptiert (üblich bei VyOS)

Entwicklung

uv venv && source .venv/bin/activate
uv pip install -e ".[dev]"
pytest
ruff check .

Lizenz

MIT