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

    Function readLiveFtsChunk

    • Read one stored FTS chunk only while its current source is still a public regular file. Every refusal uses the resource's non-oracular not-found form.

      Parameters

      • vault: Vault

        Vault whose live lexical and physical policy is authoritative.

      • idx: FtsIndex

        Open persistent FTS index containing the chunk.

      • relPath: string

        Decoded vault-relative source path.

      • chunkIndex: number

        Zero-based chunk position within the source.

      Returns Promise<
          {
              chunk_index: number;
              content: string;
              line_end: number;
              line_start: number;
              rel_path: string;
          },
      >

      The stored chunk payload with source path and line receipt.

      If the path is invalid, excluded, stale, non-regular or absent from the index.

      const chunk = await readLiveFtsChunk(vault, ftsIndex, "Notes/Retrieval.md", 0);