File size: 3,271 Bytes
59ce7b1 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 |
# Quickstart Guide
Get DeepBoner running in 5 minutes.
## Prerequisites
- Python 3.11+ installed
- Repository cloned and dependencies installed (see [Installation](installation.md))
## 1. Start the Application
```bash
# From the repository root
uv run python src/app.py
```
You should see:
```
Running on local URL: http://127.0.0.1:7860
```
## 2. Open the UI
Navigate to http://localhost:7860 in your browser.
You'll see a chat interface with:
- Input field for research questions
- Optional API key input (for premium features)
- Research results display
## 3. Ask Your First Question
Try one of these example queries:
```
What drugs improve female libido post-menopause?
```
```
Clinical trials for ED alternatives to PDE5 inhibitors?
```
```
Evidence for testosterone therapy in women with HSDD?
```
## 4. Understanding the Output
DeepBoner will:
1. **Search** multiple biomedical databases:
- PubMed (peer-reviewed literature)
- ClinicalTrials.gov (active/completed trials)
- Europe PMC (preprints and papers)
- OpenAlex (scholarly metadata)
2. **Judge** evidence quality using LLM
3. **Loop** if more evidence is needed
4. **Synthesize** a research report with citations
You'll see status updates as each phase completes.
## 5. Free vs Premium Mode
### Free Mode (No API Key)
- Uses HuggingFace Inference API
- Model: Qwen 2.5 7B Instruct
- Slower but fully functional
### Premium Mode (With OpenAI Key)
- Enter your OpenAI API key in the UI
- Uses GPT-5 for better synthesis
- Faster and more detailed reports
To use premium mode:
1. Get an API key from [OpenAI](https://platform.openai.com)
2. Enter it in the "OpenAI API Key" field
3. Your queries will automatically use GPT-5
## 6. Using MCP Tools
DeepBoner exposes MCP (Model Context Protocol) tools for integration with Claude Desktop and other clients.
### MCP Server URL
```
http://localhost:7860/gradio_api/mcp/
```
### Available Tools
- `search_pubmed` - Search peer-reviewed literature
- `search_clinical_trials` - Search clinical trials
- `search_europepmc` - Search Europe PMC
- `search_all_sources` - Search all sources with deduplication
### Claude Desktop Configuration
Add to your `claude_desktop_config.json`:
```json
{
"mcpServers": {
"deepboner": {
"url": "http://localhost:7860/gradio_api/mcp/"
}
}
}
```
## Example Scripts
For programmatic usage, see the example scripts:
```bash
# Search demo
uv run python examples/search_demo/run_search.py
# Full orchestrator demo
uv run python examples/orchestrator_demo/run_agent.py
# Multi-agent demo (requires OpenAI key)
uv run python examples/orchestrator_demo/run_magentic.py
```
## Next Steps
- [Configuration Guide](configuration.md) - Customize settings
- [MCP Integration](../deployment/mcp-integration.md) - Set up Claude Desktop
- [Architecture Overview](../architecture/overview.md) - Understand how it works
## Troubleshooting
**Slow first response?**
- First query loads ML models (sentence-transformers)
- Subsequent queries are faster
**No results?**
- Check your internet connection
- External APIs may have rate limits
**Rate limit errors?**
- Add NCBI_API_KEY for higher PubMed limits
- Wait and retry
See [Troubleshooting](troubleshooting.md) for more help.
|