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

    Interface ReadPdfResult

    Envelope returned by readPdf.

    has_text is the OR across successfully extracted pages. When complete is true, false means an image-only/blank selection that agents can route through ocrPdf; when false, inspect page failures instead. metadata is present when args.include_metadata is not explicitly false AND the PDF carries any doc-level metadata.

    interface ReadPdfResult {
        complete: boolean;
        full_text: string;
        has_text: boolean;
        metadata?: {
            author?: string;
            creation_date?: string;
            creator?: string;
            keywords?: string;
            mod_date?: string;
            producer?: string;
            subject?: string;
            title?: string;
        };
        mtime: string;
        name: string;
        page_count: number;
        pages: ReadPdfPage[];
        path: string;
        size_bytes: number;
        total_page_count: number;
    }
    Index
    complete full_text has_text metadata? mtime name page_count pages path size_bytes total_page_count
    complete: boolean

    True only when every requested page was extracted or proven empty.

    full_text

    full_text: string

    has_text

    has_text: boolean
    metadata?: {
        author?: string;
        creation_date?: string;
        creator?: string;
        keywords?: string;
        mod_date?: string;
        producer?: string;
        subject?: string;
        title?: string;
    }
    mtime: string
    name: string

    page_count

    page_count: number
    pages: ReadPdfPage[]
    path: string
    size_bytes: number

    total_page_count

    total_page_count: number

    When pages slicing was applied, this carries the original page count for callers that need to know how much they didn't read.

    Settings
    Member Visibility

    On This Page
    Properties