@apideck/docs-mcp/dist/src/audit.d.ts

MCP server that lets agents search and retrieve your documentation at query time instead of relying on stale training data.

/**
 * Docs audit: before exposing docs to agents, check they are complete,
 * current, and structured well enough to return useful results per query.
 */
import type { DocStore } from './store.js';
export type Severity = 'error' | 'warning' | 'info';
export interface AuditIssue {
    severity: Severity;
    rule: string;
    path: string;
    message: string;
}
export interface AuditOptions {
    /** Pages not touched for this many days are flagged stale. */
    staleDays?: number;
    /** Pages with fewer words are flagged thin. */
    minWords?: number;
    /** Sections with more words and no sub-headings are flagged as hard to retrieve. */
    maxSectionWords?: number;
    now?: Date;
}
export interface AuditReport {
    root: string;
    generatedAt: string;
    options: Required<Omit<AuditOptions, 'now'>>;
    summary: {
        pages: number;
        sections: number;
        words: number;
        errors: number;
        warnings: number;
        info: number;
        pagesWithIssues: number;
    };
    issues: AuditIssue[];
}
export declare const auditDocs: (store: DocStore, options?: AuditOptions) => AuditReport;
export declare const formatAuditReport: (report: AuditReport) => string;
//# sourceMappingURL=audit.d.ts.map