Skip to content

Commit 26efce9

Browse files
committed
docs(indexing): add tier ux hint and expand README
1 parent 2c270d6 commit 26efce9

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,11 @@ Indexing is tiered so you can choose between speed/storage and graph richness. T
5252
| `balanced` | LSP symbols + docs/enrichment + module linking | Good agentic results without full cost |
5353
| `full` | All analyzers + LSP definitions + dataflow + architecture | Maximum accuracy/richness |
5454

55+
Tier behavior details:
56+
- `fast`: disables build context, LSP, enrichment, module linking, dataflow, docs/contracts, and architecture; filters out `Uses`/`References` edges.
57+
- `balanced`: enables build context, LSP symbols, enrichment, module linking, and docs/contracts; filters out `References` edges.
58+
- `full`: enables all analyzers and LSP definitions; no edge filtering.
59+
5560
Configure the tier:
5661
- CLI: `codegraph index --index-tier balanced`
5762
- Env: `CODEGRAPH_INDEX_TIER=balanced`

crates/codegraph-mcp-server/src/bin/codegraph.rs

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1131,9 +1131,25 @@ async fn handle_index(
11311131
))?;
11321132
}
11331133

1134+
let tier = index_tier.map(Into::into).unwrap_or(config.indexing.tier);
1135+
let tier_hint = match tier {
1136+
codegraph_core::config_manager::IndexingTier::Fast => {
1137+
"fast (speed-first: AST + core edges)"
1138+
}
1139+
codegraph_core::config_manager::IndexingTier::Balanced => {
1140+
"balanced (adds LSP symbols + enrichment)"
1141+
}
1142+
codegraph_core::config_manager::IndexingTier::Full => {
1143+
"full (max detail: LSP definitions + dataflow + architecture)"
1144+
}
1145+
};
1146+
multi_progress.println(format!(
1147+
"🧭 Indexing tier: {} — override with --index-tier or CODEGRAPH_INDEX_TIER",
1148+
tier_hint
1149+
))?;
1150+
11341151
// Configure indexer
11351152
let languages_list = languages.clone().unwrap_or_default();
1136-
let tier = index_tier.map(Into::into).unwrap_or(config.indexing.tier);
11371153
let indexer_config = IndexerConfig {
11381154
languages: languages_list.clone(),
11391155
exclude_patterns: exclude,

0 commit comments

Comments
 (0)