MCP_Research / README.md
mgbam's picture
Update README.md
250d62e verified
---
title: MCP Research
emoji: πŸš€
colorFrom: red
colorTo: red
sdk: docker
app_port: 8501
tags:
- streamlit
pinned: false
short_description: Streamlit template space
---
# AI-Powered Scientific Research Companion
Welcome to your AI-driven research assistantβ€”hosted as a Hugging Face Space!
---
## πŸš€ Live Demo
πŸ‘‰ https://huggingface.co/spaces/your-username/MCP_Research
---
## Features
- πŸ” **One-Click Discovery**
Search academic articles, preprints, and the open web via MCP servers (`pskill9/web-search`, `metatool-ai/metatool-app`).
- πŸ““ **Reproducible Notebook**
Fetch and run code snippets for core experiments using a Python-run MCP sandbox.
- πŸ”— **Interactive Knowledge Graph**
Build and explore concept‐and‐method graphs via a vector-store MCP (Chroma).
- πŸ› οΈ **Provenance Tracking**
Store metadata and execution history in a SQL database via MCP.
- 🎨 **Light & Dark Themes**
Toggle UI themes for day/night readability.
---
## πŸ”§ Setup
1. **Fork or Clone**
```bash
git clone https://huggingface.co/spaces/your-username/MCP_Research.git
cd MCP_Research
Configure Endpoints
Copy and edit config.example.yaml β†’ config.yaml:
yaml
Copy code
mcp_servers:
web_search: http://localhost:3000
pubmed: http://localhost:3001
chroma: http://localhost:3002
python_run: http://localhost:3003
db_url: sqlite:///embeddings.db
Install Dependencies
bash
Copy code
pip install -r requirements.txt
Run Locally (optional)
bash
Copy code
streamlit run app.py --server.port 8501 --server.address 0.0.0.0
πŸ“¦ Deployment on Hugging Face
Create a New Space
Choose Streamlit as the runtime.
Push your repo to the Space.
Environment Variables / Secrets
In your Space’s Settings β†’ Secrets, add any API keys or credentials required by your MCP endpoints.
Automatic Build & Launch
HF will install from requirements.txt and launch app.py automatically.
πŸ“ Project Layout
arduino
Copy code
β”œβ”€β”€ .gitignore
β”œβ”€β”€ README.md
β”œβ”€β”€ config.yaml
β”œβ”€β”€ requirements.txt
β”œβ”€β”€ Dockerfile
β”œβ”€β”€ app.py
β”œβ”€β”€ orchestrator/
β”‚ β”œβ”€β”€ client.py
β”‚ β”œβ”€β”€ dispatcher.py
β”‚ └── provenance.py
β”œβ”€β”€ components/
β”‚ β”œβ”€β”€ sidebar.py
β”‚ β”œβ”€β”€ paper_list.py
β”‚ β”œβ”€β”€ notebook_view.py
β”‚ └── graph_view.py
β”œβ”€β”€ scripts/
β”‚ β”œβ”€β”€ ingest.py
β”‚ └── reindex.py
└── demo.ipynb
🀝 Contribute
⭐ Star this Space
πŸ› Report issues or suggest features
πŸ”€ Submit PRs β€” we welcome enhancements and new MCP integrations!
πŸ“œ License
MIT Β© 2025