Release v1.26.0: Add deep-research skill
This commit is contained in:
4
deep-research/.security-scan-passed
Normal file
4
deep-research/.security-scan-passed
Normal file
@@ -0,0 +1,4 @@
|
||||
Security scan passed
|
||||
Scanned at: 2026-01-25T15:33:59.582023
|
||||
Tool: gitleaks + pattern-based validation
|
||||
Content hash: 36de97399b27f8a70dc16d74d4abf39d62918f50c6a8f67385463f9b95cc4839
|
||||
207
deep-research/SKILL.md
Normal file
207
deep-research/SKILL.md
Normal file
@@ -0,0 +1,207 @@
|
||||
---
|
||||
name: deep-research
|
||||
description: |
|
||||
Generate format-controlled research reports with evidence tracking, citations, and iterative review. This skill should be used when users request a research report, literature review, market or industry analysis, competitive landscape, policy or technical brief, or require a strict report template and section formatting that a single deepresearch pass cannot reliably enforce.
|
||||
---
|
||||
|
||||
# Deep Research
|
||||
|
||||
Create high-fidelity research reports with strict format control, evidence mapping, and multi-pass synthesis.
|
||||
|
||||
## Quick Start
|
||||
|
||||
1. Clarify the report spec and format contract
|
||||
2. Build a research plan and query set
|
||||
3. Collect evidence with the deepresearch tool (multi-pass if needed)
|
||||
4. Triage sources and build an evidence table
|
||||
5. Draft the full report in multiple complete passes (parallel subagents)
|
||||
6. UNION merge, enforce format compliance, verify citations
|
||||
7. Present draft for human review and iterate
|
||||
|
||||
## Core Workflow
|
||||
|
||||
Copy this checklist and track progress:
|
||||
|
||||
```
|
||||
Deep Research Progress:
|
||||
- [ ] Step 1: Intake and format contract
|
||||
- [ ] Step 2: Research plan and query set
|
||||
- [ ] Step 3: Evidence collection (deepresearch tool)
|
||||
- [ ] Step 4: Source triage and evidence table
|
||||
- [ ] Step 5: Outline and section map
|
||||
- [ ] Step 6: Multi-pass full drafting (parallel subagents)
|
||||
- [ ] Step 7: UNION merge and format compliance
|
||||
- [ ] Step 8: Evidence and citation verification
|
||||
- [ ] Step 9: Present draft for human review and iterate
|
||||
```
|
||||
|
||||
### Step 1: Intake and Format Contract
|
||||
|
||||
Establish the report requirements before any research:
|
||||
|
||||
- Confirm audience, purpose, scope, time range, and geography
|
||||
- Lock output format: Markdown, DOCX, slides, or user-provided template
|
||||
- Capture required sections and exact formatting rules
|
||||
- Confirm citation style (footnotes, inline, numbered, APA, etc.)
|
||||
- Confirm length targets per section
|
||||
- Ask for any existing style guide or sample report
|
||||
|
||||
Create a concise report spec file:
|
||||
|
||||
```
|
||||
Report Spec:
|
||||
- Audience:
|
||||
- Purpose:
|
||||
- Scope:
|
||||
- Time Range:
|
||||
- Geography:
|
||||
- Required Sections:
|
||||
- Section Formatting Rules:
|
||||
- Citation Style:
|
||||
- Output Format:
|
||||
- Length Targets:
|
||||
- Tone:
|
||||
- Must-Include Sources:
|
||||
- Must-Exclude Topics:
|
||||
```
|
||||
|
||||
If a user provides a template or an example report, treat it as a hard constraint and mirror the structure.
|
||||
|
||||
### Step 2: Research Plan and Query Set
|
||||
|
||||
Define the research strategy before calling tools:
|
||||
|
||||
- Break the main question into 3-7 subquestions
|
||||
- Define key entities, keywords, and synonyms
|
||||
- Identify primary sources vs secondary sources
|
||||
- Define disqualifiers (outdated, low quality, opinion-only)
|
||||
- Assemble a query set per section
|
||||
|
||||
Use [references/research_plan_checklist.md](references/research_plan_checklist.md) for guidance.
|
||||
|
||||
### Step 3: Evidence Collection (Deepresearch Tool)
|
||||
|
||||
Use the deepresearch tool to collect evidence and citations.
|
||||
|
||||
- Run multiple complete passes if coverage is uncertain
|
||||
- Vary query phrasing to reduce blind spots
|
||||
- Preserve raw tool output in files for traceability
|
||||
|
||||
**File structure (recommended):**
|
||||
```
|
||||
<output_dir>/research/<topic-name>/
|
||||
deepresearch_pass1.md
|
||||
deepresearch_pass2.md
|
||||
deepresearch_pass3.md
|
||||
```
|
||||
|
||||
If deepresearch is unavailable, rely on user-provided sources only and state limitations explicitly.
|
||||
|
||||
### Step 4: Source Triage and Evidence Table
|
||||
|
||||
Normalize and score sources before drafting:
|
||||
|
||||
- De-duplicate sources across passes
|
||||
- Score sources using [references/source_quality_rubric.md](references/source_quality_rubric.md)
|
||||
- Build an evidence table mapping claims to sources
|
||||
|
||||
Evidence table minimum columns:
|
||||
|
||||
- Source ID
|
||||
- Title
|
||||
- Publisher
|
||||
- Date
|
||||
- URL or reference
|
||||
- Quality tier (A/B/C)
|
||||
- Notes
|
||||
|
||||
### Step 5: Outline and Section Map
|
||||
|
||||
Create an outline that enforces the format contract:
|
||||
|
||||
- Use the template in [references/research_report_template.md](references/research_report_template.md)
|
||||
- Produce a section map with required elements per section
|
||||
- Confirm ordering and headings match the report spec
|
||||
|
||||
### Step 6: Multi-Pass Full Drafting (Parallel Subagents)
|
||||
|
||||
Avoid single-pass drafting; generate multiple complete reports, then merge.
|
||||
|
||||
#### Preferred Strategy: Parallel Subagents (Complete Draft Each)
|
||||
|
||||
Use the Task tool to spawn parallel subagents with isolated context. Each subagent must:
|
||||
|
||||
- Load the report spec, outline, and evidence table
|
||||
- Draft the FULL report (all sections)
|
||||
- Enforce formatting rules and citation style
|
||||
|
||||
**Implementation pattern:**
|
||||
```
|
||||
Task(subagent_type="general-purpose", prompt="Draft complete report ...", run_in_background=false) -> version1.md
|
||||
Task(subagent_type="general-purpose", prompt="Draft complete report ...", run_in_background=false) -> version2.md
|
||||
Task(subagent_type="general-purpose", prompt="Draft complete report ...", run_in_background=false) -> version3.md
|
||||
```
|
||||
|
||||
**Write drafts to files, not conversation context:**
|
||||
```
|
||||
<output_dir>/intermediate/<topic-name>/version1.md
|
||||
<output_dir>/intermediate/<topic-name>/version2.md
|
||||
<output_dir>/intermediate/<topic-name>/version3.md
|
||||
```
|
||||
|
||||
### Step 7: UNION Merge and Format Compliance
|
||||
|
||||
Merge using UNION, never remove content without evidence-based justification:
|
||||
|
||||
- Keep all unique findings from all versions
|
||||
- Consolidate duplicates while preserving the most detailed phrasing
|
||||
- Ensure every claim in the merged draft has a cited source
|
||||
- Enforce the exact section order, headings, and formatting
|
||||
- Re-run formatting rules from [references/formatting_rules.md](references/formatting_rules.md)
|
||||
|
||||
### Step 8: Evidence and Citation Verification
|
||||
|
||||
Verify traceability:
|
||||
|
||||
- Every numeric claim has at least one source
|
||||
- Every recommendation references supporting evidence
|
||||
- No orphan claims without citations
|
||||
- Dates and time ranges are consistent
|
||||
- Conflicts are explicitly called out with both sources
|
||||
|
||||
Use [references/completeness_review_checklist.md](references/completeness_review_checklist.md).
|
||||
|
||||
### Step 9: Present Draft for Human Review and Iterate
|
||||
|
||||
Present the draft as a reviewable version:
|
||||
|
||||
- Emphasize that format compliance and factual accuracy need human review
|
||||
- Accept edits to format, structure, and scope
|
||||
- If the user provides another AI output, cross-compare and UNION merge
|
||||
|
||||
## Output Requirements
|
||||
|
||||
- Match the requested language and tone
|
||||
- Preserve technical terms in English
|
||||
- Respect the report spec and formatting rules
|
||||
- Include a references section or bibliography
|
||||
|
||||
## Reference Files
|
||||
|
||||
| File | When to Load |
|
||||
| --- | --- |
|
||||
| [research_report_template.md](references/research_report_template.md) | Build outline and draft structure |
|
||||
| [formatting_rules.md](references/formatting_rules.md) | Enforce section formatting and citation rules |
|
||||
| [source_quality_rubric.md](references/source_quality_rubric.md) | Score and triage sources |
|
||||
| [research_plan_checklist.md](references/research_plan_checklist.md) | Build research plan and query set |
|
||||
| [completeness_review_checklist.md](references/completeness_review_checklist.md) | Review for coverage, citations, and compliance |
|
||||
|
||||
## Anti-Patterns
|
||||
|
||||
- Single-pass drafting without parallel complete passes
|
||||
- Splitting passes by section instead of full report drafts
|
||||
- Ignoring the format contract or user template
|
||||
- Claims without citations or evidence table mapping
|
||||
- Mixing conflicting dates without calling out discrepancies
|
||||
- Copying external AI output without verification
|
||||
- Deleting intermediate drafts or raw research outputs
|
||||
25
deep-research/references/completeness_review_checklist.md
Normal file
25
deep-research/references/completeness_review_checklist.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# Completeness Review Checklist
|
||||
|
||||
Verify the draft meets all requirements before delivery.
|
||||
|
||||
## Structure and Format
|
||||
- All required sections present and ordered
|
||||
- Headings match the format contract
|
||||
- Length targets met per section
|
||||
|
||||
## Evidence and Citations
|
||||
- Every claim has a citation
|
||||
- Every numeric claim has at least one Tier A or B source
|
||||
- Conflicting sources are explicitly noted
|
||||
- Evidence table maps claims to sources
|
||||
|
||||
## Content Quality
|
||||
- Findings answer the research questions
|
||||
- Recommendations are tied to evidence
|
||||
- Limitations and uncertainty are documented
|
||||
- Terminology is consistent
|
||||
|
||||
## Final Checks
|
||||
- Dates and time ranges are consistent
|
||||
- No unsupported claims
|
||||
- No duplicate or conflicting statements
|
||||
31
deep-research/references/formatting_rules.md
Normal file
31
deep-research/references/formatting_rules.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# Formatting Rules
|
||||
|
||||
Use these rules to enforce strict report formatting.
|
||||
|
||||
## Headings
|
||||
- Use H2 for top-level sections
|
||||
- Use H3 for subsections
|
||||
- Keep heading titles consistent with the report spec
|
||||
|
||||
## Section Order
|
||||
- Follow the report spec order exactly
|
||||
- Do not add or remove sections without approval
|
||||
|
||||
## Bullets and Tables
|
||||
- Use bullets for lists of findings and actions
|
||||
- Use tables for comparisons, metrics, or timelines
|
||||
- Keep tables compact and label all columns
|
||||
|
||||
## Citations
|
||||
- Use the citation style defined in the report spec
|
||||
- Place citations immediately after the claim
|
||||
- If a claim has multiple sources, list all relevant sources
|
||||
|
||||
## Terminology
|
||||
- Define key terms once and reuse consistently
|
||||
- Preserve technical terms in English
|
||||
|
||||
## Formatting Hygiene
|
||||
- Avoid mixed numbering styles in the same section
|
||||
- Avoid inline URLs in prose unless the spec requires it
|
||||
- Do not embed new assets unless requested
|
||||
26
deep-research/references/research_plan_checklist.md
Normal file
26
deep-research/references/research_plan_checklist.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# Research Plan Checklist
|
||||
|
||||
Use this checklist before calling the deepresearch tool.
|
||||
|
||||
## Scope and Questions
|
||||
- Define the primary research question
|
||||
- Break into 3-7 subquestions
|
||||
- Define scope boundaries and exclusions
|
||||
- Define time range and geography
|
||||
|
||||
## Evidence Strategy
|
||||
- Identify primary sources needed
|
||||
- Identify secondary sources needed
|
||||
- Define inclusion and exclusion criteria
|
||||
- Define minimum number of sources per section
|
||||
|
||||
## Query Set
|
||||
- Create query variants per subquestion
|
||||
- Include synonyms and alternate terms
|
||||
- Add disambiguating keywords
|
||||
|
||||
## Query Log Template
|
||||
- Query:
|
||||
- Intended section:
|
||||
- Date run:
|
||||
- Notes:
|
||||
49
deep-research/references/research_report_template.md
Normal file
49
deep-research/references/research_report_template.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# Research Report Template
|
||||
|
||||
## Title
|
||||
- Report title
|
||||
- Date
|
||||
- Author or team (optional)
|
||||
|
||||
## Executive Summary
|
||||
- 3-6 bullets, each supported by evidence
|
||||
- Include top conclusions and implications
|
||||
|
||||
## Research Question and Scope
|
||||
- Primary question
|
||||
- Scope boundaries (what is included and excluded)
|
||||
- Time range and geography
|
||||
|
||||
## Methodology
|
||||
- Data sources used
|
||||
- Search strategy and inclusion criteria
|
||||
- Limitations and known gaps
|
||||
|
||||
## Key Findings
|
||||
- 5-10 findings, each with citations
|
||||
|
||||
## Analysis
|
||||
### Section 1: [Theme]
|
||||
- Structured paragraphs with citations
|
||||
- If comparative, include a table
|
||||
|
||||
### Section 2: [Theme]
|
||||
- Structured paragraphs with citations
|
||||
|
||||
### Section 3: [Theme]
|
||||
- Structured paragraphs with citations
|
||||
|
||||
## Risks and Limitations
|
||||
- Data gaps
|
||||
- Conflicting sources
|
||||
- Uncertainty ranges
|
||||
|
||||
## Recommendations (If requested)
|
||||
- Actionable recommendations tied to findings
|
||||
- Each recommendation cites evidence
|
||||
|
||||
## Appendix A: Evidence Table
|
||||
- Table mapping claims to sources
|
||||
|
||||
## Appendix B: Sources
|
||||
- Full citations or links
|
||||
28
deep-research/references/source_quality_rubric.md
Normal file
28
deep-research/references/source_quality_rubric.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# Source Quality Rubric
|
||||
|
||||
Classify sources into tiers and prioritize higher quality evidence.
|
||||
|
||||
## Tier A (Highest)
|
||||
- Primary sources: government data, standards bodies, peer-reviewed papers
|
||||
- Official filings: annual reports, regulatory filings, audited statements
|
||||
- First-party datasets with transparent methodology
|
||||
|
||||
## Tier B (Reliable)
|
||||
- Reputable news organizations with editorial standards
|
||||
- Industry analyst reports with clear methodology
|
||||
- Company technical blogs with data and disclosures
|
||||
|
||||
## Tier C (Use Sparingly)
|
||||
- Opinion pieces without evidence
|
||||
- Marketing materials without verification
|
||||
- Aggregators without clear sourcing
|
||||
|
||||
## Exclusion Rules
|
||||
- Exclude sources with no date or author
|
||||
- Exclude sources that cannot be verified
|
||||
- Exclude sources that are clearly outdated for the topic
|
||||
|
||||
## Conflict Handling
|
||||
- Surface conflicting sources explicitly
|
||||
- Prefer higher tier sources
|
||||
- Note uncertainty when conflicts remain
|
||||
Reference in New Issue
Block a user