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

    Interface VaultOptions

    Options accepted by the Vault constructor. Every field is optional; omit to accept the documented default.

    interface VaultOptions {
        cacheFile?: string;
        enableWrite?: boolean;
        excludeGlobs?: string[];
        maxCacheEntries?: number;
        maxDiskCacheBytes?: number;
        maxFileBytes?: number;
        persistentCache?: boolean;
        readPaths?: string[];
    }
    Index
    cacheFile? enableWrite? excludeGlobs? maxCacheEntries? maxDiskCacheBytes? maxFileBytes? persistentCache? readPaths?
    cacheFile?: string

    Override with an exact .json cache-file path outside the reserved .feedback.json / .hnsw.meta.json subclasses. Default: ~/.cache/enquire/.json.

    enableWrite?: boolean

    Allow writeNote / appendNote / renameFile. Default false (read-only).

    excludeGlobs?: string[]

    Glob patterns matched against vault-relative paths. Excluded paths never appear in listMarkdown(), and reads/writes against them throw. Privacy filter for users who point an LLM at a vault but want 02_Personal/** invisible.

    maxCacheEntries?: number

    In-memory parsed-note cache size cap. Default DEFAULT_MAX_CACHE_ENTRIES.

    maxDiskCacheBytes?: number

    Refuse to read/write a cache file larger than this (default 50 MB).

    maxFileBytes?: number

    Per-file size cap. Default DEFAULT_MAX_FILE_BYTES.

    persistentCache?: boolean

    Persist the parse cache across server restarts. Default false.

    readPaths?: string[]

    Glob patterns matched against vault-relative paths. When set, ONLY paths matching one of these patterns are visible — strict allowlist mode. Complement to excludeGlobs (cyanheads OBSIDIAN_READ_PATHS pattern). If both are set, a path must match an allow-glob AND not match any exclude-glob.

    Settings
    Member Visibility

    On This Page
    Properties