Skip to content

Commit df4e8ce

Browse files
committed
docs: clarify watchdog dependency as Windows-specific issue
Update all README files (EN/ZH/JA) to specify that the watchdog installation requirement is primarily a Windows compatibility issue. Based on testing, macOS and Linux users typically don't encounter file watcher problems with uvx environments. Changes: - Updated warning sections to specify "(Windows)" in issue titles - Clarified that macOS/Linux users usually don't need manual watchdog installation - Updated troubleshooting sections with platform-specific findings - Improved user experience by reducing unnecessary setup steps for Unix-like systems
1 parent 1362410 commit df4e8ce

File tree

3 files changed

+18
-18
lines changed

3 files changed

+18
-18
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ The easiest way to get started with any MCP-compatible application:
136136

137137
**Prerequisites:** Python 3.10+, [uv](https://github.com/astral-sh/uv), and [watchdog](https://pypi.org/project/watchdog/) for file monitoring
138138

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.
139+
> **⚠️ Auto-refresh Issue (Windows):** If automatic index updates don't work after setup on Windows, try `pip install watchdog`. This is a known Windows-specific issue with environment isolation preventing file system monitoring. macOS and Linux users typically don't encounter this issue. See [Troubleshooting](#troubleshooting) for details.
140140
141141
1. **Add to your MCP configuration** (e.g., `claude_desktop_config.json` or `~/.claude.json`):
142142
```json
@@ -318,11 +318,11 @@ If the automatic index updates aren't working when files change, this may be rel
318318
pip install watchdog
319319
```
320320

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
321+
**What we've found:**
322+
- **Windows**: Environment isolation may prevent `watchdog` from accessing file system monitoring APIs properly
323+
- **macOS/Linux**: File watcher typically works out-of-the-box with `uvx` without additional setup
324+
- Installing `watchdog` in your system Python environment resolves Windows issues while maintaining `uvx` isolation benefits
325+
- This appears to be a Windows-specific compatibility issue with `uvx` environments
326326

327327
**Alternative solutions:**
328328
- Use manual refresh: Call the `refresh_index` tool after making file changes

README_ja.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ Code Index MCPは、AIモデルと複雑なコードベースの橋渡しをす
136136

137137
**前提条件:** Python 3.10+、[uv](https://github.com/astral-sh/uv)、ファイル監視用の [watchdog](https://pypi.org/project/watchdog/) がインストール済み
138138

139-
> **⚠️ 自動リフレッシュの問題:** セットアップ後に自動インデックス更新が動作しない場合`pip install watchdog` を試してください。これは環境分離によりファイルシステム監視が妨げられることが原因の可能性があります。詳細は [トラブルシューティング](#トラブルシューティング) をご覧ください。
139+
> **⚠️ 自動リフレッシュの問題(Windows)** Windows でセットアップ後に自動インデックス更新が動作しない場合`pip install watchdog` を試してください。これは環境分離によりファイルシステム監視が妨げられる Windows 固有の既知の問題です。macOS と Linux ユーザーは通常この問題に遭遇しません。詳細は [トラブルシューティング](#トラブルシューティング) をご覧ください。
140140
141141
1. **MCP設定に追加**(例:`claude_desktop_config.json` または `~/.claude.json`):
142142
```json
@@ -318,11 +318,11 @@ Pythonファイルのみで "API_ENDPOINT" を検索してください
318318
pip install watchdog
319319
```
320320

321-
**推定される原因**
322-
- `uvx` 環境は分離された依存関係管理を提供します
323-
- 一部のシステム(特にWindows)では、環境分離により `watchdog` がファイルシステム監視APIに適切にアクセスできない場合があります
324-
- システムPython環境に `watchdog` をインストールすることで、`uvx` 分離の他のすべての利点を維持しながら、この問題が解決されるようです
325-
- これはまだ調査中ですが、上記の回避策ですぐに動作するはずです
321+
**調査結果**
322+
- **Windows**:環境分離により `watchdog` がファイルシステム監視APIに適切にアクセスできない場合があります
323+
- **macOS/Linux**:ファイルウォッチャーは通常 `uvx` 環境で追加設定なしに動作します
324+
- システムPython環境に `watchdog` をインストールすることで、`uvx` 分離の利点を維持しながらWindows の問題が解決されます
325+
- これは `uvx` 環境での Windows 固有の互換性問題のようです
326326

327327
**代替解決策:**
328328
- 手動リフレッシュを使用:ファイル変更後に `refresh_index` ツールを呼び出す

README_zh.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@
136136

137137
**先決條件:** Python 3.10+、[uv](https://github.com/astral-sh/uv) 和用於檔案監控的 [watchdog](https://pypi.org/project/watchdog/) 已安裝
138138

139-
> **⚠️ 自動刷新問題:** 如果設定後自動索引更新無法運作,請嘗試 `pip install watchdog`這可能是由於環境隔離導致檔案系統監控無法正常運作。詳情請參閱 [故障排除](#故障排除)
139+
> **⚠️ 自動刷新問題(Windows)** 如果在 Windows 上設定後自動索引更新無法運作,請嘗試 `pip install watchdog`這是已知的 Windows 特定問題,環境隔離會阻止檔案系統監控。macOS 和 Linux 用戶通常不會遇到此問題。詳情請參閱 [故障排除](#故障排除)
140140
141141
1. **新增到您的 MCP 配置**(例如 `claude_desktop_config.json``~/.claude.json`):
142142
```json
@@ -318,11 +318,11 @@ pip install code-index-mcp
318318
pip install watchdog
319319
```
320320

321-
**我們懷疑發生的情況**
322-
- `uvx` 環境提供隔離的依賴管理
323-
- 在某些系統上(特別是 Windows),環境隔離可能會阻止 `watchdog` 正確存取檔案系統監控 API
324-
- 在系統 Python 環境中安裝 `watchdog` 似乎可以解決此問題,同時維持 `uvx` 隔離的所有其他優點
325-
- 這仍在調查中,但上述解決方法應該能讓您立即恢復工作
321+
**我們的發現**
322+
- **Windows**:環境隔離可能會阻止 `watchdog` 正確存取檔案系統監控 API
323+
- **macOS/Linux**:檔案監控器通常可以在 `uvx` 環境中直接運作,無需額外設定
324+
- 在系統 Python 環境中安裝 `watchdog` 可以解決 Windows 問題,同時維持 `uvx` 隔離的優點
325+
- 這似乎是 `uvx` 環境的 Windows 特定相容性問題
326326

327327
**替代解決方案:**
328328
- 使用手動刷新:在檔案變更後呼叫 `refresh_index` 工具

0 commit comments

Comments
 (0)