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

    Interface FindPathResult

    Result of a findPath traversal.

    found: false + hops: -1 indicates no path within max_depth. alternatives is populated only when args.include_alternatives is true and at least one same-length alternative exists.

    interface FindPathResult {
        alternatives?: PathStep[][];
        found: boolean;
        from: string;
        hops: number;
        path: PathStep[];
        to: string;
    }
    Index
    alternatives? found from hops path to
    alternatives?: PathStep[][]

    Up to 10 same-length alternatives, only when include_alternatives=true. The chosen path is included as the first entry: tests/v16.test.ts pins that both same-length siblings are reported, which only holds while it is part of the returned set.

    found: boolean

    Whether a path was found within max_depth.

    from: string

    Source path (vault-relative, with .md).

    hops: number

    Number of hops in path. -1 when not found. 0 for from = to.

    path: PathStep[]

    Shortest path as a sequence of PathStep. Empty on miss.

    to: string

    Destination path.

    Settings
    Member Visibility

    On This Page
    Properties