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