---
# ✅ RagMCP Project Manual (Developer Guide)
---
## 🔥 1. Project Overview
RagMCP is a **local command-based assistant** that:
✅ Opens websites
✅ Plays YouTube songs using Playwright
✅ Controls system tools (create folder, set wallpaper, shutdown PC)
✅ Searches websites like FitGirl, Pinterest, etc.
It works using a **server (ragmcp)** that listens to JSON commands and performs actions.
---
# 📥 2. Download the Project
### Option 1: Clone GitHub Repo
```bash
git clone https://github.com/yourusername/RagMCP.git
cd RagMCP
```
### Option 2: Download Zip
1. Click **Download Zip**
2. Extract to `D:\MINI PROJECTS\RAGMCP`
---
# 🧰 3. Setup Python Environment
### 3.1 Create Virtual Environment
```bash
python -m venv .venv
```
### 3.2 Activate Virtual Environment
#### Windows PowerShell
```bash
.\.venv\Scripts\Activate
```
---
# 📦 4. Install Required Packages
Run:
```bash
pip install -r requirements.txt
```
**If requirements.txt not exist**, install manually:
```bash
pip install playwright pyautogui
pip install psutil
```
### ⚠️ Playwright Browser Setup
```bash
playwright install
```
---
# 🚀 5. Run the Server
### Start RagMCP Server
```bash
ragmcp
```
If command not found:
```bash
python -m ragmcp
```
---
# 🧩 6. How to Use RagMCP (JSON Commands)
### Example format:
```json
{"id": 1, "method": "METHOD_NAME", "params": {"param": "value"}}
```
---
# 🎯 7. YouTube Tool Commands
### Case 1: Play Specific Song
```json
{"id": 1, "method": "play_youtube_direct", "params": {"query": "Naa Ready song"}}
```
### Case 2: Play Trending Music
```json
{"id": 1, "method": "play_trending_music", "params": {}}
```
### Case 3: Play Favourite Song
```json
{"id": 1, "method": "play_youtube_from_favourites", "params": {"favourite": "A.R. Rahman"}}
```
### Mood Based Music
```json
{"id": 1, "method": "play_youtube_mood", "params": {"mood": "happy"}}
```
---
# 🌐 8. Web Tools Commands
### Open any website
```json
{"id": 1, "method": "open_website", "params": {"site": "google"}}
```
### Search on Google
```json
{"id": 1, "method": "search_google", "params": {"query": "Thalapathy aesthetic"}}
```
### Search on FitGirl
```json
{"id": 1, "method": "search_fitgirl", "params": {"query": "Batman Arkham City"}}
```
### Search on Pinterest
```json
{"id": 1, "method": "search_pinterest", "params": {"query": "Thalapathy aesthetics"}}
```
---
# 🖥️ 9. System Tools Commands
### Create Folder
```json
{"id": 1, "method": "create_folder", "params": {"path": "C:\\Users\\User\\Desktop\\afrah"}}
```
### Set Wallpaper
```json
{"id": 1, "method": "set_wallpaper", "params": {"path": "D:\\wallpapers\\image.jpg"}}
```
### Shutdown PC
```json
{"id": 1, "method": "shutdown_pc", "params": {}}
```
---
# 🧠 10. Important Notes
✔️ Always run **ragmcp server first**
✔️ Use **Chrome-based browsers** for best stability
✔️ Playwright opens browser automatically and waits until user closes it
✔️ Do not change logic without understanding it
---
# 🏁 Project Finalization
Once you run all tools and verify functionality:
✅ Save project
✅ Commit to GitHub
✅ Share with developer
---
