@hmv-labs/agent-runner-mcp 0.0.1 → 0.0.2

package/README.md

@@ -71,12 +71,12 @@ Runs one worker task, falling back through the model chain until a result is val
 | `model`       | string                          |            | Pin one of the provider's models from `list_providers`; no fallback.     |
 | `effort`      | `low` \| `medium` \| `high`     | `medium`   | agy: each family's variant at this effort; codex: the reasoning effort.  |
 | `timeout_sec` | integer, 30–3600                | `900`      | Per attempt.                                                             |
-| `sha`         | string                          | `HEAD`     | `readonly` only: the commit to check out.                                |
+| `sha`         | string                          |            | `readonly` only: the commit to check out; omit it for the working tree.  |
 | `report_path` | string                          |            | Save the valid report to this file and return only the envelope.         |
 
-**`mode=readonly`** runs agy with `--mode plan --sandbox`, or codex with `--sandbox read-only`, in a throwaway detached worktree at `sha`. The worktree must stay unchanged (any change fails the attempt and is reset) and is always removed. The worker must return `REPORT: inline`. Read-only runs see committed files only.
+**`mode=readonly`** runs agy with `--mode plan --sandbox`, or codex with `--sandbox read-only`, in a throwaway detached worktree. With `sha` it is a checkout of that commit (committed files only). Without `sha` it is a copy of the working tree as it is: `HEAD` plus uncommitted and untracked files (ignored files are not copied), so the working tree does not have to be clean. The worktree must stay unchanged: any edit, new file, or commit fails the attempt and is undone. It is always removed. The worker must return `REPORT: inline`.
 
-**`mode=write`** runs in `cwd` itself: agy with all tool permissions, codex in its `workspace-write` sandbox (no network by default). Before the run the server records `HEAD` and the content of the whole working tree, untracked files included. If a failed attempt changed any file or made a commit, fallback stops and the result lists `changedFiles`, so the next model never builds on a half-done attempt. Files ignored by `.gitignore` are not tracked.
+**`mode=write`** runs in `cwd` itself: agy with all tool permissions, codex in its `workspace-write` sandbox (no network by default). The working tree does not have to be clean: the worker is told to leave changes that are not its own alone and, if it commits, to stage only the files it changed. Before the run the server records `HEAD` and the content of the whole working tree, untracked files included. If a failed attempt changed any file or made a commit, fallback stops and the result lists `changedFiles`, so the next model never builds on a half-done attempt. Files ignored by `.gitignore` are not tracked.
 
 **`report_path`** is resolved against `cwd` and must be a new `.md` file inside the repository and outside `.git` (symlinks are resolved). It is checked before the run and never overwrites an existing file. If the save fails, the report comes back inline with `reportError`.