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
+62Lines changed: 62 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -535,9 +535,14 @@ A knowledge base management server that provides tools to interact with [LocalRe
535
535
**Configuration:**
536
536
- `LOCALRECALL_URL` - Base URL for LocalRecall API (default: `http://localhost:8080`)
537
537
- `LOCALRECALL_API_KEY` - Optional API key for authentication (sent as `Authorization: Bearer <key>`)
538
+
- `LOCALRECALL_COLLECTION`- Default collection name (if set, tools are registered without `collection_name` parameter - the collection is automatically used from the environment variable)
538
539
- `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
541
+
**Note:** When `LOCALRECALL_COLLECTION` is set, the tools `search`, `add_document`, `list_files`, and `delete_entry` are registered with different input schemas that do not include the `collection_name` parameter. The collection name is automatically taken from the environment variable.
542
+
540
543
**Search Input Format:**
544
+
545
+
When `LOCALRECALL_COLLECTION` is **not** set:
541
546
```json
542
547
{
543
548
"collection_name": "myCollection",
@@ -546,6 +551,14 @@ A knowledge base management server that provides tools to interact with [LocalRe
546
551
}
547
552
```
548
553
554
+
When `LOCALRECALL_COLLECTION` is set (e.g., `LOCALRECALL_COLLECTION=myCollection`), the tool schema does not include `collection_name`:
555
+
```json
556
+
{
557
+
"query": "search term",
558
+
"max_results": 5
559
+
}
560
+
```
561
+
549
562
**Search Output Format:**
550
563
```json
551
564
{
@@ -562,6 +575,8 @@ A knowledge base management server that provides tools to interact with [LocalRe
562
575
```
563
576
564
577
**Add Document Input Format:**
578
+
579
+
When `LOCALRECALL_COLLECTION` is **not** set:
565
580
```json
566
581
{
567
582
"collection_name": "myCollection",
@@ -579,11 +594,57 @@ Or with inline content:
579
594
}
580
595
```
581
596
597
+
When `LOCALRECALL_COLLECTION` is set, the tool schema does not include `collection_name`:
598
+
```json
599
+
{
600
+
"file_path": "/path/to/file.txt",
601
+
"filename": "file.txt"
602
+
}
603
+
```
604
+
605
+
**List Files Input Format:**
606
+
607
+
When `LOCALRECALL_COLLECTION` is **not** set:
608
+
```json
609
+
{
610
+
"collection_name": "myCollection"
611
+
}
612
+
```
613
+
614
+
When `LOCALRECALL_COLLECTION` is set, the tool schema has no parameters (empty object):
615
+
```json
616
+
{}
617
+
```
618
+
619
+
**Delete Entry Input Format:**
620
+
621
+
When `LOCALRECALL_COLLECTION` is **not** set:
622
+
```json
623
+
{
624
+
"collection_name": "myCollection",
625
+
"entry": "filename.txt"
626
+
}
627
+
```
628
+
629
+
When `LOCALRECALL_COLLECTION` is set, the tool schema does not include `collection_name`:
630
+
```json
631
+
{
632
+
"entry": "filename.txt"
633
+
}
634
+
```
635
+
582
636
**Docker Image:**
583
637
```bash
584
638
docker run -e LOCALRECALL_URL=http://localhost:8080 -e LOCALRECALL_API_KEY=your-key-here ghcr.io/mudler/mcps/localrecall:latest
585
639
```
586
640
641
+
**With default collection (tools will not require `collection_name` parameter):**
642
+
```bash
643
+
docker run -e LOCALRECALL_URL=http://localhost:8080 -e LOCALRECALL_COLLECTION=myCollection ghcr.io/mudler/mcps/localrecall:latest
644
+
```
645
+
646
+
When `LOCALRECALL_COLLECTION` is set, the collection-specific tools (`search`, `add_document`, `list_files`, `delete_entry`) are automatically configured to use that collection, and the `collection_name` parameter is removed from their input schemas.
647
+
587
648
**Enable specific tools only:**
588
649
```bash
589
650
docker run -e LOCALRECALL_URL=http://localhost:8080 -e LOCALRECALL_ENABLED_TOOLS="search,list_collections,list_files" ghcr.io/mudler/mcps/localrecall:latest
0 commit comments