import type { ToolResult } from "./tool-specs.js"; export interface DocsPage { /** URL-ish key, e.g. "architecture". Also the argument an agent passes as `page`. */ slug: string; title: string; /** The page's classification line, e.g. "Concept (informative)" or "Reference"; "" if none. */ kind: string; /** One-line summary for the index. */ summary: string; /** Full Markdown. */ body: string; } export interface DocsBundle { /** The installed Cotal version these docs are exact for, e.g. "0.10.1". */ version: string; generatedFrom: string; pages: DocsPage[]; /** The normative wire contract (SPEC.md). Reachable as page "spec". */ spec: { title: string; body: string; }; /** The normative workflow-language reference (spec/cotal-lang.md). Reachable as page "lang". */ lang: { title: string; body: string; }; /** The machine-readable message schema (JSON). Reachable as page "schema". */ schema: { title: string; body: string; }; } /** The installed Cotal version, for stamping the orientation card and other surfaces. */ export declare const DOCS_VERSION: string; /** The index: version banner + every page (slug · kind · summary) + spec/schema + how to * go deeper. Cheap orientation an agent reads before answering anything about Cotal. */ export declare function renderDocsIndex(): string; export interface DocHit { /** Page slug to fetch in full via cotal_docs(page: slug). */ slug: string; pageTitle: string; heading: string; /** The matching section's Markdown. */ text: string; score: number; } /** BM25 search over heading-aware sections. Returns the best-matching sections (at most two per * page, for diversity), each with a pointer to read the full page. Offline; no embeddings. */ export declare function searchDocs(query: string, limit?: number): DocHit[]; export interface DocsArgs { page?: string; query?: string; refresh?: boolean; } /** The `cotal_docs` tool body. Pure over the bundle except for the opt-in remote refresh. */ export declare function runDocs(args: DocsArgs): Promise; //# sourceMappingURL=docs.d.ts.map