From 89f3d6f012915db8e2d46229d3cc51e5f834667f Mon Sep 17 00:00:00 2001 From: Thales Maciel Date: Sun, 8 Mar 2026 17:36:11 -0300 Subject: [PATCH] Align docs and Makefile with public release surface --- AGENTS.md | 2 +- Makefile | 6 +++++- README.md | 4 ++-- docs/host-requirements.md | 2 +- docs/install.md | 3 ++- docs/public-contract.md | 3 ++- src/pyro_mcp/ollama_demo.py | 2 +- 7 files changed, 14 insertions(+), 8 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 12b6a2b..b6bba17 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -48,7 +48,7 @@ These checks run in pre-commit hooks and should all pass locally. - Primary tool: - `vm_run` - Advanced lifecycle tools: - - `vm_list_profiles` + - `vm_list_environments` - `vm_create` - `vm_start` - `vm_exec` diff --git a/Makefile b/Makefile index b390b01..1ff0215 100644 --- a/Makefile +++ b/Makefile @@ -21,7 +21,7 @@ help: ' typecheck Run mypy' \ ' test Run pytest' \ ' check Run lint, typecheck, and tests' \ - ' dist-check Smoke-test the installed public pyro CLI entrypoint' \ + ' dist-check Smoke-test the installed pyro CLI and environment UX' \ ' demo Run the deterministic VM demo' \ ' network-demo Run the deterministic VM demo with guest networking enabled' \ ' doctor Show runtime and host diagnostics' \ @@ -64,7 +64,11 @@ check: lint typecheck test dist-check: .venv/bin/pyro --version .venv/bin/pyro --help >/dev/null + .venv/bin/pyro mcp --help >/dev/null + .venv/bin/pyro run --help >/dev/null .venv/bin/pyro env list >/dev/null + .venv/bin/pyro env inspect debian:12 >/dev/null + .venv/bin/pyro doctor >/dev/null demo: uv run pyro demo diff --git a/README.md b/README.md index 04b8ff1..6965699 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ The public user-facing interface is `pyro` and `Pyro`. ## Official Environments -Current curated environments in this repository: +Current official environments in the shipped catalog: - `debian:12` - `debian:12-base` @@ -89,7 +89,7 @@ Run the Ollama demo: ```bash ollama serve -ollama pull llama:3.2-3b +ollama pull llama3.2:3b pyro demo ollama ``` diff --git a/docs/host-requirements.md b/docs/host-requirements.md index 1b2838a..4023e39 100644 --- a/docs/host-requirements.md +++ b/docs/host-requirements.md @@ -6,7 +6,7 @@ - KVM available at `/dev/kvm` - support for Firecracker microVMs -- sufficient disk for the bundled runtime images +- sufficient disk for the embedded runtime files and cached OCI environment images ## Required For Guest Networking diff --git a/docs/install.md b/docs/install.md index 6841ac6..f06e691 100644 --- a/docs/install.md +++ b/docs/install.md @@ -35,9 +35,10 @@ uvx --from pyro-mcp pyro env list ## Installed CLI ```bash -uv tool install . +uv tool install pyro-mcp pyro --version pyro env list +pyro env inspect debian:12 pyro doctor ``` diff --git a/docs/public-contract.md b/docs/public-contract.md index df67b00..e8b09e0 100644 --- a/docs/public-contract.md +++ b/docs/public-contract.md @@ -7,6 +7,7 @@ This document defines the supported public interface for `pyro-mcp` `1.x`. - Distribution name: `pyro-mcp` - Public executable: `pyro` - Public Python import: `from pyro_mcp import Pyro` +- Public package-level factory: `from pyro_mcp import create_server` ## CLI Contract @@ -46,7 +47,7 @@ Primary facade: Supported public methods: -- `create_server()` +- `Pyro.create_server()` - `list_environments()` - `pull_environment(environment)` - `inspect_environment(environment)` diff --git a/src/pyro_mcp/ollama_demo.py b/src/pyro_mcp/ollama_demo.py index badaca6..1a590dd 100644 --- a/src/pyro_mcp/ollama_demo.py +++ b/src/pyro_mcp/ollama_demo.py @@ -14,7 +14,7 @@ from pyro_mcp.api import Pyro __all__ = ["Pyro", "run_ollama_tool_demo"] DEFAULT_OLLAMA_BASE_URL: Final[str] = "http://localhost:11434/v1" -DEFAULT_OLLAMA_MODEL: Final[str] = "llama:3.2-3b" +DEFAULT_OLLAMA_MODEL: Final[str] = "llama3.2:3b" MAX_TOOL_ROUNDS: Final[int] = 12 CLONE_TARGET_DIR: Final[str] = "hello-world" NETWORK_PROOF_COMMAND: Final[str] = (