docs(agent-team): add manual dispatch examples and clarify input validation failure behavior#121
Draft
github-actions[bot] wants to merge 1 commit into
Draft
Conversation
…dation behavior Prompted by d688265 which hardened workflow_dispatch input validation across all three dispatched agents (planner, implementer, reviewer). The README told users to manually `gh workflow run` a specific role to retry a stuck stage but gave no example commands — now that missing inputs fail loudly with state:blocked, this gap is a usability hazard. Changes: - Step 4 of "Kicking off a task": replace the generic mention of manual dispatch with concrete `gh workflow run` examples for each dispatched workflow, covering first-attempt and kickback-retry cases for the implementer. - "Limits and gotchas" → Input propagation bullet: describe the actual failure behavior (state:blocked + error comment, or report_incomplete if issue_number is absent) instead of just saying "fail loudly". Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.
What changed
Updates
catalog/agent-team/README.mdto surface two documentation gaps exposed by d688265 — the commit that hardenedworkflow_dispatchinput validation across all three dispatched agents.Gap 1 — Manual dispatch had no example commands
"Kicking off a task" step 4 previously told users:
...but gave no actual commands. Now that missing inputs fail loudly with
state:blocked, this gap is a usability hazard: users who omit an input will get a blocked issue with no hint of what went wrong.Fix: replaced the generic sentence with concrete
gh workflow runexamples for each dispatched workflow, covering:pr_number)pr_number)Gap 2 — "Input propagation" gotcha was underspecified
The "Limits and gotchas" bullet previously said agents "must fail loudly" but didn't say what that means in practice.
Fix: described the actual behavior —
state:blockedadded to the issue + a specific error comment posted, orreport_incompletecalled whenissue_numberitself is absent.Files changed
catalog/agent-team/README.md— 19 lines added, 2 lines replacedTest plan
gh workflow runcommands match theworkflow_dispatch.inputsdeclared in each agent's frontmatter (planner-agent.md,implementer-agent.md,reviewer-agent.md)🤖 Generated with [Claude Code]((claude.ai/redacted)