frappe-mcp-server
Version:
Enhanced Model Context Protocol server for Frappe Framework with comprehensive API instructions and helper tools
48 lines (47 loc) • 1.39 kB
TypeScript
/**
* Interface for a static hint
*/
export interface Hint {
type: "doctype" | "workflow";
target: string;
hint?: string;
id?: string;
description?: string;
steps?: string[];
related_doctypes?: string[];
}
/**
* Indexed structure for static hints
*/
export interface StaticHints {
doctype: Map<string, Hint[]>;
workflow: Map<string, Hint[]>;
}
/**
* Load all hint files from the static_hints directory
* @returns The loaded and indexed hints
*/
export declare function loadStaticHints(): Promise<StaticHints>;
/**
* Get hints for a specific DocType
* @param doctype The DocType name
* @returns Array of hints for the DocType, or empty array if none found
*/
export declare function getDocTypeHints(doctype: string): Hint[];
/**
* Get hints for a specific workflow
* @param workflow The workflow name
* @returns Array of hints for the workflow, or empty array if none found
*/
export declare function getWorkflowHints(workflow: string): Hint[];
/**
* Find workflow hints that involve a specific DocType
* @param doctype The DocType name
* @returns Array of workflow hints that involve the DocType
*/
export declare function findWorkflowsForDocType(doctype: string): Hint[];
/**
* Initialize the static hints system
* This should be called during server startup
*/
export declare function initializeStaticHints(): Promise<void>;