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
+21-5Lines changed: 21 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,7 +34,7 @@ GenFilesMCP is a Model Context Protocol (MCP) server that generates PowerPoint,
34
34
35
35
## Status
36
36
37
-
This is the **first stable version (v0.2.0)** designed for multi-user environments. It includes enhanced security, user-specific knowledge base integration, and improved document management.
37
+
This release is **v0.2.1**. It introduces a new environment variable `ENABLE_CREATE_KNOWLEDGE` that lets deployments choose whether generated or reviewed files are automatically added to users' knowledge collections. This enables coexistence between RAG-preserving deployments (do not enable knowledge creation) and deployments that want generated files saved to knowledge collections (requires enabling the Open Web UI document option `Bypass Embedding and Retrieval`). The original behavior (downloading files from chats) remains unchanged for end users.
38
38
39
39
## Prerequisites
40
40
@@ -49,19 +49,29 @@ This is the **first stable version (v0.2.0)** designed for multi-user environmen
49
49
Pull the pre-built Docker image from GitHub Container Registry:
docker run -d --restart unless-stopped -p YOUR_PORT:YOUR_PORT \
70
+
-e OWUI_URL="http://host.docker.internal:3000" \
71
+
-e PORT=YOUR_PORT \
72
+
-e ENABLE_CREATE_KNOWLEDGE=false \
73
+
--name gen_files_mcp \
74
+
ghcr.io/baronco/genfilesmcp:latest
65
75
```
66
76
67
77
### Option 2: Building from Source
@@ -88,6 +98,7 @@ docker run -d --restart unless-stopped \
88
98
-p YOUR_PORT:YOUR_PORT \
89
99
-e OWUI_URL="http://host.docker.internal:3000" \
90
100
-e PORT=YOUR_PORT \
101
+
-e ENABLE_CREATE_KNOWLEDGE=false \
91
102
--name gen_files_mcp \
92
103
genfilesmcp
93
104
```
@@ -102,6 +113,7 @@ The MCP server requires the following environment variables:
102
113
|----------|-------------|---------|
103
114
|`OWUI_URL`| URL of your Open Web UI instance |`http://host.docker.internal:3000`|
104
115
|`PORT`| Port where the MCP server will listen |`8015`|
116
+
|`ENABLE_CREATE_KNOWLEDGE`| Controls whether generated or reviewed files are automatically added to users' knowledge collections. Set to `true` to enable automatic creation/updating of knowledge collections; set to `false` to disable that behavior and preserve RAG workflows (recommended default for RAG users). NOTE: If `ENABLE_CREATE_KNOWLEDGE=true`, it is mandatory to enable the Open Web UI document option `Bypass Embedding and Retrieval`. |`false`|
105
117
106
118
### MCP Configuration in Open Web UI
107
119
@@ -202,7 +214,11 @@ This version integrates with Open Web UI's knowledge base system:
202
214
203
215
### MCP Server Document Upload Settings
204
216
205
-
To ensure that the upload of documents generated or reviewed by AI via the MCP server works for users or administrators, the `'Bypass Embedding and Retrieval'` option must be `enabled` in the Document options. Currently, I don't find an explanation of why, but to manage the knowledge of generated documents, it must be done.
217
+
To support automatic creation of knowledge collections for files generated or reviewed by the MCP server, the Open Web UI document option `Bypass Embedding and Retrieval` must be enabled. This is required only when `ENABLE_CREATE_KNOWLEDGE=true`.
218
+
219
+
Behavior summary:
220
+
- If `ENABLE_CREATE_KNOWLEDGE=false` (default recommended for RAG users): The MCP server will NOT create or update knowledge collections for generated/reviewed files. Users who rely on RAG or do not want knowledge collections created can keep this setting disabled and do NOT enable `Bypass Embedding and Retrieval`. Users will still be able to download generated/reviewed files from their chats as before.
221
+
- If `ENABLE_CREATE_KNOWLEDGE=true`: The MCP server will attempt to create/update per-user knowledge collections for generated/reviewed files. In this mode, you MUST enable `Bypass Embedding and Retrieval` in the Open Web UI document options so the knowledge creation/upload flow works correctly.
0 commit comments