/** * XanoScript Documentation Tool * * Retrieves XanoScript programming language documentation. * Can be used standalone or within the MCP server. */ import { z } from "zod"; import { type XanoscriptDocsArgs, type TopicDoc } from "../xanoscript.js"; import type { ToolResult } from "./types.js"; export type { XanoscriptDocsArgs }; export type { TopicDoc }; export interface XanoscriptDocsResult { documentation: string; topics?: TopicDoc[]; } /** * Get the path to XanoScript documentation files. * Searches common locations for production and development. */ export declare function getXanoscriptDocsPath(): string; /** * Set a custom docs path (useful for testing or custom installations) */ export declare function setXanoscriptDocsPath(path: string): void; /** * Get XanoScript documentation. * * @param args - Optional documentation arguments * @returns Documentation content * * @example * ```ts * import { xanoscriptDocs } from '@xano/developer-mcp'; * * // Get compact topic index (use topic: 'readme' for the full prose overview) * const index = xanoscriptDocs(); * * // Get specific topic * const syntaxDocs = xanoscriptDocs({ topic: 'syntax' }); * * // Get context-aware docs for a file * const fileDocs = xanoscriptDocs({ file_path: 'api/users/create.xs' }); * * // Get quick reference only * const quickRef = xanoscriptDocs({ topic: 'syntax', mode: 'quick_reference' }); * ``` */ export declare function xanoscriptDocs(args?: XanoscriptDocsArgs): XanoscriptDocsResult; /** * Get XanoScript documentation and return a ToolResult. * For file_path mode, returns each topic as a separate content block. */ export declare function xanoscriptDocsTool(args?: XanoscriptDocsArgs): ToolResult; export declare const xanoscriptDocsToolSpec: import("./define_tool.js").BuiltTool<{ topic: z.ZodOptional; file_path: z.ZodOptional; mode: z.ZodOptional>; tier: z.ZodOptional>; max_tokens: z.ZodOptional; exclude_topics: z.ZodOptional>; }, { documentation: z.ZodOptional; file_path: z.ZodOptional; mode: z.ZodOptional; tier: z.ZodOptional; version: z.ZodOptional; topics: z.ZodOptional>; }>;