Skip to content

Commit 947a2fa

Browse files
committed
Update README with MCP instructions
Signed-off-by: Ettore Di Giacinto <mudler@localai.io>
1 parent 3f73ff3 commit 947a2fa

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -301,6 +301,34 @@ External sources are automatically monitored and updated in the background. The
301301

302302
---
303303

304+
## 🔌 Model Context Protocol (MCP) Integration
305+
306+
LocalRecall can be controlled via MCP (Model Context Protocol) through the [LocalRecall MCP Server](https://github.com/mudler/mcps/tree/master/localrecall) available in the [mcps repository](https://github.com/mudler/mcps).
307+
308+
The MCP server provides tools for:
309+
- 🔍 **Search**: Search content in collections
310+
-**Create Collection**: Create new collections
311+
- 🔄 **Reset Collection**: Clear collections
312+
- 📄 **Add Document**: Upload documents to collections
313+
- 📋 **List Collections**: List all available collections
314+
- 📁 **List Files**: List files in a collection
315+
- 🗑️ **Delete Entry**: Remove entries from collections
316+
317+
### Quick Start with MCP
318+
319+
The MCP server can be configured to enable specific tools for security and flexibility:
320+
321+
```bash
322+
docker run -e LOCALRECALL_URL=http://localhost:8080 \
323+
-e LOCALRECALL_API_KEY=your-api-key \
324+
-e LOCALRECALL_ENABLED_TOOLS="search,list_collections,add_document" \
325+
ghcr.io/mudler/mcps/localrecall:latest
326+
```
327+
328+
For more information and configuration options, see the [LocalRecall MCP Server documentation](https://github.com/mudler/mcps#-localrecall-server).
329+
330+
---
331+
304332
## 📝 License
305333

306334
Released under the [MIT License](LICENSE).

0 commit comments

Comments
 (0)