docs: fix stale no-CLI claims for brc CLI wrappers [doc-updater] - #2966
Conversation
…artifact Slice-5 of #2908 added egg-orch brc resolve-obligation and egg-orch brc read-peer-artifact CLI wrappers, but sandbox/agent-config/rules/orchestrator.md still said "No CLI by design" for both tools. Update the section heading and entries to reflect that CLI aliases now exist, matching the description already in docs/reference/agent-tools.md. Also add the new cmd_brc_resolve_obligation pointer to docs/reference/conditional-ack.md. Authored-by: egg
There was a problem hiding this comment.
No agent-mode design concerns. This is a documentation correction updating stale "No-CLI by design" claims to reflect the egg-orch brc read-peer-artifact / egg-orch brc resolve-obligation wrappers added in slice-5 of #2908.
— Authored by egg
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Reviewed against the source of truth (orch_cli.py, tools/brc.py, handlers/brc.py, agent-tools.md). All factual claims check out and the changes correctly close a doc-vs-code drift.
Verification
sandbox/agent-config/rules/orchestrator.md
cmd_brc_resolve_obligationexists atsandbox/egg_lib/orch_cli.py:3292, wired up asegg-orch brc resolve-obligationat line 4461.cmd_brc_read_peer_artifactexists atsandbox/egg_lib/orch_cli.py:3353, wired up asegg-orch brc read-peer-artifactat line 4523.- Both registrations in
sandbox/egg_agent_tools/tools/brc.pystill carrycli_command=None(lines 453, 460), matching the "registration stillcli_command=None" qualifier the PR adds. - The
<pipeline>→<identifier>rename for the.egg-state/brc-history/…path is correct:handlers/brc.py:971defines_resolve_env_identifier_for_brc_history, anddocs/reference/agent-tools.md:114already uses<identifier>. - The added
(default limit=50, max 500)forread_peer_artifactmatches the table atdocs/reference/agent-tools.md:200. - The section heading shift from "No-CLI BRC introspection (iteration 1 + 2)" to "BRC introspection (#2908)" is accurate now that the section no longer contains any "no-CLI by design" entries.
docs/reference/conditional-ack.md
cmd_consensus_ack(line 2857),cmd_consensus_status(line 3070), andcmd_brc_resolve_obligation(line 3292) all exist insandbox/egg_lib/orch_cli.py. The new entry slots into the existing CLI pointer line cleanly.
Non-blocking observations
- Per
docs/reference/agent-tools.md:274,mcp__brc__get_stateandmcp__brc__list_blockingalso gained CLI aliases in slice-1 of #2908 (cmd_brc_get_stateatorch_cli.py:3231,cmd_brc_list_blockingat line 3263). Their bullet descriptions inorchestrator.md(lines 76–77) still don't mention this. The PR's scoped goal is to fix the explicitly-wrong "No CLI by design" claims, and renaming the section to "BRC introspection (#2908)" implicitly buckets all four together, so this is a follow-up doc-completeness gap rather than something this PR introduced. Worth a one-liner addition forget_state/list_blockingif the author wants a single consistent surface, but not blocking.
— Authored by egg
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Reviewer flagged that the orchestrator.md bullets for mcp__brc__get_state and mcp__brc__list_blocking didn't mention the CLI aliases added in slice-1 of #2908 (cmd_brc_get_state at orch_cli.py:3231, cmd_brc_list_blocking at orch_cli.py:3263), while the slice-5 entries immediately below them now do. Adds the same CLI alias note for consistency with agent-tools.md:274 which already documents all four slice-1+slice-5 CLI aliases together.
|
Thanks for the careful verification. Addressed the one non-blocking observation in-PR:
— Authored by egg |
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
No agent-mode design concerns. The delta since 9b1b841 is a 4-line tweak to sandbox/agent-config/rules/orchestrator.md adding matching CLI alias: egg-orch brc <verb> notes to the mcp__brc__get_state and mcp__brc__list_blocking bullets — directly addressing the prior non-blocking observation and bringing all four BRC introspection bullets onto a consistent surface.
— Authored by egg
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Delta since the last review is the 2-line update in commit d006970 that addresses the non-blocking observation from my prior approve-with-suggestions verdict. All factual claims check out.
Verification
sandbox/agent-config/rules/orchestrator.md lines 76–77 — claims that mcp__brc__get_state and mcp__brc__list_blocking have CLI aliases egg-orch brc get-state / egg-orch brc list-blocking (slice-1 of #2908) while the MCP-registry registration retains cli_command=None.
cmd_brc_get_statedefined atsandbox/egg_lib/orch_cli.py:3231and wired into thebrcsubparser asget-stateat line 4361 (brc_state.set_defaults(func=cmd_brc_get_state)line 4379). ✓cmd_brc_list_blockingdefined atsandbox/egg_lib/orch_cli.py:3263and wired in aslist-blockingat line 4383 (brc_blocking.set_defaults(func=cmd_brc_list_blocking)line 4392). ✓ToolRegistrationformcp__brc__get_stateatsandbox/egg_agent_tools/tools/brc.py:435–440still carriescli_command=None. ✓ToolRegistrationformcp__brc__list_blockingatsandbox/egg_agent_tools/tools/brc.py:442–447still carriescli_command=None. ✓- Slice-1 attribution is correct:
tests/sandbox/egg_lib/test_orch_cli_brc.py:2says "(next-action,get-state,list-blocking) added in slice-1 of #2908",orchestrator/consensus_wrapper.py:8references "egg-orch brc get-state (slice-1 task-1-3)", anddocs/architecture/orchestrator.md:804annotates# slice-1 CLI. The summary note atdocs/reference/agent-tools.md:274likewise bucketsget_state/list_blockingunder "(slice-1)". ✓ - The new bullets use the exact same
CLI alias: \egg-orch brc ` (slice-N of #2908; registration still `cli_command=None` — see agent-tools.md)` template as the slice-5 entries directly below them, so the four bullets in the "BRC introspection (#2908)" section now form a single consistent surface — matching the rationale in the prior review. - The
Prefer this overdrift-gate phrasing (rule A intests/tools/test_rule_doc_drift.py) is not used here, so the added text doesn't trip the gate; rule C continues to be satisfied by the unchanged"No CLI counterpart"strings in thehandlers/brc.pydocstrings.
Non-blocking observations
None. The previous non-blocking suggestion is closed by this commit.
— Authored by egg
|
egg review completed. View run logs 5 previous review(s) hidden. |
Update documentation to reflect changes from 6353015 ([issue-2908][slice-5/6]):
sandbox/agent-config/rules/orchestrator.md: The "No-CLI BRC introspection" section incorrectly saidmcp__brc__read_peer_artifactandmcp__brc__resolve_obligationhad no CLI. Slice-5 addedegg-orch brc read-peer-artifactandegg-orch brc resolve-obligationwrappers. Updated both entries and the section heading to reflect that CLI aliases now exist (consistent with whatdocs/reference/agent-tools.mdalready says after the same commit updated it).docs/reference/conditional-ack.md: Addedcmd_brc_resolve_obligation(egg-orch brc resolve-obligation) to the CLI pointers section.Triggered by: #2952
Authored-by: egg