Skip to content

Commit 788a8e9

Browse files
committed
docs: simplify setup prerequisites and streamline auto-refresh troubleshooting
Remove watchdog from required dependencies while keeping it as troubleshooting option for auto-refresh issues. Updated across all README language versions.
1 parent 314b793 commit 788a8e9

File tree

4 files changed

+10
-52
lines changed

4 files changed

+10
-52
lines changed

README.md

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -134,9 +134,7 @@ Code Index MCP is a [Model Context Protocol](https://modelcontextprotocol.io) se
134134

135135
The easiest way to get started with any MCP-compatible application:
136136

137-
**Prerequisites:** Python 3.10+, [uv](https://github.com/astral-sh/uv), and [watchdog](https://pypi.org/project/watchdog/) for file monitoring
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.
137+
**Prerequisites:** Python 3.10+ and [uv](https://github.com/astral-sh/uv)
140138

141139
1. **Add to your MCP configuration** (e.g., `claude_desktop_config.json` or `~/.claude.json`):
142140
```json
@@ -311,20 +309,8 @@ I added new components, please refresh the project index
311309

312310
### 🔄 **Auto-refresh Not Working**
313311

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:**
312+
If automatic index updates aren't working when files change, try:
313+
- `pip install watchdog` (may resolve environment isolation issues)
328314
- Use manual refresh: Call the `refresh_index` tool after making file changes
329315
- Check file watcher status: Use `get_file_watcher_status` to verify monitoring is active
330316

README_ja.md

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

135135
任意のMCP対応アプリケーションで開始する最も簡単な方法:
136136

137-
**前提条件:** Python 3.10+、[uv](https://github.com/astral-sh/uv)、ファイル監視用の [watchdog](https://pypi.org/project/watchdog/) がインストール済み
138-
139-
> **⚠️ 自動リフレッシュの問題:** セットアップ後に自動インデックス更新が動作しない場合、`pip install watchdog` を試してください。これは環境分離によりファイルシステム監視が妨げられることが原因の可能性があります。詳細は [トラブルシューティング](#トラブルシューティング) をご覧ください。
137+
**前提条件:** Python 3.10+ と [uv](https://github.com/astral-sh/uv)
140138

141139
1. **MCP設定に追加**(例:`claude_desktop_config.json` または `~/.claude.json`):
142140
```json
@@ -311,20 +309,8 @@ Pythonファイルのみで "API_ENDPOINT" を検索してください
311309

312310
### 🔄 **自動リフレッシュが動作しない**
313311

314-
ファイル変更時に自動インデックス更新が動作しない場合、これは `watchdog` 依存関係の環境分離の問題が関連している可能性があります。
315-
316-
**クイック解決策:**
317-
```bash
318-
pip install watchdog
319-
```
320-
321-
**推定される原因:**
322-
- `uvx` 環境は分離された依存関係管理を提供します
323-
- 一部のシステム(特にWindows)では、環境分離により `watchdog` がファイルシステム監視APIに適切にアクセスできない場合があります
324-
- システムPython環境に `watchdog` をインストールすることで、`uvx` 分離の他のすべての利点を維持しながら、この問題が解決されるようです
325-
- これはまだ調査中ですが、上記の回避策ですぐに動作するはずです
326-
327-
**代替解決策:**
312+
ファイル変更時に自動インデックス更新が動作しない場合、以下を試してください:
313+
- `pip install watchdog`(環境分離の問題を解決する可能性があります)
328314
- 手動リフレッシュを使用:ファイル変更後に `refresh_index` ツールを呼び出す
329315
- ファイルウォッチャーステータスを確認:`get_file_watcher_status` を使用して監視がアクティブかどうかを確認
330316

README_zh.md

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -134,9 +134,7 @@
134134

135135
在任何相容 MCP 的應用程式中開始使用的最簡單方法:
136136

137-
**先決條件:** Python 3.10+、[uv](https://github.com/astral-sh/uv) 和用於檔案監控的 [watchdog](https://pypi.org/project/watchdog/) 已安裝
138-
139-
> **⚠️ 自動刷新問題:** 如果設定後自動索引更新無法運作,請嘗試 `pip install watchdog`。這可能是由於環境隔離導致檔案系統監控無法正常運作。詳情請參閱 [故障排除](#故障排除)
137+
**先決條件:** Python 3.10+ 和 [uv](https://github.com/astral-sh/uv)
140138

141139
1. **新增到您的 MCP 配置**(例如 `claude_desktop_config.json``~/.claude.json`):
142140
```json
@@ -311,20 +309,8 @@ pip install code-index-mcp
311309

312310
### 🔄 **自動刷新無法運作**
313311

314-
如果檔案變更時自動索引更新無法運作,這可能與 `watchdog` 依賴項的環境隔離問題有關。
315-
316-
**快速解決方案:**
317-
```bash
318-
pip install watchdog
319-
```
320-
321-
**我們懷疑發生的情況:**
322-
- `uvx` 環境提供隔離的依賴管理
323-
- 在某些系統上(特別是 Windows),環境隔離可能會阻止 `watchdog` 正確存取檔案系統監控 API
324-
- 在系統 Python 環境中安裝 `watchdog` 似乎可以解決此問題,同時維持 `uvx` 隔離的所有其他優點
325-
- 這仍在調查中,但上述解決方法應該能讓您立即恢復工作
326-
327-
**替代解決方案:**
312+
如果檔案變更時自動索引更新無法運作,請嘗試:
313+
- `pip install watchdog`(可能解決環境隔離問題)
328314
- 使用手動刷新:在檔案變更後呼叫 `refresh_index` 工具
329315
- 檢查檔案監視器狀態:使用 `get_file_watcher_status` 驗證監控是否處於活動狀態
330316

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)