enquire-mcp API reference - v4.0.0-rc.7
    Preparing search index...

    Function syncFtsIndex

    • Incrementally synchronize Markdown notes into an opened FTS5 index.

      Product startup uses the default fail-soft mode so one unreadable note does not take down the server. Evidence-producing benchmarks pass strict, which aborts on the first read/index failure or zero-chunk note and verifies the final source_state/physical-row equations before returning.

      Parameters

      • vault: Vault

        Vault whose visible Markdown notes form the live source set.

      • idx: FtsIndex

        Open FTS index to update and, in strict mode, physically audit.

      • opts: { mode?: FtsSyncMode } = {}
        • Optionalmode?: FtsSyncMode

          Error policy; defaults to "fail-soft".

      Returns Promise<FtsSyncReport>

      Raw counters. Strict mode also returns the full physical audit and manifest; fail-soft mode marks audited:false, leaves audit counters at zero, and returns a null manifest to avoid an O(all rows) startup scan.

      In strict mode when a file cannot be indexed or the final audit is incomplete.

      const report = await syncFtsIndex(vault, index, { mode: "strict" });
      if (!report.complete) throw new Error("incomplete FTS index");