Skip to content

Commit 6dbe2d8

Browse files
committed
docs: rephrase README to clear Vale warnings
1 parent 3f2547a commit 6dbe2d8

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

‎README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ flowchart LR
4040
C -.->|feedback + session id, new worker| W
4141
```
4242

43-
The main thread spawns the background `opencode-worker` (Haiku, no edit tools). The worker resolves model and mode (read-only tasks pass `auto: false`), writes a self-contained brief, calls the MCP `delegate` tool, checks the git diff and runs tests or build, retries at most twice with the same session, otherwise reports reject. Its report has model, session id, changed files, verification and verdict, under 200 words. A timed-out run is not retried; the worker reports the session id so you can continue.
43+
The main thread spawns the background `opencode-worker` (Haiku, no edit tools). The worker resolves model and mode (read-only tasks pass `auto: false`), writes a self-contained brief, calls the MCP `delegate` tool, checks the git diff and runs tests or build, retries at most twice with the same session, otherwise reports reject. Its report has model, session id, changed files, verification and verdict, under 200 words. A timed-out run isn't retried; the worker reports the session id so you can continue.
4444

4545
The main thread never calls `delegate` itself: a hook denies it. For each `delegate` call, the MCP server runs:
4646

@@ -54,15 +54,15 @@ The run uses your existing OpenCode auth, config, agents and permission rules.
5454
5555
Built-in subagents (`general-purpose`, `claude`, `Explore`, `Plan`, `claude-code-guide`, `statusline-setup`) are rewritten to `claudelegate:opencode-worker` on Haiku. `Explore`, `Plan` and `claude-code-guide` become read-only. Custom, project, user, plugin, reviewer and SDD agents stay on Claude.
5656
57-
To opt out, set `OPENCODE_DELEGATE_ROUTE` to `0`, `false`, `no` or `off` (this also disables the main-thread guard), or put `[no-opencode]` in a single prompt. Routing is also skipped when `opencode` or `jq` cannot be found.
57+
To opt out, set `OPENCODE_DELEGATE_ROUTE` to `0`, `false`, `no` or `off` (this also disables the main-thread guard), or put `[no-opencode]` in a single prompt. Routing is also skipped when `opencode` or `jq` can't be found.
5858
5959
A hook denies `delegate` and `delegate_async` calls from the main thread. Calls from inside a subagent pass because Claude Code sends `agent_id` only there. The MCP server sends `instructions` that make delegation the default.
6060
6161
## Modes and Models
6262
6363
| Mode | When | OpenCode flags |
6464
| --------------- | ----------------------------------------- | ---------------------------- |
65-
| write (default) | Implement, fix, refactor | `--agent build --auto` |
65+
| write (default) | Code, fix, refactor | `--agent build --auto` |
6666
| read-only | Review, question, summary, second opinion | `--agent plan` (no `--auto`) |
6767
6868
| Input | Behaviour |
@@ -71,9 +71,9 @@ A hook denies `delegate` and `delegate_async` calls from the main thread. Calls
7171
| exact `provider/model` | Used as is |
7272
| loose name (`grok 4.7`) | Resolved against `opencode models`; a named version must match exactly (4.7 never becomes 4.6) |
7373
| ambiguous loose name | `delegate` returns the candidates and the worker picks the one that fits the task best |
74-
| `provider/model#variant` | Variant preserved, e.g. `xai/grok-4.7#high` |
74+
| `provider/model#variant` | Variant preserved, for example `xai/grok-4.7#high` |
7575
76-
There are no built-in default models. Write mode passes `--agent build` because `default_agent` is often `plan`. Without `--auto` headless runs auto-reject permissions, which makes `plan` safe. The `</dev/null` redirect is required: with an open stdin pipe, `opencode run` waits forever.
76+
The plugin has no built-in default models. Write mode passes `--agent build` because `default_agent` is often `plan`. Without `--auto` headless runs reject permission requests automatically, which makes `plan` safe. The `</dev/null` redirect is required: with an open stdin pipe, `opencode run` waits forever.
7777
7878
## Continuing and parallel work
7979
@@ -88,14 +88,14 @@ Continue by spawning `claudelegate:opencode-worker` again with the session id an
8888
| `OPENCODE_DELEGATE_DEFAULT_MODEL` | unset | Model when none is given; unset or empty means OpenCode's configured default |
8989
| `OPENCODE_DELEGATE_AUTO` | `true` | Default for `auto`; `0`, `false`, `no`, `off` disable it |
9090
| `OPENCODE_DELEGATE_TIMEOUT` | `1800` | Seconds before a run is killed |
91-
| `OPENCODE_DELEGATE_MAX_OUTPUT` | `40000` | Maximum response characters returned |
91+
| `OPENCODE_DELEGATE_MAX_OUTPUT` | `40000` | Response character limit |
9292
| `OPENCODE_DELEGATE_THINKING` | `true` | Include reasoning blocks in output |
9393
| `OPENCODE_DELEGATE_CWD` | process cwd | Base working directory |
94-
| `OPENCODE_DELEGATE_PREFERRED_PROVIDERS` | none | Comma-separated provider order when a model has several providers |
94+
| `OPENCODE_DELEGATE_PREFERRED_PROVIDERS` | none | Comma-separated provider order when a model has more than one provider |
9595
9696
The variables are read by the MCP server unless noted. These are the only variables the plugin honours.
9797
98-
## Standalone MCP server
98+
## Standalone server
9999
100100
The MCP server is also published to npm as `@lehcode/claudelegate` (needs Bun). Register it in any MCP client with command `bunx` and args `["@lehcode/claudelegate"]`. See `examples/claude_desktop_config.json`.
101101
@@ -113,13 +113,13 @@ Tests are fixture-based and need no running services.
113113
114114
### `src/`
115115
116-
`src/index.ts` is the MCP server entry point, `dist/index.js` is a committed bundle built with `bun run build`, and CI fails if it is stale, so rebuild and commit `dist/` after changing `src/`. The plugin cache has no `node_modules`, which is why the bundle is committed.
116+
`src/index.ts` is the MCP server entry point, `dist/index.js` is a committed bundle built with `bun run build`, and CI fails if it's stale, so rebuild and commit `dist/` after changing `src/`. The plugin cache has no `node_modules`, which is why the bundle is committed.
117117
118118
## Releasing
119119
120120
Automated by release-please (`.github/workflows/release.yml`). Conventional commits merged to `main` open or update a release PR that bumps `package.json`, `.claude-plugin/plugin.json` and `.claude-plugin/marketplace.json` and writes `CHANGELOG.md`. Merging it creates the `vX.Y.Z` tag and GitHub release and publishes to npm via trusted publishing (OIDC, no token, provenance automatic). Never edit versions by hand.
121121
122-
The first publish is manual (`npm publish --access public`), then add a trusted publisher on npmjs.com for repository `lehcode/claudelegate`, workflow `release.yml`. Optional: `RELEASE_PLEASE_TOKEN` secret (PAT or app token with `contents` and `pull-requests` write), because release PRs made with the default `GITHUB_TOKEN` do not trigger CI.
122+
The first publish is manual (`npm publish --access public`), then add a trusted publisher on npmjs.com for repository `lehcode/claudelegate`, workflow `release.yml`. Optional: `RELEASE_PLEASE_TOKEN` secret (PAT or app token with `contents` and `pull-requests` write), because release PRs made with the default `GITHUB_TOKEN` don't trigger CI.
123123
124124
## License
125125

0 commit comments

Comments
 (0)