# Requirements: vmcluster-mcp v1.1

**Milestone:** v1.1 Installation Ease-of-Use
**Status:** Active
**Last updated:** 2026-03-24

---

## v1.1 Requirements

### Installation

- [x] **INST-01**: User can install vmcluster-mcp from PyPI with a single command (`pip install vmcluster-mcp` or `uvx vmcluster-mcp`)

### Setup Wizard

- [ ] **INST-02**: User can run `vmcluster-mcp setup` to launch an interactive setup wizard
- [ ] **INST-03**: Setup wizard prompts for required config values (overlay_dir, base_image path, ssh_key_path, ssh_user) and writes a valid `config.yaml`
- [ ] **INST-04**: Setup wizard checks host dependencies (libvirt daemon, QEMU/KVM, libvirt-python system libs) and provides distro-specific install commands (apt, dnf, pacman) for any missing ones

### Base Image

- [ ] **INST-05**: Setup wizard offers to download a known-good Ubuntu/Debian cloud image to the configured base image path and verifies its sha256 checksum after download

### MCP Client Configuration

- [ ] **INST-06**: Setup wizard detects the user's MCP client config (claude-code `~/.claude.json` or Claude Desktop config) and writes the vmcluster-mcp server entry automatically, preserving existing entries

---

## Future Requirements

- **INST-07**: PyPI releases are published automatically via GitHub Actions on git tag push (OIDC trusted publishing) — deferred; manual publish acceptable for v1.1

---

## Out of Scope

- Multi-platform installers (Homebrew, apt repo, rpm) — pip/uvx is sufficient for developer audience
- Windows support — libvirt/QEMU constraint requires Linux host
- Docker/container-based install — VM lifecycle requires native host access
- GUI installer — CLI wizard is the right interface for a developer tool

---

## Traceability

| REQ-ID  | Phase | Phase Name       | Status  |
|---------|-------|------------------|---------|
| INST-01 | 11    | PyPI Packaging   | Pending |
| INST-02 | 12    | Setup Wizard     | Pending |
| INST-03 | 12    | Setup Wizard     | Pending |
| INST-04 | 12    | Setup Wizard     | Pending |
| INST-05 | 12    | Setup Wizard     | Pending |
| INST-06 | 12    | Setup Wizard     | Pending |

---

*Created: 2026-03-24 — v1.1 requirements*
