docs(coding-agent): refresh workflowz notice#2653
Conversation
Updated the hidden workflowz notice with advisor consult and provenance-rich local brief patterns, and covered those notice requirements in the workflow mode test. Fixes #2642
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: bd6e0d7117
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| - **Budget/count loops** — `while len(bugs) < 10:` to hit a target, or `while budget.total and budget.remaining() > 50_000:` to scale depth to the turn budget; `log()` each round. | ||
| - **No silent caps** — if you bound coverage (top-N, no-retry, sampling), `log()` what you dropped; silent truncation reads as "covered everything" when it didn't. | ||
|
|
||
| - **Advisor consult** — at a hard fork, consult the `advisor` tool before committing to one direction; feed it the concrete options, constraints, and consequences so the chosen path is explicit. |
There was a problem hiding this comment.
In workflowz sessions this notice is appended as hidden system guidance, but the repository's tool registry (packages/coding-agent/src/tools/index.ts, checked BUILTIN_TOOLS/HIDDEN_TOOLS) does not expose an advisor tool, and a repo-wide rg only finds this new prompt/test text. When a task hits the documented “hard fork” case, the model is now steered toward a tool call that cannot execute, which can waste a turn or produce an invalid tool-call failure; this should reference an available mechanism such as ask/agent(..., agent_type=...), or add/register the advisor tool.
Useful? React with 👍 / 👎.
Replaced the nonexistent advisor tool reference with available consult mechanisms in the workflowz notice and aligned the notice test. Fixes #2642
|
1 participant
Repro
The hidden workflow notice loaded from
packages/coding-agent/src/prompts/system/workflow-notice.mddid not contain the requested advisor-consult wording or provenance fields. Reproduced withbun -e 'const text = await Bun.file("packages/coding-agent/src/prompts/system/workflow-notice.md").text(); const checks = ["advisor tool", "files/commits", "done", "local:" + "//"]; const missing = checks.filter(check => !text.includes(check)); if (missing.length) { console.error(workflow notice missing: ${missing.join(", ")}); process.exit(1); }', which reportedworkflow notice missing: advisor tool, files/commits, donebefore the fix.Cause
packages/coding-agent/src/prompts/system/workflow-notice.mdalready described eval fan-out andlocal://briefs generically, but its<patterns>section did not name theadvisortool hard-fork consult pattern or the provenance contract for files/commits and done criteria.Fix
packages/coding-agent/test/modes/workflow.test.tsto assertWORKFLOW_NOTICEcontains the requested advisor, files/commits, done, andlocal://markers.Verification
bun --cwd=packages/coding-agent test test/modes/workflow.test.tspassed: 5 tests, 26 assertions.gh_push_branchpre-publish gate passed and pushedfarm/f5a6a0eb/refresh-workflowz-notice. Fixes #2642