enquire-mcp API reference - v3.9.0-rc.4
    Preparing search index...

    Interface NoteReadMap

    Document-map projection returned by readNote(..., format: "map").

    Headings + frontmatter keys + counts only — no body. Lets the agent plan a surgical edit (target a specific heading, count outbound links) without paying token cost for the full content.

    interface NoteReadMap {
        byte_size: number;
        embeds_count: number;
        format: "map";
        frontmatter_keys: string[];
        headings: { level: number; line: number; text: string }[];
        mtime: string;
        path: string;
        tags: string[];
        title: string;
        wikilinks_count: number;
    }
    Index

    Properties

    byte_size embeds_count format frontmatter_keys headings mtime path tags title wikilinks_count

    Properties

    byte_size: number

    UTF-8 byte length of the full file (frontmatter + body).

    embeds_count: number

    Total ![[embeds]] in the body.

    format: "map"

    Discriminator — always "map" for this variant.

    frontmatter_keys: string[]

    Top-level keys present in frontmatter (no values — values may be PII).

    headings: { level: number; line: number; text: string }[]

    ATX headings (#, ##, ...). 1-based line numbers. Code-fence aware.

    mtime: string

    ISO-8601 modification timestamp.

    path: string

    Vault-relative path.

    tags: string[]

    Tags (frontmatter + inline), de-duplicated.

    title: string

    .md-stripped basename.

    wikilinks_count: number

    Total [[wikilinks]] in the body.

    Settings

    Member Visibility

    On This Page

    Properties