research-report

Generates markdown summary reports from deep research JSON results via a Python conversion script.

2.2k|185|Updated Dec 29, 2025
One-click install
npx skills add https://github.com/Weizhena/Deep-Research-skills --skill research-report-weizhena
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: research-report
Source: https://github.com/Weizhena/Deep-Research-skills/tree/main/skills/research-codex-zh/research-report
Command: npx skills add https://github.com/Weizhena/Deep-Research-skills --skill research-report-weizhena

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pyyaml.

What problem does it solve? After running deep research, you end up with many scattered JSON result files that are hard to read and compare. This Skill consolidates them into a single structured markdown report with a table of contents and detailed sections. ## Core Features & Use Cases - Automatic Report Generation: Reads all JSON results from the research output directory and produces a markdown report with anchor-linked TOC and category-organized details. - Uncertainty Filtering: Skips fields marked with [uncertain], listed in the uncertain array, or empty, so the report only shows confident data. - Flexible Structure Handling: Supports both flat and nested JSON structures with multi-language category mapping (Chinese/English), plus user-selected summary fields shown in the TOC. - Use Case: After researching 20 AI coding tools, run this Skill to produce a report.md where the TOC lists each tool with stars and benchmark scores, followed by detailed per-category breakdowns. ## Quick Start Run /research-report to summarize all deep research JSON results in the current topic directory into a markdown report.

Frequently Asked Questions about research-report

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a markdown report from research JSON files?▼

Run /research-report in the directory containing your outline.yaml. The skill scans all JSON results, asks which summary fields to show in the table of contents, generates a generate_report.py script, and runs it to produce report.md.

How to convert nested JSON research data into a readable report?▼

The generated Python script supports both flat JSON and nested category structures, looking up fields at the top level, via category mapping keys, or by traversing nested dicts. Complex values like lists of dicts are formatted line by line for readability.

Does the report include fields with uncertain values?▼

No. Fields whose values contain the [uncertain] marker, fields listed in the uncertain array, and fields with None or empty values are skipped. The uncertain field names are listed separately in an Other Info section.

Can I customize which fields appear in the report table of contents?▼

Yes. The skill scans the JSON results for short numeric or metric fields such as github_stars or swe_bench_score, then asks via request_user_input which of those fields to display next to each item name in the TOC.

What dependencies are required to run the report generation?▼

The workflow requires Python with pyyaml installed to read the outline.yaml and fields.yaml configuration files. The generated generate_report.py script reads the JSON results and writes the final report.md.