enquire-mcp API reference - v3.11.6-rc.2
    Preparing search index...

    Interface ValidateProposalResult

    Structured validation report returned by validateNoteProposal.

    ok is true iff errors is empty — warnings don't block the agent. wikilinks[*].suggestions carry did-you-mean hints for broken links so the LLM can fix-and-retry without writing a broken note.

    interface ValidateProposalResult {
        collision: {
            existing_path?: string;
            kind: "none" | "path-exists" | "title-exists-elsewhere";
        };
        errors: { kind: string; message: string }[];
        mode: "overwrite" | "create" | "append";
        ok: boolean;
        proposed_path: string;
        tags: { name: string; status: "existing" | "new" }[];
        warnings: { kind: string; message: string; suggestion?: string }[];
        wikilinks: {
            raw: string;
            resolved_path: string | null;
            status: "resolved" | "broken" | "ambiguous";
            suggestions: string[];
            target: string;
        }[];
        yaml: {
            coerced: boolean;
            error: string
            | null;
            keys: string[];
            parsed: boolean;
        };
    }
    Index

    Properties

    collision errors mode ok proposed_path tags warnings wikilinks yaml

    Properties

    collision: {
        existing_path?: string;
        kind: "none" | "path-exists" | "title-exists-elsewhere";
    }
    errors: { kind: string; message: string }[]
    mode: "overwrite" | "create" | "append"
    ok: boolean
    proposed_path: string
    tags: { name: string; status: "existing" | "new" }[]
    warnings: { kind: string; message: string; suggestion?: string }[]
    wikilinks: {
        raw: string;
        resolved_path: string | null;
        status: "resolved" | "broken" | "ambiguous";
        suggestions: string[];
        target: string;
    }[]
    yaml: {
        coerced: boolean;
        error: string | null;
        keys: string[];
        parsed: boolean;
    }

    Type Declaration

    • coerced: boolean

      v3.11.0-rc.11 (rc.9-audit L4) — true if the frontmatter is valid YAML but NOT a mapping (a bare scalar / sequence), which frontmatter_set refuses (rc.64). Surfaced so an agent isn't surprised by a later refusal after a green validate.

    • error: string | null
    • keys: string[]
    • parsed: boolean

    Settings

    Member Visibility

    On This Page

    Properties