Add persistent task workspace alpha
Start the first workspace milestone toward the task-oriented product without changing the existing one-shot vm_run/pyro run contract. Add a disk-backed task registry in the manager, auto-started task workspaces rooted at /workspace, repeated non-cleaning exec, and persisted command journals exposed through task create/exec/status/logs/delete across the CLI, Python SDK, and MCP server. Update the public contract, docs, examples, and version/catalog metadata for 2.1.0, and cover the new surface with manager, CLI, SDK, and MCP tests. Validation: UV_CACHE_DIR=.uv-cache make check and UV_CACHE_DIR=.uv-cache make dist-check.
This commit is contained in:
parent
6e16e74fd5
commit
58df176148
19 changed files with 1730 additions and 48 deletions
52
README.md
52
README.md
|
|
@ -1,6 +1,6 @@
|
|||
# pyro-mcp
|
||||
|
||||
`pyro-mcp` runs commands inside ephemeral Firecracker microVMs using curated Linux environments such as `debian:12`.
|
||||
`pyro-mcp` runs one-shot commands and repeated task workspaces inside ephemeral Firecracker microVMs using curated Linux environments such as `debian:12`.
|
||||
|
||||
[](https://pypi.org/project/pyro-mcp/)
|
||||
|
||||
|
|
@ -18,7 +18,7 @@ It exposes the same runtime in three public forms:
|
|||
- First run transcript: [docs/first-run.md](docs/first-run.md)
|
||||
- Terminal walkthrough GIF: [docs/assets/first-run.gif](docs/assets/first-run.gif)
|
||||
- PyPI package: [pypi.org/project/pyro-mcp](https://pypi.org/project/pyro-mcp/)
|
||||
- What's new in 2.0.1: [CHANGELOG.md#201](CHANGELOG.md#201)
|
||||
- What's new in 2.1.0: [CHANGELOG.md#210](CHANGELOG.md#210)
|
||||
- Host requirements: [docs/host-requirements.md](docs/host-requirements.md)
|
||||
- Integration targets: [docs/integrations.md](docs/integrations.md)
|
||||
- Public contract: [docs/public-contract.md](docs/public-contract.md)
|
||||
|
|
@ -55,7 +55,7 @@ What success looks like:
|
|||
```bash
|
||||
Platform: linux-x86_64
|
||||
Runtime: PASS
|
||||
Catalog version: 2.0.0
|
||||
Catalog version: 2.1.0
|
||||
...
|
||||
[pull] phase=install environment=debian:12
|
||||
[pull] phase=ready environment=debian:12
|
||||
|
|
@ -74,6 +74,7 @@ access to `registry-1.docker.io`, and needs local cache space for the guest imag
|
|||
After the quickstart works:
|
||||
|
||||
- prove the full one-shot lifecycle with `uvx --from pyro-mcp pyro demo`
|
||||
- create a persistent workspace with `uvx --from pyro-mcp pyro task create debian:12`
|
||||
- move to Python or MCP via [docs/integrations.md](docs/integrations.md)
|
||||
|
||||
## Supported Hosts
|
||||
|
|
@ -127,7 +128,7 @@ uvx --from pyro-mcp pyro env list
|
|||
Expected output:
|
||||
|
||||
```bash
|
||||
Catalog version: 2.0.0
|
||||
Catalog version: 2.1.0
|
||||
debian:12 [installed|not installed] Debian 12 environment with Git preinstalled for common agent workflows.
|
||||
debian:12-base [installed|not installed] Minimal Debian 12 environment for shell and core Unix tooling.
|
||||
debian:12-build [installed|not installed] Debian 12 environment with Git and common build tools preinstalled.
|
||||
|
|
@ -191,11 +192,27 @@ When you are done evaluating and want to remove stale cached environments, run `
|
|||
If you prefer a fuller copy-pasteable transcript, see [docs/first-run.md](docs/first-run.md).
|
||||
The walkthrough GIF above was rendered from [docs/assets/first-run.tape](docs/assets/first-run.tape) using [scripts/render_tape.sh](scripts/render_tape.sh).
|
||||
|
||||
## Persistent Tasks
|
||||
|
||||
Use `pyro run` for one-shot commands. Use `pyro task ...` when you need repeated commands in one
|
||||
workspace without recreating the sandbox every time.
|
||||
|
||||
```bash
|
||||
pyro task create debian:12
|
||||
pyro task exec TASK_ID -- sh -lc 'printf "hello from task\n" > note.txt'
|
||||
pyro task exec TASK_ID -- cat note.txt
|
||||
pyro task logs TASK_ID
|
||||
pyro task delete TASK_ID
|
||||
```
|
||||
|
||||
Task workspaces start in `/workspace` and keep command history until you delete them. For machine
|
||||
consumption, add `--json` and read the returned `task_id`.
|
||||
|
||||
## Public Interfaces
|
||||
|
||||
The public user-facing interface is `pyro` and `Pyro`. After the CLI validation path works, you can choose one of three surfaces:
|
||||
|
||||
- `pyro` for direct CLI usage
|
||||
- `pyro` for direct CLI usage, including one-shot `run` and persistent `task` workflows
|
||||
- `from pyro_mcp import Pyro` for Python orchestration
|
||||
- `pyro mcp serve` for MCP clients
|
||||
|
||||
|
|
@ -325,6 +342,22 @@ print(pyro.list_environments())
|
|||
print(pyro.inspect_environment("debian:12"))
|
||||
```
|
||||
|
||||
For repeated commands in one workspace:
|
||||
|
||||
```python
|
||||
from pyro_mcp import Pyro
|
||||
|
||||
pyro = Pyro()
|
||||
task = pyro.create_task(environment="debian:12")
|
||||
task_id = task["task_id"]
|
||||
try:
|
||||
pyro.exec_task(task_id, command="printf 'hello from task\\n' > note.txt")
|
||||
result = pyro.exec_task(task_id, command="cat note.txt")
|
||||
print(result["stdout"], end="")
|
||||
finally:
|
||||
pyro.delete_task(task_id)
|
||||
```
|
||||
|
||||
## MCP Tools
|
||||
|
||||
Primary agent-facing tool:
|
||||
|
|
@ -343,10 +376,19 @@ Advanced lifecycle tools:
|
|||
- `vm_network_info(vm_id)`
|
||||
- `vm_reap_expired()`
|
||||
|
||||
Persistent workspace tools:
|
||||
|
||||
- `task_create(environment, vcpu_count=1, mem_mib=1024, ttl_seconds=600, network=false, allow_host_compat=false)`
|
||||
- `task_exec(task_id, command, timeout_seconds=30)`
|
||||
- `task_status(task_id)`
|
||||
- `task_logs(task_id)`
|
||||
- `task_delete(task_id)`
|
||||
|
||||
## Integration Examples
|
||||
|
||||
- Python one-shot SDK example: [examples/python_run.py](examples/python_run.py)
|
||||
- Python lifecycle example: [examples/python_lifecycle.py](examples/python_lifecycle.py)
|
||||
- Python task workspace example: [examples/python_task.py](examples/python_task.py)
|
||||
- MCP client config example: [examples/mcp_client_config.md](examples/mcp_client_config.md)
|
||||
- Claude Desktop MCP config: [examples/claude_desktop_mcp_config.json](examples/claude_desktop_mcp_config.json)
|
||||
- Cursor MCP config: [examples/cursor_mcp_config.json](examples/cursor_mcp_config.json)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue