-
Notifications
You must be signed in to change notification settings - Fork 5
Add agentic research MVP docs and reusable research templates #105
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
PatrickSys
wants to merge
1
commit into
main
Choose a base branch
from
codex/distill-agentic-research-into-mvp-state-branch-wnloo9
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
9 changes: 9 additions & 0 deletions
9
distilled/templates/research-agentic/prompt-decomposition.json
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| { | ||
| "sub_questions": [], | ||
| "entities": [], | ||
| "required_formats": [], | ||
| "required_sections": [], | ||
| "required_section_headings": [], | ||
| "time_horizons": [], | ||
| "scope_conditions": [] | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # Research Scratchpad | ||
|
|
||
| Use this for long-running jobs. Append entries; do not rewrite history. | ||
|
|
||
| ## Timeline | ||
|
|
||
| - YYYY-MM-DD HH:MM UTC — Started run. Objective: ... | ||
| - YYYY-MM-DD HH:MM UTC — Decomposition complete. Notes: ... | ||
| - YYYY-MM-DD HH:MM UTC — Breadth sweep pivot. Why: ... | ||
| - YYYY-MM-DD HH:MM UTC — Depth lane update. Confidence: ... | ||
| - YYYY-MM-DD HH:MM UTC — Critic findings applied. Changes: ... | ||
|
|
||
| ## Open risks | ||
|
|
||
| - Risk: | ||
| - Mitigation: |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| # Agentic Research MVP (Web-enabled) | ||
|
|
||
| This MVP distills the HyperResearch-style decomposition and long-horizon research loop into Workspine-compatible artifacts that any developer can run with web research enabled. | ||
|
|
||
| ## Scope and outcome | ||
|
|
||
| - Adds a reusable workflow contract for agentic research in `.planning/research/`. | ||
| - Enforces prompt decomposition before search. | ||
| - Uses a scratchpad protocol for long jobs to prevent drift. | ||
| - Captures architecture tradeoffs and verification gates so outputs are shippable. | ||
|
|
||
| ## Architecture (MVP) | ||
|
|
||
| 1. **Decompose first** | ||
| - Parse the user request into atomic asks, entities, required sections, horizons. | ||
| - Emit `prompt-decomposition.json` and heading contract. | ||
|
|
||
| 2. **Breadth sweep (agentic search)** | ||
| - Run broad source discovery across primary sources first. | ||
| - Build a source ledger with relevance and confidence notes. | ||
|
|
||
| 3. **Depth lanes** | ||
| - Split into 2-5 focused lanes (methods, evidence quality, counterarguments, implementation implications). | ||
| - Keep lane notes separate, then synthesize. | ||
|
|
||
| 4. **Synthesis and adversarial pass** | ||
| - Produce thesis + evidence chain. | ||
| - Run a critic pass for missing sections, unsupported claims, and citation gaps. | ||
|
|
||
| 5. **Delivery package** | ||
| - Final report + sources + limitations + follow-up experiments. | ||
|
|
||
| ## Core artifacts | ||
|
|
||
| - `.planning/research/scaffold.md` | ||
| - `.planning/research/query.md` | ||
| - `.planning/research/prompt-decomposition.json` | ||
| - `.planning/research/scratchpad.md` | ||
| - `.planning/research/source-ledger.md` | ||
| - `.planning/research/lane-*.md` | ||
| - `.planning/research/draft.md` | ||
| - `.planning/research/final.md` | ||
|
|
||
| ## Tradeoffs | ||
|
|
||
| - **Rigor vs speed:** decomposition + critics improve fidelity but increase latency. | ||
| - **Breadth vs depth:** wider search reduces blind spots but costs tokens/time. | ||
| - **Single-agent vs lane parallelism:** parallel lanes improve coverage but require stronger merge discipline. | ||
| - **Citation density vs readability:** high citation density helps auditability, hurts narrative flow. | ||
|
|
||
| ## Verification gates | ||
|
|
||
| - Structural match against required section headings. | ||
| - Every major claim has at least one source. | ||
| - Explicit unresolved questions and confidence labels. | ||
| - Reproducible scratchpad timeline of major decisions. | ||
|
|
||
| ## How this integrates with Workspine | ||
|
|
||
| Use the reusable templates in `distilled/templates/research-agentic/` and copy them into `.planning/research/` as the starting harness for this MVP. | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The "Core artifacts" section lists several files (e.g.,
scaffold.md,query.md,source-ledger.md,lane-*.md,draft.md,final.md) that are not included in thedistilled/templates/research-agentic/directory added in this PR. Since the integration instructions on line 60 direct users to copy templates from that directory to establish the research harness, the absence of these files will prevent users from following the described workflow. Please either include the missing templates or update the documentation to reflect the current set of provided artifacts.