Metadata-Version: 2.4
Name: lit-review-council
Version: 0.1.3
Summary: Add your description here
Requires-Python: >=3.12
Requires-Dist: ddgs>=9.14.4
Requires-Dist: google-adk[extensions]>=2.3.0
Requires-Dist: mcp>=1.28.0
Requires-Dist: pydantic
Requires-Dist: python-dotenv
Description-Content-Type: text/markdown

# Multi-Agent Literature Review Pipeline

A multi-agent literature review pipeline built with the [Google ADK](https://github.com/google/google-adk) (Agent Development Kit). It coordinates specialized agents to iteratively research sub-topics based on a YAML configuration. For each topic, it searches from academic and practitioner perspectives, evaluates the work through a peer review ensemble, and synthesizes a well-grounded report.

Built as a capstone submission for the Kaggle "AI Agents: Intensive Vibe Coding Capstone".

## Motivation

Literature reviews are suffocating: hundreds of papers, conflicting claims, and no obvious signal in the noise. Andrej Karpathy's [LLM Council](https://github.com/karpathy/llm-council) showed that multi-agent debate surfaces sharper answers than a single prompt. This project takes that insight into the research domain.

LLMs researching complex topics suffer from two problems: lack of diverse grounding and self-preference bias (favoring their own outputs).

This pipeline addresses both:

1. **Tiered Orchestration**: A Planner agent splits configured research topics into a multi-wave execution graph. Foundational concepts (Wave 1) run in parallel, and synthesis-dependent topics (Wave 2) run sequentially with distilled context from Wave 1.
2. **Source Isolation**: Two independent tracks per topic, each with its own explorer (search) and reporter (write) agent. The academic track searches ArXiv, OpenAlex, and scholarly publishers. The practitioner track searches GitHub and engineering docs.
3. **Peer Review Ensemble**: Three reviewers (Researcher, Engineer, Architect) evaluate anonymized reports. Borda-count voting aggregates rankings so no single reviewer dominates.
4. **Anti-Hallucination Guardrails**: The Synthesis agent's output is parsed and validated. Dangling citations like `(Author, Year)` or `[1]` are rejected. Every URL in the final report must exist in the original source references, or the run is retried (up to 2 times). A blog-tier ratio check warns when over 50% of sources are blog/forum tier.

## Setup & Installation

### 1. Using the MCP Server (Recommended for Claude Desktop / AI Agents)

The server is published to PyPI as `lit-review-council`. You do not need to clone this repository to use it! `uvx` will automatically download and run it in an isolated environment.

**For Claude Desktop:**

1. Ensure you have [`uv`](https://docs.astral.sh/uv/) installed on your machine.
2. Open your Claude Desktop configuration file:
   - **Mac**: `~/Library/Application Support/Claude/claude_desktop_config.json`
   - **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
3. Add the server to the `mcpServers` object and provide your API keys in the `env` block:

```json
{
  "mcpServers": {
    "lit-review-council": {
      "command": "uvx",
      "args": ["lit-review-council"],
      "env": {
        "OPENROUTER_API_KEY": "sk-or-your-api-key",
        "GITHUB_TOKEN": "ghp_your-github-token",
        "TAVILY_API_KEY": "tvly-your-tavily-key",
        "OPENALEX_API_KEY": "your-openalex-key",
        "ENG_MODEL": "openrouter/openai/gpt-5.5",
        "RESEARCH_MODEL": "openrouter/google/gemini-3.5-flash",
        "JUDGE_MODEL": "openrouter/anthropic/claude-sonnet-4.6"
      }
    }
  }
}
```

4. **Restart Claude Desktop**.
5. In a new chat, simply ask Claude to: *"Conduct a literature review on [Topic]"*.

Once connected, your AI agent can natively fetch the `lit_review_council_instructions` prompt to understand exactly how to guide you through a structured literature review!

### 2. Local Developer Setup (Manual / CLI Usage)

If you want to run the pipeline manually via the terminal or develop the repository:

1. Clone the repository.
2. Copy `.env.example` to `.env` and fill in your keys:
   ```bash
   cp .env.example .env
   ```
3. Run the orchestrator pipeline with a configuration file:
   ```bash
   uv run python main.py --config topics.yaml --output okf_output --question "Overarching Research Question"
   ```

## Architecture

![Pipeline Architecture](docs/pipeline-architecture.png)

The pipeline is organized into **four stages**, with topics executed across **two waves** to balance parallelism and sequential dependency.

### Why Two Waves?

Not all research topics are independent. Some topics (e.g., foundational concepts like "truth maintenance systems") can be researched in parallel, while others (e.g., "multi-agent coordination using TMS") depend on the synthesized understanding of earlier topics.

The **Planner agent** reads `topics.yaml` and partitions topics into:

- **Wave 1** — parallel, independent topics. All topics in this wave run simultaneously through the full Stage 1→2→3 pipeline.
- **Wave 2** — sequential, dependent topics. These topics require the distilled context from Wave 1 before they can be researched accurately.

### Wave Handoff via the Distiller

After Wave 1 completes, the **Distiller agent** consumes the Wave 1 topic files and produces a compact summary of the foundational findings. This distilled context is injected into every Wave 2 topic's prompt as additional background, ensuring Wave 2 explorers and reporters build on top of verified Wave 1 conclusions rather than starting from scratch.

This prevents redundant searches and improves coherence across the final OKF bundle.

### Stage Breakdown

```
Stage 0 (Orchestration)
├── Planner agent organizes YAML topics into Wave 1 (parallel) and Wave 2 (sequential)
└── Distiller agent summarizes completed Wave 1 topics to provide prior context to Wave 2

Stage 1 (Parallel Fan-out per Topic)
├── Academic Track (SequentialAgent)
│   ├── academic_explorer  → searches ArXiv, OpenAlex, Tavily (scholarly domains)
│   └── academic_reporter  → writes Researcher report with structured references
└── Practitioner Track (SequentialAgent)
    ├── practitioner_explorer → searches GitHub, Tavily (engineering domains)
    └── practitioner_reporter → writes Engineer report with structured references

Stage 2 (Peer Review Ensemble per Topic)
├── researcher_reviewer  → ranks anonymized reports (Researcher perspective)
├── engineer_reviewer    → ranks anonymized reports (Engineer perspective)
└── architect_reviewer   → ranks anonymized reports (Architect perspective)
    → Borda-count tally → winning report selected

Stage 3 (Synthesis & Persistence)
├── synthesis agent → condensed final brief with YAML frontmatter
│   → citation validation loop (rejects hallucinated/dangling URLs, retries up to 2x)
└── Writes out to an interconnected Markdown OKF bundle (index.md and topic files)
```

## Search Providers

| Provider | Domains | Used By |
|----------|---------|---------|
| ArXiv API | arxiv.org | Academic explorer |
| OpenAlex API | openalex.org | Academic explorer |
| Tavily (scholarly) | acm.org, ieee.org, springer.com, sciencedirect.com, nature.com, science.org, wiley.com | Academic explorer |
| GitHub API | github.com | Practitioner explorer |
| Tavily (engineering) | github.com, docs.microsoft.com, aws.amazon.com, cloud.google.com, medium.com, dev.to | Practitioner explorer |

All providers use tenacity retry with exponential backoff for 429/5xx errors.

## Source Tiers

Every reference is classified into one of four tiers:

- **peer_reviewed**: ArXiv preprints, ACM/IEEE papers, conference proceedings
- **established_project**: GitHub repos with meaningful adoption (stars, active maintenance)
- **vendor_doc**: Official documentation from a company/project
- **blog_or_forum**: Medium, personal blogs, Stack Overflow, Reddit

The synthesis step warns when more than half of cited sources are blog_or_forum tier.

### Output

The pipeline runs all stages for each topic, executing them in waves where possible. On completion, it generates an interconnected Markdown bundle (OKF format) in the specified output directory, including an `index.md` linking to each specific topic file.