mcp-server-vyos

用于通过 HTTPS REST API 管理 VyOS 路由器的 MCP 服务器。提供路由器管理工具和实时 VyOS 文档查询功能。

安装

pip install mcp-server-vyos

配置

设置环境变量：

• VYOS_URL — 路由器 API 端点（例如 https://vyos.example.com）

• VYOS_API_KEY — 用于身份验证的 API 密钥

• VYOS_READ_ONLY — 设置为 true 以禁用所有变更性工具（配置更改、重启、关机等）

VyOS 路由器设置

在您的 VyOS 路由器上启用 HTTPS API：

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