You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+104Lines changed: 104 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -511,6 +511,106 @@ mcp:
511
511
}
512
512
```
513
513
514
+
### 📚 LocalRecall Server
515
+
516
+
A knowledge base management server that provides tools to interact with LocalRecall's REST API for managing collections, searching content, and managing documents.
517
+
518
+
**Features:**
519
+
- Search content in collections
520
+
- Create and reset collections
521
+
- Add documents to collections
522
+
- List collections and files
523
+
- Delete entries from collections
524
+
- Configurable tool enablement for security
525
+
526
+
**Tools:**
527
+
- `search`- Search content in a LocalRecall collection
528
+
- `create_collection`- Create a new collection
529
+
- `reset_collection`- Reset (clear) a collection
530
+
- `add_document`- Add a document to a collection
531
+
- `list_collections`- List all collections
532
+
- `list_files`- List files in a collection
533
+
- `delete_entry`- Delete an entry from a collection
534
+
535
+
**Configuration:**
536
+
- `LOCALRECALL_URL` - Base URL for LocalRecall API (default: `http://localhost:8080`)
537
+
- `LOCALRECALL_API_KEY` - Optional API key for authentication (sent as `Authorization: Bearer <key>`)
538
+
- `LOCALRECALL_ENABLED_TOOLS` - Comma-separated list of tools to enable (default: all tools enabled). Valid values: `search`, `create_collection`, `reset_collection`, `add_document`, `list_collections`, `list_files`, `delete_entry`
539
+
540
+
**Search Input Format:**
541
+
```json
542
+
{
543
+
"collection_name": "myCollection",
544
+
"query": "search term",
545
+
"max_results": 5
546
+
}
547
+
```
548
+
549
+
**Search Output Format:**
550
+
```json
551
+
{
552
+
"query": "search term",
553
+
"max_results": 5,
554
+
"results": [
555
+
{
556
+
"content": "...",
557
+
"metadata": {...}
558
+
}
559
+
],
560
+
"count": 1
561
+
}
562
+
```
563
+
564
+
**Add Document Input Format:**
565
+
```json
566
+
{
567
+
"collection_name": "myCollection",
568
+
"file_path": "/path/to/file.txt",
569
+
"filename": "file.txt"
570
+
}
571
+
```
572
+
573
+
Or with inline content:
574
+
```json
575
+
{
576
+
"collection_name": "myCollection",
577
+
"file_content": "Document content here",
578
+
"filename": "document.txt"
579
+
}
580
+
```
581
+
582
+
**Docker Image:**
583
+
```bash
584
+
docker run -e LOCALRECALL_URL=http://localhost:8080 -e LOCALRECALL_API_KEY=your-key-here ghcr.io/mudler/mcps/localrecall:latest
585
+
```
586
+
587
+
**Enable specific tools only:**
588
+
```bash
589
+
docker run -e LOCALRECALL_URL=http://localhost:8080 -e LOCALRECALL_ENABLED_TOOLS="search,list_collections,list_files" ghcr.io/mudler/mcps/localrecall:latest
590
+
```
591
+
592
+
**LocalAI configuration (to add to the model config):**
0 commit comments