build-search-index
Skill1 starsChanged 7 months agoApache-2.0View on GitHub
Build (or refresh) a vault's LOCAL BM25 search index — a deterministic, plugin-free search tier that works on every vault, including those without Smart Connections. Writes wiki-meta/search-index.json. Idempotent: an unchanged vault is detected by content fingerprint and the write is skipped.
In this repository49 other files it gives its agents.
- AGENTS.mdAGENTS.md
- auto-modeSkill
- autoresearchSkill
- bind-workspaceSkill
- canvasSkill
- conventionsSkill
- decision-consolidateSkill
- defuddleSkill
- discover-list-filesSkill
- discover-list-vaultsSkill
- force-new-port-startSkill
- hot-compactSkill
- lockSkill
- manage-deleteSkill
- manage-moveSkill
- meta-attach-vaultSkill
- meta-audit-bridge-readinessSkill
- meta-setupSkill
- meta-statusSkill
- meta-sync-templateSkill
- obsidian-basesSkill
- obsidian-markdownSkill
- read-frontmatterSkill
- read-getSkill
- read-searchSkill
- read-search-smartSkill
- saveSkill
- sync-from-githubSkill
- template-executeSkill
- unlockSkill
- who-is-speakingSkill
- wiki-boundarySkill
- wiki-exportSkill
- wiki-foldSkill
- wiki-graphSkill
- wiki-ingestSkill
- wiki-lintSkill
- wiki-neighborsSkill
- wiki-pathSkill
- wiki-querySkill
- wiki-refresh-digestsSkill
- wikiSkill
- wiki-tourSkill
- write-appendSkill
- write-bundleSkill
- write-create-or-replaceSkill
- write-frontmatter-mergeSkill
- write-frontmatter-setSkill
- write-patchSkill
The file
We split this skill into the rules it gives an agent
3 rules. About 0 are common, 1 is distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 16
Call the obsidian-router build_search_index MCP tool with arguments parsed from $ARGUMENTS.
- Distinctive: line 49
After a large ingestion or import, to pick up the new pages.
- Very specific: line 58
Never write wiki-meta/search-index.json by hand or with filesystem tools — it is a derived artefact with a content fingerprint.
≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
build-search-index
Call the obsidian-router build_search_index MCP tool with arguments parsed from $ARGUMENTS.
Arguments
Optional:
vault— vault name. Omit for the default vault.check—trueto report whether the stored index is absent / stale / current without writing.
Argument parsing from $ARGUMENTS
- bare vault name →
vault --check/ "juste vérifier" / "dry run" →check: true- empty → default vault, real build
What it does
Walks wiki/ (user content only — wiki-meta/ scaffolds and the generated OKF projections are excluded), splits every page into chunks, and prefixes each chunk with its context header: page title · frontmatter description · heading path. That header is indexed with the body, so a query matching a page's title or description still finds its chunks, and every hit can say where it came from.
Deterministic — no LLM, no network, no plugin. The same vault always produces the same index and the same ranking.
Reporting the result
Relay these fields plainly:
indexState—absent(first build) ·stale(vault changed) ·current(nothing to do) ·foreign-versionwritten— whether a file was actually written.upToDate: true+written: falseis a success, not a no-op failure: the fingerprint matched, so nothing needed rewriting. Say "already up to date".stats—{ pages, chunks, tokens }.warnings— always surface these verbatim. In particular:- an EMPTY index (0 chunks) means nothing indexable was found — a layout problem (no
wiki/directory, or content lives elsewhere), NOT a successful build. Don't gloss it as "done". truncatedmeans the corpus hit the chunk cap and the index does not cover the whole vault.
- an EMPTY index (0 chunks) means nothing indexable was found — a layout problem (no
When to run it
- Once per vault to enable
search_smart'stier: "local"and its automatic fallback. - After a large ingestion or import, to pick up the new pages.
- Whenever
search_smartrefuses with "No local search index" or "index is EMPTY".
Re-running costs nothing on an unchanged vault (fingerprint check → no write).
On failure — remediate, NEVER hand-write the index
skipped: 'page-reads-failed'/'enumeration-truncated'→ the build refused on purpose: an index built from a partially-readable tree would silently miss pages, and a search that quietly misses content is worse than one that says it cannot run. Fix the vault access (is Obsidian open? is the REST API up?) and re-run. Never build a partial index.- Connection error → vault closed;
list_vaults, then ask the user to open it via theopenUrilink. - Never write
wiki-meta/search-index.jsonby hand or with filesystem tools — it is a derived artefact with a content fingerprint; a hand-edit desynchronises it from the vault and the tool will refuse or rebuild it anyway.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

