docs(agent-team): document manual dispatch inputs and recovery path#95
Draft
github-actions[bot] wants to merge 1 commit intomainfrom
Draft
docs(agent-team): document manual dispatch inputs and recovery path#95github-actions[bot] wants to merge 1 commit intomainfrom
github-actions[bot] wants to merge 1 commit intomainfrom
Conversation
Add a per-role input reference table to the "Kicking off a task" section so users know exactly which inputs are required vs optional when manually re-dispatching planner, implementer, or reviewer. Document the exact blocked-state error message and how to recover from a `state:blocked` caused by missing dispatch inputs (as opposed to a human-added block), since the recovery path differs. Expand the "Input propagation" gotcha to include the failure message and cross-reference the new table. Follows the behavioral fix in #69 (fail loud on missing workflow_dispatch inputs, harden optional implementer pr_number). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
github-actions
Bot
added
automation
documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follows the behavioral fix in #69 (fail loud on missing
workflow_dispatchinputs; harden optional implementerpr_number). The code already implements the correct behavior — this PR brings the documentation up to date.What changed
catalog/agent-team/README.md— three targeted additions:Manual dispatch input table (new, in "Kicking off a task" step 4): a quick-reference table listing required vs. optional inputs for each role (
planner-agent,implementer-agent,reviewer-agent), including thepr_numberblank-vs-set semantics for the implementer.Blocked-by-missing-inputs recovery note (new, in "Retrying a blocked task" step 5): distinguishes a block caused by missing dispatch inputs (re-dispatch the stuck role only) from a human-added block (re-add the
agent-teamlabel from scratch).Expanded "Input propagation" gotcha: replaces the terse one-liner with the exact error message users will see (
🛑 agent-team: workflow_dispatch inputs were not propagated) and a cross-reference to the new input table.Why
Before this PR, a user who hit the "not propagated" blocked state had no documentation telling them:
Testing
No behavior changes — documentation only. Verified Markdown renders correctly in preview.