docs(mcp): explain indexing status semantics#302
Open
Nottlespike wants to merge 1 commit intozilliztech:masterfrom
Open
docs(mcp): explain indexing status semantics#302Nottlespike wants to merge 1 commit intozilliztech:masterfrom
Nottlespike wants to merge 1 commit intozilliztech:masterfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR clarifies how MCP indexing status should be interpreted by documenting that get_indexing_status reports coarse, phase-based progress (not a live file-count ratio), explaining why completed entries can show stale 0 files, 0 chunks, and noting that indexed codebases are tracked by absolute path (so the same repo under different paths is treated separately).
Changes:
- Documented phase-based progress semantics for
get_indexing_status(including why progress can appear “jumpy”). - Explained snapshot-based (potentially stale) file/chunk counts and how to refresh them via clear + re-index.
- Clarified absolute-path identity behavior for codebases across README, workflow guide, and FAQ.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/mcp/README.md | Adds a concise explanation of indexing status semantics and links to deeper docs. |
| docs/dive-deep/asynchronous-indexing-workflow.md | Adds detailed breakdown of progress phases, snapshot persistence, and path-based codebase identity. |
| docs/troubleshooting/faq.md | Adds targeted FAQ entries covering coarse progress and stale 0 files, 0 chunks, plus path identity note. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
get_indexing_statusreports coarse phase-based progress rather than a live file-count ratio0 files, 0 chunkssnapshot metadataDocs updated
packages/mcp/README.mddocs/dive-deep/asynchronous-indexing-workflow.mddocs/troubleshooting/faq.mdVerification
pnpm installpnpm buildBoth commands completed successfully in the local fork clone before opening this PR.