Skip to content

Commit ebdbacb

Browse files
committed
Reference workspaces support in Quick Start
1 parent 7a207b0 commit ebdbacb

File tree

2 files changed

+16
-14
lines changed

2 files changed

+16
-14
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ Add to your MCP configuration:
5858

5959
Your AI assistant will automatically start the MCP server and can now search your indexed files.
6060

61+
**Advanced:** For organizing content into focused search areas, see [Workspace Support](#workspace-support).
62+
6163
## Setup
6264

6365
Directory Indexer runs locally on your machine or server. It uses an embedding provider (such as Ollama) to create vector embeddings of your files and stores them in a Qdrant vector database for fast semantic search. Both services can run remotely if needed.
@@ -208,9 +210,9 @@ Organize content into workspaces for focused searches:
208210
"command": "npx",
209211
"args": ["directory-indexer@latest", "serve"],
210212
"env": {
211-
"WORKSPACE_DOCS": "/home/user/docs,/home/user/wiki",
212-
"WORKSPACE_PROJECTS": "/home/user/code/api,/home/user/code/web",
213-
"WORKSPACE_PERSONAL": "/home/user/notes,/home/user/journal"
213+
"WORKSPACE_CUSTOMER_CASES": "C:\\Users\\john\\Documents\\Support\\Cases,C:\\Users\\john\\Documents\\Incidents",
214+
"WORKSPACE_ENGINEERING_DOCS": "C:\\Users\\john\\Code\\API,C:\\Users\\john\\Code\\Web",
215+
"WORKSPACE_COMPANY_POLICIES": "C:\\Users\\john\\Documents\\Policies,C:\\Users\\john\\Documents\\Procedures"
214216
}
215217
}
216218
}
@@ -220,7 +222,7 @@ Organize content into workspaces for focused searches:
220222
**How workspaces work:**
221223
- Define workspace environments with `WORKSPACE_NAME` format
222224
- Use comma-separated paths or JSON arrays: `["path1", "path2"]`
223-
- Search within specific workspaces: _"Find API docs in projects workspace"_
225+
- Search within specific workspaces: _"Find issues about authentication in customer cases workspace"_
224226
- Your AI assistant can filter results to relevant workspace content
225227
- Use `server_info` to see available workspaces and their statistics
226228

docs/API.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -170,9 +170,9 @@ Search indexed content semantically.
170170

171171
```json
172172
{
173-
"query": "how to handle database connection timeouts and retry logic",
173+
"query": "authentication issues and login failures",
174174
"limit": 10,
175-
"workspace": "work"
175+
"workspace": "customer_cases"
176176
}
177177
```
178178

@@ -181,7 +181,7 @@ Search indexed content semantically.
181181
```json
182182
[
183183
{
184-
"filePath": "/work/incidents/redis-timeout.md",
184+
"filePath": "C:\\Users\\john\\Documents\\Support\\Cases\\redis-timeout.md",
185185
"score": 0.89,
186186
"fileSizeBytes": 2048,
187187
"matchingChunks": 3,
@@ -207,9 +207,9 @@ Find files similar to a given file.
207207

208208
```json
209209
{
210-
"file_path": "/work/incidents/database-outage.md",
210+
"file_path": "C:\\Users\\john\\Documents\\Support\\Cases\\auth-failure.md",
211211
"limit": 10,
212-
"workspace": "work"
212+
"workspace": "customer_cases"
213213
}
214214
```
215215

@@ -218,7 +218,7 @@ Find files similar to a given file.
218218
```json
219219
[
220220
{
221-
"filePath": "/work/incidents/redis-timeout.md",
221+
"filePath": "C:\\Users\\john\\Documents\\Incidents\\redis-timeout.md",
222222
"score": 0.91,
223223
"fileSizeBytes": 1536
224224
}
@@ -292,15 +292,15 @@ Get server information and status.
292292
"errors": [],
293293
"workspaces": [
294294
{
295-
"name": "docs",
296-
"paths": ["/home/user/docs", "/home/user/wiki"],
295+
"name": "customer_cases",
296+
"paths": ["C:\\Users\\john\\Documents\\Support\\Cases", "C:\\Users\\john\\Documents\\Incidents"],
297297
"isValid": true,
298298
"filesCount": 156,
299299
"chunksCount": 892
300300
},
301301
{
302-
"name": "projects",
303-
"paths": ["/home/user/code/api", "/home/user/code/web"],
302+
"name": "engineering_docs",
303+
"paths": ["C:\\Users\\john\\Code\\API", "C:\\Users\\john\\Code\\Web"],
304304
"isValid": true,
305305
"filesCount": 1091,
306306
"chunksCount": 2999

0 commit comments

Comments
 (0)