agentleFS
LangChainKnown publisherlangchain-ai/open_deep_research/src/legacy/CLAUDE.md

open_deep_research / legacy

CLAUDE.md13k starsChanged 15 months agoMITArchived repositoryView on GitHub

Open Deep Research is an experimental, fully open-source research assistant that automates deep research and produces comprehensive reports on any topic. It's designed to help researchers, analysts, and curious individuals generate detailed, well-sourced reports without manual research overhead. Open Deep Research offers two distinct approaches to automated research, each with unique advantages: The graph-based implementation (src/opendeepresearch/graph.py) follows a structured plan-and-execute workflow: Characteristics: - Interactive Planning: Uses a planner model to generate a structured report outline - Human-in-the-Loop: Allows review and…

We split this CLAUDE.md into the rules it gives an agent

3 rules. About 0 are common, 3 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Test both research agent implementations (multi-agent and graph-based)

    line 53
  2. Distinctive:

    Verify report quality against 9 comprehensive criteria

    line 55
  3. Distinctive:

    Structure and Flow: Do sections flow logically and create a cohesive narrative?

    line 88

≈ “Common” is an estimate: at least 1 in 5 of the 25,680 CLAUDE.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
CLAUDE.md

Open Deep Research

About Open Deep Research

Open Deep Research is an experimental, fully open-source research assistant that automates deep research and produces comprehensive reports on any topic. It's designed to help researchers, analysts, and curious individuals generate detailed, well-sourced reports without manual research overhead.

Key Features

  • Automated Research: Searches multiple sources (web, academic papers, specialized databases)
  • Comprehensive Reports: Generates structured markdown reports with proper citations
  • Multiple Search APIs: Supports Tavily, Perplexity, Exa, ArXiv, PubMed, DuckDuckGo, and more
  • Flexible Models: Compatible with any LLM that supports the init_chat_model() API
  • Quality Evaluation: Built-in evaluation systems to assess report quality

Two Research Implementations

Open Deep Research offers two distinct approaches to automated research, each with unique advantages:

1. Graph-based Workflow Implementation

The graph-based implementation (src/open_deep_research/graph.py) follows a structured plan-and-execute workflow:

Characteristics:

  • Interactive Planning: Uses a planner model to generate a structured report outline
  • Human-in-the-Loop: Allows review and feedback on the report plan before execution
  • Sequential Process: Creates sections one by one with reflection between iterations
  • Quality Focus: Emphasizes report accuracy and structure through iterative refinement

Best for:

  • High-stakes research where accuracy is critical
  • Reports requiring specific structure or customization
  • Situations where you want control over the research process
  • Academic or professional research contexts

2. Multi-Agent Implementation

The multi-agent implementation (src/open_deep_research/multi_agent.py) uses a supervisor-researcher architecture:

Characteristics:

  • Supervisor Agent: Manages overall research process and assembles final report
  • Parallel Research: Multiple researcher agents work simultaneously on different sections
  • Speed Optimized: Significantly faster due to parallel processing
  • Tool Specialization: Each agent has specific tools for their role

Best for:

  • Quick research and rapid report generation
  • Exploratory research where speed matters
  • Situations with less need for human oversight
  • Business intelligence and market research

Quality Evaluation

This guide explains how to quickly test and evaluate the quality of reports generated by Open Deep Research using the pytest evaluation system. The pytest evaluation system provides an easy way to:

  • Test both research agent implementations (multi-agent and graph-based)
  • Get immediate visual feedback with rich console output
  • Verify report quality against 9 comprehensive criteria
  • Compare different model configurations
  • Track results in LangSmith for analysis

Test Specific Agent

# Test only the multi-agent implementation
python tests/run_test.py --agent multi_agent

# Test only the graph-based implementation  
python tests/run_test.py --agent graph

Understanding the Output

Console Output

The evaluation provides rich visual feedback including:

  1. Test Configuration Panel: Shows which agent and search API are being tested
  2. Model Configuration Table: Displays all model settings in a formatted table
  3. Report Generation Status: Real-time feedback during report creation
  4. Generated Report Display: Full report rendered in markdown format
  5. Evaluation Results:
    • PASSED/FAILED status in color-coded panel
    • Report Structure Analysis: Table showing section headers
    • Evaluation Justification: Detailed explanation from the evaluator

What Gets Evaluated

The system checks reports against 9 quality criteria:

  1. Topic Relevance (Overall): Does the report address the input topic thoroughly?
  2. Section Relevance (Critical): Are all sections directly relevant to the main topic?
  3. Structure and Flow: Do sections flow logically and create a cohesive narrative?
  4. Introduction Quality: Does the introduction provide context and scope?
  5. Conclusion Quality: Does the conclusion summarize key findings?
  6. Structural Elements: Proper use of tables, lists, etc.
  7. Section Headers: Correct Markdown formatting (# for title, ## for sections)
  8. Citations: Proper source citation in each main body section
  9. Overall Quality: Well-researched, accurate, and professionally written

Download now (ZIP)

  • In this repositoryOne other file it gives its agents.

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

Reviews can't be read right now.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.