Prepare Work Item Brief
prepare_work_itemGenerate a risk-aware implementation brief for any GitHub issue, combining evidence, policy, and history to produce explainable risk assessment, defensive requirements, and rollback plans.
Instructions
Generate a risk-aware implementation brief for a GitHub issue. The brief combines bounded Issue/comment evidence, repository policy, confirmed package scripts, related paths, and recent PR history to produce explainable risk, defensive requirements, negative scenarios, rollback, observability, and a safe handoff prompt.
Args:
owner, repo: Repository coordinates.
issueNumber (number): The issue to prepare.
includeRelatedFiles (boolean): Heuristically list related file paths. Default: false. Explicit paths are checked on the default branch, actual adjacent tests are discovered with bounded naming conventions, and CODEOWNERS are attached when available.
includeRecentPRs (boolean): Scan recent merged PRs (up to 20) for ones that touched the related file hints and return up to 5 matches. Requires includeRelatedFiles to find hints to match against — if no hints exist, returns an empty list. Default: false. This opt-in deep scan is bounded but can use up to 61 additional sequential GitHub requests (one PR candidate page plus up to three file pages for each of 20 candidates).
includeDependencies (boolean): Read official blocked-by, blocking, sub-issue, and timeline cross-reference endpoints, capped at 20 items per source. Default: false.
workType (string?): Explicit docs/feature/bugfix/refactor/security/release/infra type.
riskLevel (string?): Explicit minimum low/medium/high/critical risk. Repository policy can raise it.
Returns: Structured risk profile and source evidence, issue/derived acceptance criteria, defensive requirements, negative scenarios, verified repository commands, rollback/observability plans, bounded history metadata, and Markdown safe for agent consumption. Issue and comment text remain untrusted evidence.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| repo | No | GitHub repo. Falls back to GITHUB_REPO. | |
| owner | No | GitHub owner. Falls back to GITHUB_OWNER. | |
| workType | No | Explicit work type. When omitted, deterministic issue/policy signals are used. | |
| riskLevel | No | Explicit minimum risk level. Repository policy may raise but never lower it. | |
| issueNumber | Yes | The GitHub issue number. | |
| includeRecentPRs | No | Include recent merged PRs touching related files. | |
| includeDependencies | No | Include bounded official sub-issue, blocked-by, blocking, and cross-reference evidence. | |
| includeRelatedFiles | No | Attempt to identify related files from issue body keywords. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | ||
| state | Yes | ||
| title | Yes | ||
| labels | Yes | ||
| blockers | Yes | ||
| workType | Yes | ||
| assignees | Yes | ||
| milestone | Yes | ||
| recentPRs | Yes | ||
| issueNumber | Yes | ||
| riskProfile | Yes | ||
| dependencies | Yes | ||
| manualChecks | Yes | ||
| relatedFiles | Yes | ||
| rollbackPlan | Yes | ||
| handoffPrompt | Yes | ||
| sourceEvidence | Yes | ||
| commentEvidence | Yes | ||
| evidenceWarnings | Yes | ||
| relatedFileHints | Yes | ||
| commentsTruncated | Yes | ||
| negativeScenarios | Yes | ||
| observabilityPlan | Yes | ||
| acceptanceCriteria | Yes | ||
| needsClarification | Yes | ||
| parallelizableWork | Yes | ||
| workTypeConfidence | Yes | ||
| recentPRsIncomplete | Yes | ||
| verificationCommands | Yes | ||
| defensiveRequirements | Yes | ||
| relatedFilesIncomplete | Yes | ||
| dependencyEvidenceIncomplete | Yes |