# pve-mcp-server

Read-only Proxmox VE MCP server — 25 tools for VM/LXC/node/storage/cluster inspection.
Single cluster per instance, stdio transport only.

## Config

Copy [`config.example.json`](config.example.json) to `~/.pve-mcp-server/config.json`
(`%USERPROFILE%\.pve-mcp-server\config.json` on Windows) and fill in your values:

```json
{
  "host": "pve-node.domain.local",
  "port": 8006,
  "token_user": "user@realm",
  "token_name": "tokenname",
  "token_secret": "00000000-0000-0000-0000-000000000000"
}
```

Recommended token role: `PVEAuditor` (read-only) — every tool issues `GET` requests only.

## Use via uvx (no local install)

```json
{
  "mcpServers": {
    "pve": {
      "command": "uvx",
      "args": ["--from", "git+https://github.com/UriWise/pve-mcp-server", "pve-mcp-server"]
    }
  }
}
```

## Local development

```powershell
uv sync
uv run pve-mcp-server
```

## Tools

`pve_list_vms`, `pve_get_vm_disks`, `pve_get_storage`, `pve_get_snapshots`, `pve_get_nodes`,
`pve_get_vm_config`, `pve_get_vm_status`, `pve_get_cluster_resources`, `pve_list_lxc`,
`pve_get_node_status`, `pve_get_node_network`, `pve_get_node_disks`, `pve_get_storage_content`,
`pve_get_cluster_tasks`, `pve_get_backup_jobs`, `pve_get_ha_status`, `pve_get_replication_jobs`,
`pve_get_firewall_rules`, `pve_get_vm_agent`, `pve_get_vm_rrddata`, `pve_get_node_rrddata`,
`pve_get_node_services`, `pve_get_node_pci`, `pve_get_vm_pending`, `pve_get_node_certificates`