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
docs: add watchdog troubleshooting for auto-refresh issues
Add troubleshooting section to README documenting the uvx environment
watchdog issue where automatic index updates may fail due to environment
isolation preventing file system monitoring APIs access.
- Add warning in Quick Start section for immediate visibility
- Include workaround solution: pip install watchdog
- Explain suspected cause related to uvx environment isolation
- Provide alternative manual refresh options
- Mark as under investigation to set proper expectations
Copy file name to clipboardExpand all lines: README.md
+23Lines changed: 23 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -136,6 +136,8 @@ The easiest way to get started with any MCP-compatible application:
136
136
137
137
**Prerequisites:** Python 3.10+, [uv](https://github.com/astral-sh/uv), and [watchdog](https://pypi.org/project/watchdog/) for file monitoring
138
138
139
+
> **⚠️ Auto-refresh Issue:** If automatic index updates don't work after setup, try `pip install watchdog`. This may be due to environment isolation preventing file system monitoring. See [Troubleshooting](#troubleshooting) for details.
140
+
139
141
1.**Add to your MCP configuration** (e.g., `claude_desktop_config.json` or `~/.claude.json`):
140
142
```json
141
143
{
@@ -305,6 +307,27 @@ I added new components, please refresh the project index
305
307
306
308
</details>
307
309
310
+
## Troubleshooting
311
+
312
+
### 🔄 **Auto-refresh Not Working**
313
+
314
+
If the automatic index updates aren't working when files change, this may be related to environment isolation issues with the `watchdog` dependency.
315
+
316
+
**Quick Solution:**
317
+
```bash
318
+
pip install watchdog
319
+
```
320
+
321
+
**What we suspect is happening:**
322
+
- The `uvx` environment provides isolated dependency management
323
+
- On some systems (particularly Windows), environment isolation may prevent `watchdog` from accessing the file system monitoring APIs properly
324
+
- Installing `watchdog` in your system Python environment appears to resolve this issue while maintaining all other benefits of `uvx` isolation
325
+
- This is still under investigation, but the workaround above should get you working immediately
326
+
327
+
**Alternative solutions:**
328
+
- Use manual refresh: Call the `refresh_index` tool after making file changes
329
+
- Check file watcher status: Use `get_file_watcher_status` to verify monitoring is active
0 commit comments