Function getVaultStats

getVaultStats(vault: Vault, args: { top_tags?: number }): Promise<VaultStats>
One-shot vault dashboard the LLM can call at the start of a session to orient itself.

Cheap structural signals only — no full-text scan, no embedding. Useful as a "first call" for an agent to understand the corpus shape (size, recency, link-graph health) before issuing specific reads.
Parameters
- vault: Vault
  The vault.
- args: { top_tags?: number }
  top_tags controls how many top tags are returned (default 10).
Returns Promise<VaultStats>
A VaultStats snapshot.
Example
```
const stats = await getVaultStats(vault, { top_tags: 20 });
console.log(`${stats.total_notes} notes, ${stats.orphans} orphans`);
console.log("Top tags:", stats.top_tags.slice(0, 5));
```
- Defined in src/tools/read.ts:1875