Skip to content

Commit b14b2d8

Browse files
authored
docs: encourage run cocoindex-code index for large codebase (#46)
1 parent 2c038e6 commit b14b2d8

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,17 @@ Or use opencode.json:
8888
}
8989
```
9090

91-
Optionally, you can run `cocoindex-code index` to create or update the index. Without running it, the MCP server will automatically build and keep the index up-to-date in the background.
91+
### Build the Index
92+
93+
For large codebases, we recommend running the indexer once before using the MCP so you can see the progress:
94+
95+
```bash
96+
cocoindex-code index
97+
```
98+
99+
This lets you monitor the indexing process and ensure everything is ready. After the initial build, the MCP server will automatically keep the index up-to-date in the background as files change.
100+
101+
> For small projects you can skip this step — the MCP server will build the index automatically on first use.
92102
93103
## When Is the MCP Triggered?
94104

0 commit comments

Comments
 (0)