mcp服务器vyos
MCP服务器，用于通过HTTPS REST API管理VyOS路由器。提供路由器管理工具和实时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
set service https api rest
commit
save克劳德代码
添加到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_info | 系统信息（无需身份验证） |
vyos_retrieve | 读取路径上的配置 |
vyos_return_values | 获取多值配置节点值 |
vyos_exists | 检查配置路径是否存在 |
vyos_config_diff | 显示配置差异（保存与运行，或按修订） |
vyos_show | 运行操作显示命令 |
vyos_validate | 验证配置语法（临时应用自动回滚） |
vyos_configure | 使用提交确认应用配置（安全默认） |
vyos_confirm | 确认待处理的提交确认 |
vyos_save | 将运行配置保存到磁盘 |
vyos_load | 加载配置文件 |
vyos_merge | 将配置文件或字符串合并到正在运行的配置中 |
vyos_generate | 生成密钥、证书等。 |
vyos_reset | 重置操作 |
vyos_reboot | 重新启动路由器 |
vyos_poweroff | 关闭路由器电源 |
vyos_image_add | 从URL添加系统映像 |
vyos_image_delete | 删除系统映像 |
文档
| 工具 | 说明 |
|---|---|
vyos_docs_search | 按主题搜索VyOS文档 |
vyos_docs_read | 阅读特定的文档页面 |
文档从实时获取 vyos文档 存储库，因此它与最新的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 .许可证
麻省理工学院