get_index_stats
Retrieve read-only knowledge base index statistics and health metrics to inspect document/chunk counts, embedding status, BM25 state, cache hit rate, and HNSW recall.
Instructions
Get statistics and health metrics for the knowledge base index.
Read-only. No side effects.
Returns: JSON string with system metrics: total documents, total chunks, embedding model name, BM25 status, query cache hit rate, file watcher status, a self_recall probe (fraction of sampled chunks returned as top-1 by their own stored vector; a value below 1.0 means the HNSW index misses some chunks — see search.ef_search in config.example.yaml), and hnsw_ef_search (the value ChromaDB actually applies to the live collection; it can lag behind search.ef_search until a full rebuild).
Usage: Use for system health checks — inspecting embedding runtime status, checking index population, or monitoring cache efficiency. This does not load the embedding model or initialize BM25. Use list_categories() for per-category document counts instead. Use evaluate_retrieval() to measure actual search quality with test queries.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_index_stats"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |