VyManager에 의해 구동되는 VyOS 라우터에 대한 MCP 서버.

VyMCP는 VyManager API를 통해 VyOS 라우터를 읽고 관리합니다. VyManager의 인증, RBAC, 감사 및 커밋 확인 안전. 라우터에 직접 이야기하지 않습니다.

Status: 알파. 로컬 (stdio) 또는 공유 호스팅 서버 (http); 인터페이스가 변경 될 수 있습니다.

설치

또는 pip install . 클론에서, 또는 도커 이미지를 실행 ghcr.io/community-vyprojects/vymcp ([T2]]).

구성

환경 변수 설정 (.env.example]):

| 변수 |필수 | 용도 | |—||||| | [T4] | 예 | VyManager API URL | | VYMANAGER_API_TOKEN | 예 | A vym_ 토큰 (사이트 → API 토큰; 읽기 전용) | | VYMANAGER_ENABLE_WRITES | no | Enable write tools (기본 해제) |

VYMANAGER_VERIFY_SSL] (기본 true) 및 VYMANAGER_TIMEOUT] (기본 30) 옵션입니다.

MCP 클라이언트 연결

Hosted 배포 (공유 서버)

많은 엔지니어가 HTTP에 연결 한 VyMCP를 실행, 각 인증 요청당 자신의 VyManager 토큰:

VYMANAGER_BASE_URL과 VYMCP_PUBLIC_URL]을 compose 파일에 설정합니다. 엔지니어 점

VyMCP

MCP server for VyOS routers, powered by VyManager.

VyMCP lets AI agents read and manage VyOS routers through the VyManager API — inheriting VyManager’s authentication, RBAC, audit, and commit-confirm safety. It never talks to routers directly.

Status: alpha. Runs local (stdio) or as a shared hosted server (http); interfaces may change.

Install

pipx install git+https://github.com/Community-VyProjects/VyMCP   # provides `vymcp`

Or pip install . from a clone, or run the Docker image ghcr.io/community-vyprojects/vymcp (attached, with -i).

Configure

Set environment variables (see .env.example):

VYMANAGER_VERIFY_SSL (default true) and VYMANAGER_TIMEOUT (default 30) are optional.

Connect an MCP client

{
  "mcpServers": {
    "vymcp": {
      "command": "vymcp",
      "env": {
        "VYMANAGER_BASE_URL": "https://vymanager.example.com",
        "VYMANAGER_API_TOKEN": "vym_…"
      }
    }
  }
}

Hosted deployment (shared server)

Run one VyMCP that many engineers connect to over HTTP, each authenticating with their own VyManager token per request:

docker compose up -d          # see docker-compose.yml

Set VYMANAGER_BASE_URL and VYMCP_PUBLIC_URL in the compose file. Engineers point their MCP client at https:///mcp with Authorization: Bearer vym_…. Terminate TLS at a reverse proxy and run a single replica (the pending-change store is in-memory).

Tools

• Read (always): list_instances, list_features, get_capabilities, get_config.
• Write (only when VYMANAGER_ENABLE_WRITES=true): describe_feature_operations + propose_operations cover ~86 features; apply_change / confirm_change / discard_changes / get_pending_changes drive the rollout.

Writes are safe by design: off by default, capped to the token’s scope, and gated by a propose → apply flow. apply_change requires explicit confirmation and rides VyManager’s commit-confirm auto-rollback (a lockout safety net) — it never auto-confirms.

Development

pip install -e ".[dev]"
pytest && ruff check . && mypy

License

GPLv3 — see LICENSE.