parallels-pro-mcp-server 0.2.0__tar.gz

parallels_pro_mcp_server-0.2.0/.github/workflows/ci.yml

@@ -0,0 +1,61 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: Test (Python ${{ matrix.python-version }} on ${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, ubuntu-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          version: "latest"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --python ${{ matrix.python-version }}
+
+      - name: Run unit test suite with coverage
+        run: |
+          uv run --python ${{ matrix.python-version }} coverage run --source=parallels_mcp -m unittest discover -s tests
+          uv run --python ${{ matrix.python-version }} coverage report -m
+
+      - name: Report coverage summary
+        run: |
+          echo "### 📊 Test Coverage Report (Python ${{ matrix.python-version }} on ${{ matrix.os }})" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          uv run --python ${{ matrix.python-version }} coverage report --format=markdown >> $GITHUB_STEP_SUMMARY
+          uv run --python ${{ matrix.python-version }} coverage xml -o coverage.xml
+
+      - name: Upload coverage artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-${{ matrix.os }}-py${{ matrix.python-version }}
+          path: coverage.xml
+          retention-days: 14
+
+      - name: Verify compilation
+        run: uv run --python ${{ matrix.python-version }} python -m compileall -q parallels_mcp main.py
+
+      - name: Validate lockfile consistency
+        run: uv lock --check
+
+      - name: Validate doctor script syntax
+        run: bash -n scripts/doctor.sh

parallels_pro_mcp_server-0.2.0/.github/workflows/release.yml

@@ -0,0 +1,59 @@
+name: Release & Publish
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+    inputs:
+      python_version:
+        description: "Python version used to build release distributions"
+        required: false
+        default: "3.12"
+
+env:
+  PYTHON_VERSION: ${{ inputs.python_version || '3.12' }}
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  release:
+    name: Build, Release & Publish
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/parallels-pro-mcp-server
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          version: "latest"
+
+      - name: Set up Python ${{ env.PYTHON_VERSION }}
+        run: uv python install ${{ env.PYTHON_VERSION }}
+
+      - name: Build distribution packages
+        run: uv build --python ${{ env.PYTHON_VERSION }}
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/
+          skip-existing: true

parallels_pro_mcp_server-0.2.0/.gitignore

@@ -0,0 +1,165 @@
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+.DS_Store

parallels_pro_mcp_server-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jarod Wong
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

parallels_pro_mcp_server-0.2.0/PKG-INFO

@@ -0,0 +1,360 @@
+Metadata-Version: 2.5
+Name: parallels-pro-mcp-server
+Version: 0.2.0
+Summary: A Model Context Protocol (MCP) server for Parallels Desktop VM automation, lifecycle, execution, snapshots, and screenshots on macOS.
+Author: Jarod Wong
+License-Expression: MIT
+License-File: LICENSE
+Keywords: ai,automation,llm,macos,mcp,parallels,virtualization
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.10
+Requires-Dist: mcp<3,>=2.0
+Requires-Dist: pydantic<3,>=2.0
+Description-Content-Type: text/markdown
+
+# Parallels Pro MCP Server
+
+[![CI](https://github.com/PopBot/parallels-pro-mcp-server/actions/workflows/ci.yml/badge.svg)](https://github.com/PopBot/parallels-pro-mcp-server/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Python >=3.10](https://img.shields.io/badge/python-3.10%2B-blue)](https://www.python.org/downloads/)
+
+A Model Context Protocol (MCP) server for Parallels Desktop on macOS. It enables LLM agents—such as Claude Desktop, ChatGPT Codex, Cursor, and Antigravity—to discover, control, automate, and inspect Parallels virtual machines over standard MCP stdio.
+
+## Highlights
+
+- **Full Lifecycle Management**: Start, gracefully stop (ACPI), and suspend virtual machines.
+- **Cross-Platform Guest Execution**: Execute commands inside Windows, Linux, or macOS guests with explicit argument vectors (`argv`), avoiding host shell injection risks.
+- **Readiness Probing**: Automatically detects guest OS and polls until Parallels Tools and the guest execution layer respond.
+- **Bi-Directional File Transfer**: Stream files and directories directly between host and guest over stdin/stdout tar archives without requiring network mounts or SMB credentials (`vm_copy_to_guest`, `vm_copy_from_guest`).
+- **Dynamic Host Folder Sharing**: Mount and unmount host directories into guest VMs at runtime with read-only or read-write permissions (`vm_share_folder`, `vm_unshare_folder`).
+- **Instant Sandboxing & Ephemeral Clones**: Spin up fast linked clones in seconds for disposable agent test environments, and permanently delete sandboxes with confirmation (`vm_clone`, `vm_delete`).
+- **Headless Execution & Network Simulation**: Run VMs headlessly in the background, or simulate network degradation (edge, 3g, wifi, 100% packet loss, offline) for resilience testing (`vm_set_headless`, `vm_set_network_condition`).
+- **Visual VM Inspection**: Capture real-time screenshots of the VM display buffer for multimodal AI analysis (`vm_screenshot`).
+- **Synthetic Input & Hotkeys**: Send keyboard events and hotkey combinations (`Ctrl+Alt+Del`, `Win+R`, `Enter`, `Esc`) to interact with GUI dialogs and prompts (`vm_send_keys`).
+- **Snapshot Lifecycle**: List, create, safely revert, and delete snapshots with mandatory confirmation flags (`confirm: true`).
+- **Pre-flight Diagnostic Doctor**: Built-in environment and license validator (`parallels-pro-mcp doctor` and `scripts/doctor.sh`).
+
+---
+
+## Tool Reference
+
+| Tool | Purpose | Confirmation Required | Annotations |
+|---|---|---|---|
+| `vm_list` | Discover registered VMs and power states | No | Read-Only |
+| `vm_status` | Inspect detailed VM status, OS, tools version, and uptime | No | Read-Only |
+| `vm_start` | Start a VM by name or UUID | No | Power Change |
+| `vm_stop` | Request graceful ACPI shutdown (never force-kills) | No | Destructive |
+| `vm_suspend` | Suspend VM and preserve guest memory | No | Destructive |
+| `vm_wait_ready` | Poll until the guest OS answers execution probes | No | Readiness |
+| `vm_exec` | Run an argv vector in the guest (supports custom `user`) | No (Privileged) | Guest Command |
+| `vm_copy_to_guest` | Stream files or directories from host into guest filesystem | No | File Transfer |
+| `vm_copy_from_guest` | Stream files or directories from guest onto host filesystem | No | File Transfer |
+| `vm_share_folder` | Mount a host directory into the guest (`rw` or `ro`) | No | State Mutating |
+| `vm_unshare_folder` | Remove a previously shared host directory | No | State Mutating |
+| `vm_clone` | Clone a VM (fast linked clone or deep copy) | No | State Mutating |
+| `vm_delete` | Permanently delete a VM and its disks | `confirm: true` | Destructive |
+| `vm_set_headless` | Configure headless vs GUI window startup mode | No | State Mutating |
+| `vm_set_network_condition` | Simulate degraded network profiles (3g, wifi, loss, off) | No | State Mutating |
+| `vm_screenshot` | Capture current VM screen to host PNG | No | Read-Only |
+| `vm_send_keys` | Send synthetic keystrokes or chords (e.g. `ctrl+alt+del`, `win+r`) | No | Guest Command |
+| `snapshot_list` | List all snapshots for a VM | No | Read-Only |
+| `snapshot_create` | Create a snapshot with name and optional description | `confirm: true` | State Mutating |
+| `snapshot_revert` | Revert VM state to a specified snapshot | `confirm: true` | State Mutating |
+| `snapshot_delete` | Permanently delete a snapshot to reclaim host disk space | `confirm: true` | State Mutating |
+
+---
+
+## Tool Usage & Cookbook
+
+### 1. Instant Ephemeral Sandboxing
+Create an isolated linked clone in seconds, run tests headlessly, and destroy it when finished:
+
+```python
+# Spin up an instant linked clone sharing the base disk
+vm_clone(vm="Windows 11", name="Win11-Worker-1", linked=True)
+
+# Run headlessly without displaying a GUI window on the desktop
+vm_set_headless(vm="Win11-Worker-1", enabled=True)
+
+# Boot and wait until guest tools are ready
+vm_start(vm="Win11-Worker-1")
+vm_wait_ready(vm="Win11-Worker-1", timeout_s=120)
+
+# ... perform testing or build tasks ...
+
+# Graceful stop and permanent teardown
+vm_stop(vm="Win11-Worker-1")
+vm_delete(vm="Win11-Worker-1", confirm=True)
+```
+
+### 2. Bi-Directional File Transfer
+Stream files or entire directory trees between host and guest over stdin/stdout tar archives without needing network mounts or SMB credentials:
+
+```python
+# Push local build artifact into the guest Windows Temp folder
+vm_copy_to_guest(
+    vm="Windows 11",
+    host_path="./dist/myapp.exe",
+    guest_path=r"C:\Temp\myapp.exe"
+)
+
+# Pull test logs or crash dumps back onto the host
+vm_copy_from_guest(
+    vm="Windows 11",
+    guest_path=r"C:\Temp\test-results",
+    host_path="./reports/test-results"
+)
+```
+
+### 3. Dynamic Host Folder Sharing
+Mount local host directories directly into the VM at runtime:
+
+```python
+# Share a host repository with read-only protection
+vm_share_folder(
+    vm="Windows 11",
+    name="source_code",
+    host_path="~/projects/myapp",
+    mode="ro"
+)
+
+# Unmount the share when done
+vm_unshare_folder(vm="Windows 11", name="source_code")
+```
+
+### 4. GUI Interaction & Screen Analysis
+Interact with native GUI dialogs, installers, or Windows UAC prompts:
+
+```python
+# Capture what is currently on the VM screen
+vm_screenshot(vm="Windows 11")
+
+# Press Win+R to open the Run dialog
+vm_send_keys(vm="Windows 11", combination="win+r")
+
+# Type a command and press Enter
+vm_send_keys(vm="Windows 11", text="notepad.exe", keys=["enter"])
+
+# Dismiss a modal with Escape
+vm_send_keys(vm="Windows 11", keys=["esc"])
+```
+
+### 5. Network Simulation & Resilience Testing
+Simulate poor connections or complete offline states:
+
+```python
+# Throttle bandwidth and latency to emulate a 3G mobile link
+vm_set_network_condition(vm="Windows 11", profile="3g")
+
+# Simulate a network blackout (100% packet loss)
+vm_set_network_condition(vm="Windows 11", profile="100-percent-loss")
+
+# Restore normal network conditions
+vm_set_network_condition(vm="Windows 11", profile="off")
+```
+
+### 6. Snapshot Baselines
+Create rollback points before mutating system state:
+
+```python
+# List snapshots
+snapshot_list(vm="Windows 11")
+
+# Create a checkpoint
+snapshot_create(
+    vm="Windows 11",
+    name="clean-state",
+    description="Clean baseline before test execution",
+    confirm=True
+)
+
+# Revert back to the checkpoint
+snapshot_revert(vm="Windows 11", snapshot="clean-state", confirm=True)
+
+# Delete snapshot to reclaim host disk space
+snapshot_delete(vm="Windows 11", snapshot="clean-state", confirm=True)
+```
+
+---
+
+## Prerequisites
+
+1. **macOS** with [Parallels Desktop](https://www.parallels.com/) Pro or Business Edition installed.
+   - *Note*: Parallels Desktop Pro or Business is required for the `prlctl` command-line utility and `prlctl exec` guest execution.
+2. **Parallels Tools** installed inside each target guest VM.
+3. **Python 3.10+** and [`uv`](https://docs.astral.sh/uv/) (recommended).
+
+### Verify Your Environment
+
+Before connecting an MCP client, run the pre-flight diagnostic:
+
+```bash
+# Using uv:
+uv run parallels-pro-mcp doctor
+
+# Or using the standalone script:
+./scripts/doctor.sh
+```
+
+---
+
+## Client Configuration
+
+### Claude Desktop
+
+Add the following to `~/Library/Application Support/Claude/claude_desktop_config.json`:
+
+```json
+{
+  "mcpServers": {
+    "parallels-pro": {
+      "command": "uvx",
+      "args": ["parallels-pro-mcp-server"],
+      "env": {
+        "PARALLELS_DEFAULT_VM": "Windows 11",
+        "PARALLELS_ARTIFACT_DIR": "~/.cache/parallels-mcp"
+      }
+    }
+  }
+}
+```
+
+Or when running from a local checkout:
+
+```json
+{
+  "mcpServers": {
+    "parallels-pro": {
+      "command": "uv",
+      "args": [
+        "run",
+        "--directory",
+        "/path/to/parallels-pro-mcp-server",
+        "parallels-pro-mcp"
+      ]
+    }
+  }
+}
+```
+
+### Codex / ChatGPT Desktop
+
+In `~/.codex/config.toml`:
+
+```toml
+[mcp_servers.parallels-pro]
+command = "uv"
+args = ["run", "--project", "/path/to/parallels-pro-mcp-server", "parallels-pro-mcp"]
+startup_timeout_sec = 30
+tool_timeout_sec = 600
+
+[mcp_servers.parallels-pro.env]
+PARALLELS_DEFAULT_VM = "Windows 11"
+PARALLELS_ARTIFACT_DIR = "~/.cache/parallels-mcp"
+```
+
+### Google Antigravity (Gemini CLI)
+
+Add the server to `~/.gemini/config/mcp_config.json`:
+
+```json
+{
+  "mcpServers": {
+    "parallels-pro": {
+      "command": "uv",
+      "args": [
+        "run",
+        "--directory",
+        "/path/to/parallels-pro-mcp-server",
+        "parallels-pro-mcp"
+      ],
+      "env": {
+        "PARALLELS_DEFAULT_VM": "Windows 11",
+        "PARALLELS_ARTIFACT_DIR": "~/.cache/parallels-mcp"
+      }
+    }
+  }
+}
+```
+
+Or using `uvx`:
+
+```json
+{
+  "mcpServers": {
+    "parallels-pro": {
+      "command": "uvx",
+      "args": ["parallels-pro-mcp-server"]
+    }
+  }
+}
+```
+
+---
+
+## Environment Variables
+
+| Variable | Description | Default |
+|---|---|---|
+| `PARALLELS_DEFAULT_VM` | Fallback VM name or UUID used when a tool argument is omitted | None |
+| `PARALLELS_ARTIFACT_DIR` | Host directory where captured screenshots and artifacts are stored | `~/.cache/parallels-pro-mcp-server` |
+
+---
+
+## Safe Operating Sequence for Agents
+
+1. **Discover**: Call `vm_list` to see available VMs and states.
+2. **Inspect**: Call `vm_status(vm="...")` to verify guest tools and power status.
+3. **Optional Sandbox**: For risky or destructive test sessions, call `vm_clone(vm="...", name="agent-sandbox", linked=true)` to create a fast, isolated linked clone.
+4. **Power Up**: If stopped, call `vm_start` followed by `vm_wait_ready` to ensure guest tools are responsive.
+5. **Inspect Desktop**: Call `vm_screenshot` to visually check if dialogs or login prompts are blocking the session.
+6. **Snapshot Baseline**: Call `snapshot_create(vm="...", name="clean-baseline", confirm=true)` before performing major tasks.
+7. **Transfer & Execute**: Use `vm_copy_to_guest` to stage scripts, `vm_exec` with explicit argv arrays to run commands, and `vm_copy_from_guest` to retrieve build artifacts.
+8. **Teardown**: Revert via `snapshot_revert` or destroy ephemeral sandboxes via `vm_delete(vm="agent-sandbox", confirm=true)`.
+
+---
+
+## Security Model
+
+- **Automation Bridge**: This server delegates guest execution directly to `prlctl exec`.
+- **Privilege & Shared Folders**: If your VM has Parallels Shared Folders enabled (e.g. `\\Mac\Home` on Windows or `/media/psf/` on Linux), guest commands can read and write to your host filesystem. Always run only on trusted virtual machines.
+- **Explicit Argv Only**: `vm_exec` only accepts argument vectors (`list[str]`), preventing shell injection on the host.
+
+---
+
+## Development & Testing
+
+```bash
+# Clone the repository
+git clone https://github.com/PopBot/parallels-pro-mcp-server.git
+cd parallels-pro-mcp-server
+
+# Install dependencies and sync environment
+uv sync
+
+# Run diagnostic doctor
+uv run parallels-pro-mcp doctor
+
+# Run test suite with test coverage reporting
+uv run coverage run --source=parallels_mcp -m unittest discover -s tests
+uv run coverage report -m
+```
+
+For instructions on semantic versioning, GitHub Releases, and PyPI distribution, see the [Releasing & Publishing Guide](docs/RELEASING.md).
+
+---
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).