Skip to content

Commit 5a68b40

Browse files
committed
docs: use ~/knowledge-rag as default path (zero path editing needed)
1 parent be1bcb0 commit 5a68b40

1 file changed

Lines changed: 15 additions & 22 deletions

File tree

‎README.md‎

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -349,67 +349,60 @@ flowchart LR
349349
**Step 1: Clone and install**
350350

351351
```bash
352-
git clone https://github.com/lyonzin/knowledge-rag.git
353-
cd knowledge-rag
352+
# Clone to your home directory
353+
git clone https://github.com/lyonzin/knowledge-rag.git ~/knowledge-rag
354+
cd ~/knowledge-rag
354355
pip install -r requirements.txt
355356
```
356357

357-
Or install from PyPI into an existing project:
358-
```bash
359-
pip install knowledge-rag
360-
```
358+
> **Windows users**: `~/knowledge-rag` becomes `C:\Users\YourName\knowledge-rag`
361359
362360
**Step 2: Configure Claude Code**
363361

364-
Run this command to add the MCP server:
362+
From inside the cloned folder, run:
365363

366364
```bash
367-
# Windows
368-
claude mcp add knowledge-rag -- cmd /c "cd /d C:\path\to\knowledge-rag && python -m mcp_server.server"
369-
370-
# Linux / macOS
371-
claude mcp add knowledge-rag -- python -m mcp_server.server --cwd /path/to/knowledge-rag
365+
cd ~/knowledge-rag
366+
claude mcp add knowledge-rag -s user -- python -m mcp_server.server
372367
```
373368

374-
Or manually add to `~/.claude.json`:
369+
That's it. Claude Code now knows about your RAG server.
375370

376371
<details>
377-
<summary>Windows (manual config)</summary>
372+
<summary>Alternative: manual JSON config</summary>
373+
374+
Add to `~/.claude.json`:
378375

376+
**Windows:**
379377
```json
380378
{
381379
"mcpServers": {
382380
"knowledge-rag": {
383381
"type": "stdio",
384382
"command": "cmd",
385-
"args": ["/c", "cd /d C:\\path\\to\\knowledge-rag && python -m mcp_server.server"],
383+
"args": ["/c", "cd /d %USERPROFILE%\\knowledge-rag && python -m mcp_server.server"],
386384
"env": {}
387385
}
388386
}
389387
}
390388
```
391-
</details>
392-
393-
<details>
394-
<summary>Linux / macOS (manual config)</summary>
395389

390+
**Linux / macOS:**
396391
```json
397392
{
398393
"mcpServers": {
399394
"knowledge-rag": {
400395
"type": "stdio",
401396
"command": "python",
402397
"args": ["-m", "mcp_server.server"],
403-
"cwd": "/path/to/knowledge-rag",
398+
"cwd": "~/knowledge-rag",
404399
"env": {}
405400
}
406401
}
407402
}
408403
```
409404
</details>
410405

411-
> Replace `C:\path\to\knowledge-rag` with your actual clone path.
412-
413406
**Step 3: Restart Claude Code**
414407

415408
```bash

0 commit comments

Comments
 (0)