Skip to content

docs(agent-team): document fail-loud input contract and pr_number hardening#70

Draft
github-actions[bot] wants to merge 1 commit intomainfrom
docs/agent-team-input-contract-dbbe17434504ed3a
Draft

docs(agent-team): document fail-loud input contract and pr_number hardening#70
github-actions[bot] wants to merge 1 commit intomainfrom
docs/agent-team-input-contract-dbbe17434504ed3a

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

What changed

Updates catalog/agent-team/README.md to mirror the behavioral fixes shipped in #69, which added an explicit required-input contract to the planner, implementer, and reviewer agents and hardened the implementer's optional pr_number handling.

Specific edits

"Kicking off a task" — item 4 (manual dispatch)

  • Spell out which inputs are required vs. optional for each agent (issue_number always; iteration defaults to "1"; pr_number only for reviewer and kickback re-dispatches).
  • Note that agents verify inputs before doing any other work and fail loudly on missing/unresolved values.

"Kicking off a task" — item 5 (retrying a blocked task)
Replaced the single retry path with two distinct recovery paths:

  • Input propagation failure (🛑 agent-team: workflow_dispatch inputs were not propagated): clear state:blocked and re-dispatch the specific stuck workflow via gh workflow run with the correct -f flags. Clarifies that re-adding the agent-team label is wrong here — it restarts spec from scratch.
  • All other blocks: existing "clear + re-add label" path, unchanged.

Adds ready-to-copy gh workflow run commands for each mid-chain role.

"Limits and gotchas" — Input propagation bullet
Expanded from a one-liner to the exact protocol:

  • issue_number present but bad → state:blocked + specific error comment text.
  • issue_number missing entirely → missing_data / report_incomplete escalation.
  • Documents the pr_number unresolved-literal treatment (implementer creates a new branch rather than pushing to an existing PR).

Why

Before this PR the docs said "fail loudly on missing inputs" without explaining what that looks like in practice or how to recover. Users hitting an input-propagation failure would likely re-add the agent-team label (wrong recovery) rather than re-dispatching the blocked stage with corrected inputs.

Test plan

  • Read the updated catalog/agent-team/README.md — recovery paths are unambiguous.
  • Verify error message text matches planner-agent.md, implementer-agent.md, reviewer-agent.md "Required input contract" sections.
  • Confirm gh workflow run flag examples match the workflow_dispatch.inputs declarations in each agent file.

🤖 Generated with [Claude Code]((claude.com/redacted)

Generated by Update Docs ·

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/update-docs.md@96b9d4c39aa22359c0b38265927eadb31dcf4e2a

…dening

PR #69 added an explicit required-input contract to the planner,
implementer, and reviewer agents, and hardened the implementer's
optional pr_number handling. Update catalog/agent-team/README.md to
reflect the exact fail-loud protocol, the two-branch recovery path
(input-propagation failure vs. generic block), and the pr_number
unresolved-literal treatment.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants