mcpField
G
github-deep-research

github-deep-research

github.com/bytedance开发84.6k2.9k 次安装今天更新
代码仓库

关于 github-deep-research

此研究技能结合 GitHub API 数据、网页搜索和内容抓取，生成全面的 Markdown 报告。它通过分阶段发现、来源核查与分析，适用于仓库和主题调研。

主要功能

  1. 01四轮研究流程
  2. 02GitHub API 仓库数据
  3. 03网页搜索与内容抓取
  4. 04带引用的 Markdown 报告
  5. 05来源可信度评估

适用场景

  1. 01调研 GitHub 仓库
  2. 02从宽泛查询深入技术细节
  3. 03整理证据与引用并生成报告

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/bytedance/deer-flow --skill github-deep-research

安装后在 Claude Code 中输入/github-deep-research确认已加载。

附带文件assets/report_template.mdscripts/github_api.py

详细介绍

GitHub 深度研究技能

结合 GitHub API、web_search 和 web_fetch，开展多轮研究并生成全面的 Markdown 报告。

研究工作流

  • 第 1 轮：GitHub API
  • 第 2 轮：探索
  • 第 3 轮：深入调查
  • 第 4 轮：深度分析

核心方法

查询策略

由宽到窄：先从 GitHub API 入手，然后使用通用查询，再根据发现逐步细化。

Round 1: GitHub API
Round 2: "{topic} overview"
Round 3: "{topic} architecture", "{topic} vs alternatives"
Round 4: "{topic} issues", "{topic} roadmap", "site:github.com {topic}"

来源优先级：

  1. 官方文档／代码仓库（权重最高）
  2. 技术博客（Medium、Dev.to）
  3. 新闻文章（经核实的媒体）
  4. 社区讨论（Reddit、HN）
  5. 社交媒体（权重最低，用于判断情绪）
研究轮次

第 1 轮 - GitHub API 直接执行 scripts/github_api.py，不要使用 read_file()：

python /path/to/skill/scripts/github_api.py <owner> <repo> summary
python /path/to/skill/scripts/github_api.py <owner> <repo> readme
python /path/to/skill/scripts/github_api.py <owner> <repo> tree

可用命令（github_api.py 的最后一个参数）：

  • summary
  • info
  • readme
  • tree
  • languages
  • contributors
  • commits
  • issues
  • prs
  • releases

issues 命令只返回代码仓库的问题，不包括拉取请求。为满足请求的问题数量限制，必要时会继续获取后续页面；如需单独研究拉取请求，请使用 prs。

第 2 轮 - 探索（3-5 次 web_search）

  • 获取概览并识别关键词
  • 查找官方网站／代码仓库
  • 识别主要参与者／竞争对手

第 3 轮 - 深入调查（5-10 次 web_search + web_fetch）

  • 技术架构细节
  • 重要事件时间线
  • 社区情绪
  • 对有价值的网址使用 web_fetch 获取完整内容

第 4 轮 - 深度分析

  • 分析提交历史，整理时间线
  • 查看问题／拉取请求，了解功能演进
  • 检查贡献者活动

报告结构

遵循 assets/report_template.md 中的模板：

  1. 元数据块 - 日期、置信度、主题
  2. 执行摘要 - 用 2-3 句话概述并列出关键指标
  3. 时间顺序时间线 - 按阶段和日期划分
  4. 关键分析部分 - 针对具体主题进行深入分析
  5. 指标与比较 - 表格、增长图表
  6. 优势与弱点 - 均衡评估
  7. 来源 - 分类列出的参考资料
  8. 置信度评估 - 按置信度等级列出主张
  9. 方法 - 所采用的研究方法
Mermaid 图表

在有帮助时加入图表：

时间线（甘特图）：

gantt
    title Project Timeline
    dateFormat YYYY-MM-DD
    section Phase 1
    Development    :2025-01-01, 2025-03-01
    section Phase 2
    Launch         :2025-03-01, 2025-04-01

架构（流程图）：

flowchart TD
    A[User] --> B[Coordinator]
    B --> C[Planner]
    C --> D[Research Team]
    D --> E[Reporter]

比较（饼图／柱状图）：

pie title Market Share
    "Project A" : 45
    "Project B" : 30
    "Others" : 25

置信度评分

根据来源质量分配置信度：

置信度标准
高（90%+）官方文档、GitHub 数据、多个相互印证的来源
中（70-89%）单一可靠来源、近期文章
低（50-69%）社交媒体、未经核实的主张、过时信息

输出

将报告保存为：research_{topic}_{YYYYMMDD}.md

格式规则
  • 中文内容：使用全角标点（，。：；！？）
  • 技术术语：首次出现时提供 Wiki／文档网址
  • 表格：用于呈现指标和比较
  • 代码块：用于技术示例
  • Mermaid：用于架构、时间线和流程

最佳实践

  1. 从官方来源入手 - 代码仓库、文档、公司博客
  2. 通过提交／拉取请求核实日期 - 比文章更可靠
  3. 交叉验证主张 - 至少使用 2 个独立来源
  4. 注明相互矛盾的信息 - 不要隐瞒矛盾之处
  5. 区分事实与观点 - 明确标注推测内容
  6. 重要：始终添加行内引用 - 对外部来源提供的每项主张，紧接其后使用 [citation:Title](URL) 格式
  7. 从搜索结果中提取网址 - web_search 返回 {title, url, snippet}，始终使用其中的 URL 字段
  8. 边研究边更新 - 不要等到最后才综合整理
引用示例

正确 - 包含行内引用：

The project gained 10,000 stars within 3 months of launch [citation:GitHub Stats](https://github.com/owner/repo).
The architecture uses LangGraph for workflow orchestration [citation:LangGraph Docs](https://langchain.com/langgraph).

错误 - 不含引用：

The project gained 10,000 stars within 3 months of launch.
The architecture uses LangGraph for workflow orchestration.

评论

支持 Markdown