Anthropic: Claude 3 (Sonnet, Opus, Haiku)

Groq: Fast inference with various open-source models

File Naming Convention

Downloaded reports use the format: {sanitized_title}_{source_type}.pdf

Example: artificial_intelligence_healthcare_web_academic.pdf

📚 API Reference

MCP Tools

`deep_research`

Perform comprehensive research on a topic.

Parameters:

query (string, required): Research question or topic
sources (string, optional): Source type ("web", "academic", "both")
num_results (integer, optional): Number of sources to examine

Returns: Formatted research results with sources and content

`research_prompt`

Generate a structured research prompt for multi-stage research.

Parameters:

topic (string, required): Topic to research

Returns: Comprehensive research prompt with methodology

HTTP API Endpoints

`POST /deep_research`

Execute research query via HTTP.

{
  "query": "string",
  "sources": "both",
  "num_results": 2
}

`GET /health`

Health check endpoint.

`GET /docs`

Interactive API documentation (Swagger UI).

Web UI API Endpoints

`POST /research`

Start a new research job.

`GET /research/{job_id}`

Get research job status and results.

`GET /research/{job_id}/progress`

Get detailed progress for a research job.

🛠 Development

Project Structure

analysis_alpaca/
├── src/analysis_alpaca/
│   ├── __init__.py
│   ├── config.py              # Configuration management
│   ├── core/
│   │   ├── __init__.py
│   │   ├── server.py          # MCP server implementation
│   │   └── research_service.py # Research orchestration
│   ├── search/
│   │   ├── __init__.py
│   │   ├── base.py           # Base searcher class
│   │   ├── web_search.py     # DuckDuckGo implementation
│   │   ├── academic_search.py # Semantic Scholar implementation
│   │   └── content_extractor.py # Content extraction
│   ├── models/
│   │   ├── __init__.py
│   │   └── research.py       # Data models
│   ├── utils/
│   │   ├── __init__.py
│   │   ├── logging.py        # Logging utilities
│   │   └── text.py          # Text processing
│   └── exceptions/
│       ├── __init__.py
│       └── base.py          # Custom exceptions
├── web_ui/
│   ├── frontend/            # React.js application
│   └── backend/             # FastAPI backend
├── tests/                   # Test suite
├── http_server.py          # HTTP wrapper
├── requirements.txt        # Dependencies
├── pyproject.toml         # Package configuration
└── Makefile              # Development commands

Development Setup

# Install with development dependencies
pip install -e ".[dev,ai]"

# Set up pre-commit hooks (optional)
pre-commit install

# Run tests
make test

# Code formatting
make format

# Linting
make lint

# Type checking
make type-check

Adding New Search Providers

Create a new searcher class inheriting from BaseSearcher
Implement the search() method
Add the searcher to ResearchService
Update configuration and documentation

Example:

Categories

Current Category: academic-search

Analysis-Alpaca-Researcher