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을 사용합니다. vyos_confirm으로 확인하지 않으면 5분 후 변경 사항이 자동으로 되돌려집니다.

• 파괴적인 작업(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