mcp-server-vyos

MCP-сервер для управления маршрутизатором VyOS через HTTPS REST API. Предоставляет как инструменты управления маршрутизатором, так и поиск актуальной документации VyOS.

Установка

pip install mcp-server-vyos

Конфигурация

Установите переменные окружения:

• VYOS_URL — эндпоинт API маршрутизатора (например, https://vyos.example.com)

• VYOS_API_KEY — API-ключ для аутентификации

• VYOS_READ_ONLY — установите в true, чтобы отключить все инструменты, изменяющие состояние (изменение конфигурации, перезагрузка, выключение и т. д.)

Настройка маршрутизатора VyOS

Включите HTTPS API на вашем маршрутизаторе VyOS:

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

Claude Code

Добавьте в конфигурацию вашего MCP-клиента:

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

Режим «только чтение»

Для безопасного доступа только для чтения (мониторинг, расследование, поиск документации) включите режим «только чтение»:

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

Это зарегистрирует только инструменты, не изменяющие состояние: vyos_info, vyos_retrieve, vyos_return_values, vyos_exists, vyos_config_diff, vyos_show, vyos_docs_search и vyos_docs_read.

Инструменты

Управление маршрутизатором

Документация

Документация загружается в реальном времени из репозитория vyos-documentation, поэтому она всегда синхронизирована с последними релизами VyOS. Результаты кэшируются на 1 час.

Безопасность

• Изменения конфигурации по умолчанию используют commit-confirm — изменения автоматически откатываются через 5 минут, если не подтверждены командой vyos_confirm

• Деструктивные операции (vyos_reboot, vyos_poweroff, vyos_image_delete) содержат предупреждающие описания

• API-ключи никогда не логируются и не включаются в вывод инструментов

• Самоподписанные TLS-сертификаты принимаются по умолчанию (обычное дело для VyOS)

Разработка

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

Лицензия

MIT