@flink-app/flink 0.14.3 → 2.0.0-alpha.100

package/dist/src/ai/ToolExecutor.js

@@ -0,0 +1,497 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToolExecutor = void 0;
+var ajv_1 = __importDefault(require("ajv"));
+var ajv_formats_1 = __importDefault(require("ajv-formats"));
+var FlinkErrors_1 = require("../FlinkErrors");
+var FlinkLogFactory_1 = require("../FlinkLogFactory");
+var FlinkRequestContext_1 = require("../FlinkRequestContext");
+var toolLog = FlinkLogFactory_1.FlinkLogFactory.createLogger("flink.ai.tool");
+var ToolExecutor = /** @class */ (function () {
+    function ToolExecutor(toolProps, toolFn, ctx, autoSchemas, allSchemas) {
+        this.toolProps = toolProps;
+        this.toolFn = toolFn;
+        this.ctx = ctx;
+        this.autoSchemas = autoSchemas;
+        this.allSchemas = allSchemas;
+        this.ajv = new ajv_1.default({ allErrors: true });
+        (0, ajv_formats_1.default)(this.ajv);
+        // Pre-populate AJV with all schemas so $ref references resolve across schema boundaries
+        if (allSchemas) {
+            for (var _i = 0, _a = Object.values(allSchemas); _i < _a.length; _i++) {
+                var schema = _a[_i];
+                if (schema && schema.$id) {
+                    try {
+                        this.ajv.addSchema(schema);
+                    }
+                    catch (_b) {
+                        // Ignore duplicate schema errors (schema may already be added)
+                    }
+                }
+            }
+        }
+        // Pre-compile validators once at construction time (not per invocation)
+        if (toolProps.inputJsonSchema) {
+            this.compiledInputValidator = this.ajv.compile(toolProps.inputJsonSchema);
+        }
+        else if (autoSchemas === null || autoSchemas === void 0 ? void 0 : autoSchemas.inputSchema) {
+            this.compiledInputValidator = this.ajv.compile(autoSchemas.inputSchema);
+        }
+        if (toolProps.outputJsonSchema) {
+            this.compiledOutputValidator = this.ajv.compile(toolProps.outputJsonSchema);
+        }
+        else if (autoSchemas === null || autoSchemas === void 0 ? void 0 : autoSchemas.outputSchema) {
+            this.compiledOutputValidator = this.ajv.compile(autoSchemas.outputSchema);
+        }
+        // Log when using auto-schemas
+        if ((autoSchemas === null || autoSchemas === void 0 ? void 0 : autoSchemas.inputSchema) && !toolProps.inputSchema && !toolProps.inputJsonSchema) {
+            toolLog.debug("Tool ".concat(toolProps.id, ": Using auto-generated schemas from type parameters"));
+        }
+        // Log when no schema is provided (valid for void/any input types)
+        var hasInputSchema = toolProps.inputSchema || toolProps.inputJsonSchema || (autoSchemas === null || autoSchemas === void 0 ? void 0 : autoSchemas.inputSchema);
+        if (!hasInputSchema) {
+            toolLog.debug("Tool ".concat(toolProps.id, ": No input schema provided (input type is void or any)"));
+        }
+        // Warn if both manual and auto provided (manual takes precedence)
+        if ((toolProps.inputSchema || toolProps.inputJsonSchema) && (autoSchemas === null || autoSchemas === void 0 ? void 0 : autoSchemas.inputSchema)) {
+            toolLog.debug("Tool ".concat(toolProps.id, ": Manual schemas take precedence over auto-generated schemas"));
+        }
+        // Log warning if both manual Zod and JSON schemas are provided
+        if (toolProps.inputSchema && toolProps.inputJsonSchema) {
+            toolLog.warn("Tool ".concat(toolProps.id, ": Both 'inputSchema' (Zod) and 'inputJsonSchema' are provided. ") + "Using 'inputSchema' for validation.");
+        }
+        if (toolProps.outputSchema && toolProps.outputJsonSchema) {
+            toolLog.warn("Tool ".concat(toolProps.id, ": Both 'outputSchema' (Zod) and 'outputJsonSchema' are provided. ") + "Using 'outputSchema' for validation.");
+        }
+    }
+    /**
+     * Execute the tool with input
+     * @param input - Tool input data
+     * @param overrides - Optional overrides for user/permissions/conversationContext (for testing)
+     */
+    ToolExecutor.prototype.execute = function (input, overrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var user, userPermissions, conversationContext, hasPermission, validatedInput, valid, errorDetails, errorDetails, result, err_1, validatedData, valid, errorDetails;
+            var _a, _b, _c;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        user = (_a = overrides === null || overrides === void 0 ? void 0 : overrides.user) !== null && _a !== void 0 ? _a : (0, FlinkRequestContext_1.getRequestUser)();
+                        userPermissions = (_b = overrides === null || overrides === void 0 ? void 0 : overrides.permissions) !== null && _b !== void 0 ? _b : (_c = (0, FlinkRequestContext_1.getRequestContext)()) === null || _c === void 0 ? void 0 : _c.userPermissions;
+                        conversationContext = overrides === null || overrides === void 0 ? void 0 : overrides.conversationContext;
+                        if (!this.toolProps.permissions) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.checkPermissionsInternal(input, user, userPermissions)];
+                    case 1:
+                        hasPermission = _d.sent();
+                        if (!hasPermission) {
+                            toolLog.debug("Tool invocator is missing required permission(s)", this.toolProps.permissions, "user has", userPermissions);
+                            throw (0, FlinkErrors_1.forbidden)("Permission denied for tool ".concat(this.toolProps.id), "PERMISSION_DENIED");
+                        }
+                        _d.label = 2;
+                    case 2:
+                        try {
+                            if (this.toolProps.inputSchema) {
+                                // Priority 1: Use Zod validation
+                                validatedInput = this.toolProps.inputSchema.parse(input);
+                            }
+                            else if (this.compiledInputValidator) {
+                                valid = this.compiledInputValidator(input);
+                                if (!valid) {
+                                    errorDetails = this.formatAjvErrors(this.compiledInputValidator.errors || [], input);
+                                    toolLog.warn("Tool ".concat(this.toolProps.id, " input validation failed:"), errorDetails);
+                                    return [2 /*return*/, {
+                                            success: false,
+                                            error: "Invalid input for tool '".concat(this.toolProps.id, "': ").concat(errorDetails),
+                                            code: "VALIDATION_ERROR",
+                                        }];
+                                }
+                                validatedInput = input;
+                            }
+                            else {
+                                // No schema available - skip validation
+                                validatedInput = input;
+                            }
+                        }
+                        catch (err) {
+                            toolLog.warn("Tool ".concat(this.toolProps.id, " input validation failed:"), err.message);
+                            errorDetails = this.formatZodError(err, input);
+                            return [2 /*return*/, {
+                                    success: false,
+                                    error: "Invalid input for tool '".concat(this.toolProps.id, "': ").concat(errorDetails),
+                                    code: "VALIDATION_ERROR",
+                                }];
+                        }
+                        // 3. Execute tool
+                        toolLog.debug("Executing tool ".concat(this.toolProps.id));
+                        _d.label = 3;
+                    case 3:
+                        _d.trys.push([3, 5, , 6]);
+                        toolLog.trace(this.toolFn.name + " input:", validatedInput);
+                        return [4 /*yield*/, this.toolFn({
+                                input: validatedInput,
+                                ctx: this.ctx,
+                                user: user,
+                                permissions: userPermissions,
+                                conversationCtx: conversationContext,
+                            })];
+                    case 4:
+                        result = _d.sent();
+                        return [3 /*break*/, 6];
+                    case 5:
+                        err_1 = _d.sent();
+                        toolLog.error("Tool ".concat(this.toolProps.id, " threw error:"), err_1.message);
+                        return [2 /*return*/, {
+                                success: false,
+                                error: "Tool execution failed: ".concat(err_1.message),
+                                code: "EXECUTION_ERROR",
+                            }];
+                    case 6:
+                        // 4. Handle error results
+                        if (!result.success) {
+                            toolLog.warn("Tool ".concat(this.toolProps.id, " returned error:"), result.error);
+                            return [2 /*return*/, result]; // Return error result as-is
+                        }
+                        // 5. Output validation (priority: Zod > JSON Schema > Auto-generated)
+                        if (this.toolProps.outputSchema) {
+                            // Priority 1: Use Zod validation
+                            try {
+                                validatedData = this.toolProps.outputSchema.parse(result.data);
+                                return [2 /*return*/, { success: true, data: validatedData }];
+                            }
+                            catch (err) {
+                                toolLog.error("Tool ".concat(this.toolProps.id, " output validation failed:"), err.message);
+                                return [2 /*return*/, {
+                                        success: false,
+                                        error: "Invalid output from tool ".concat(this.toolProps.id, ": ").concat(err.message),
+                                        code: "OUTPUT_VALIDATION_ERROR",
+                                    }];
+                            }
+                        }
+                        else if (this.compiledOutputValidator) {
+                            // Priority 2 & 3: Use pre-compiled JSON Schema validator (manual or auto-generated)
+                            try {
+                                valid = this.compiledOutputValidator(result.data);
+                                if (!valid) {
+                                    errorDetails = this.formatAjvErrors(this.compiledOutputValidator.errors || []);
+                                    toolLog.error("Tool ".concat(this.toolProps.id, " output validation failed:"), errorDetails);
+                                    return [2 /*return*/, {
+                                            success: false,
+                                            error: "Invalid output from tool ".concat(this.toolProps.id, ": ").concat(errorDetails),
+                                            code: "OUTPUT_VALIDATION_ERROR",
+                                        }];
+                                }
+                                return [2 /*return*/, { success: true, data: result.data }];
+                            }
+                            catch (err) {
+                                toolLog.error("Tool ".concat(this.toolProps.id, " output validation failed:"), err.message);
+                                return [2 /*return*/, {
+                                        success: false,
+                                        error: "Invalid output from tool ".concat(this.toolProps.id, ": ").concat(err.message),
+                                        code: "OUTPUT_VALIDATION_ERROR",
+                                    }];
+                            }
+                        }
+                        // No output validation - return result as-is
+                        return [2 /*return*/, result];
+                }
+            });
+        });
+    };
+    ToolExecutor.prototype.getToolSchema = function () {
+        // Priority order: inputJsonSchema > inputSchema (Zod 4.x) > autoSchemas
+        var _a, _b;
+        // Priority 1: Manual JSON schema
+        if (this.toolProps.inputJsonSchema) {
+            return {
+                name: this.toolProps.id,
+                description: this.toolProps.description,
+                inputSchema: this.toolProps.inputJsonSchema,
+            };
+        }
+        // Priority 2: Zod schema (convert to JSON Schema using Zod 4.x)
+        if (this.toolProps.inputSchema) {
+            var z = require("zod");
+            if (!z.toJSONSchema) {
+                throw new Error("Tool ".concat(this.toolProps.id, ": Zod 4.x is required for automatic schema generation. ") +
+                    "Either upgrade to Zod 4.x or provide 'inputJsonSchema' in your tool definition, " +
+                    "or use TypeScript type parameters for auto-generation.");
+            }
+            return {
+                name: this.toolProps.id,
+                description: this.toolProps.description,
+                inputSchema: z.toJSONSchema(this.toolProps.inputSchema),
+            };
+        }
+        // Priority 3: Auto-generated schema from type parameters
+        if ((_a = this.autoSchemas) === null || _a === void 0 ? void 0 : _a.inputSchema) {
+            return {
+                name: this.toolProps.id,
+                description: this.toolProps.description,
+                inputSchema: this.resolveSchemaRefs(this.autoSchemas.inputSchema),
+            };
+        }
+        // No schema provided - return schema based on type hint
+        var typeHint = (_b = this.autoSchemas) === null || _b === void 0 ? void 0 : _b.inputTypeHint;
+        if (typeHint === 'void') {
+            // void: Tool takes no input - reject any properties
+            return {
+                name: this.toolProps.id,
+                description: this.toolProps.description,
+                inputSchema: {
+                    type: "object",
+                    properties: {},
+                    additionalProperties: false,
+                },
+            };
+        }
+        else if (typeHint === 'any') {
+            // any: Tool accepts any input - allow any properties
+            return {
+                name: this.toolProps.id,
+                description: this.toolProps.description,
+                inputSchema: {
+                    type: "object",
+                    additionalProperties: true,
+                },
+            };
+        }
+        else {
+            // No type hint - default to void behavior (no input expected)
+            return {
+                name: this.toolProps.id,
+                description: this.toolProps.description,
+                inputSchema: {
+                    type: "object",
+                    properties: {},
+                    additionalProperties: false,
+                },
+            };
+        }
+    };
+    /**
+     * Resolve cross-schema $ref values into $defs so the schema is self-contained.
+     *
+     * Flink's schema manifest stores schemas as separate documents with IDs like
+     * "Canvas.ElementInput". These are valid for AJV (which uses a schema registry),
+     * but LLM providers like OpenAI require a single self-contained schema where all
+     * $ref values point to #/$defs/... entries at the top level.
+     */
+    ToolExecutor.prototype.resolveSchemaRefs = function (schema) {
+        var _this = this;
+        if (!this.allSchemas)
+            return schema;
+        var defs = {};
+        var collectRefs = function (node, visited) {
+            if (!node || typeof node !== "object")
+                return;
+            if (node.$ref && typeof node.$ref === "string" && !node.$ref.startsWith("#")) {
+                var refId = node.$ref;
+                if (!visited.has(refId) && _this.allSchemas[refId]) {
+                    visited.add(refId);
+                    // Clone and strip top-level JSON Schema meta fields not valid inside $defs
+                    var def = JSON.parse(JSON.stringify(_this.allSchemas[refId]));
+                    delete def.$id;
+                    delete def.$schema;
+                    defs[refId] = def;
+                    // Recurse into the referenced schema to collect its deps
+                    collectRefs(def, visited);
+                }
+            }
+            for (var _i = 0, _a = Object.values(node); _i < _a.length; _i++) {
+                var value = _a[_i];
+                collectRefs(value, visited);
+            }
+        };
+        var visited = new Set();
+        collectRefs(schema, visited);
+        if (Object.keys(defs).length === 0)
+            return schema;
+        // Deep clone and rewrite all non-standard $ref values to #/$defs/<id>
+        var resolved = JSON.parse(JSON.stringify(schema));
+        delete resolved.$id;
+        delete resolved.$schema;
+        var rewriteRefs = function (node) {
+            if (!node || typeof node !== "object")
+                return;
+            if (node.$ref && typeof node.$ref === "string" && !node.$ref.startsWith("#")) {
+                node.$ref = "#/$defs/".concat(node.$ref);
+            }
+            for (var _i = 0, _a = Object.values(node); _i < _a.length; _i++) {
+                var value = _a[_i];
+                rewriteRefs(value);
+            }
+        };
+        rewriteRefs(resolved);
+        // Also rewrite refs inside the collected defs
+        for (var _i = 0, _a = Object.values(defs); _i < _a.length; _i++) {
+            var def = _a[_i];
+            rewriteRefs(def);
+        }
+        resolved.$defs = defs;
+        return resolved;
+    };
+    /**
+     * Get tool result for AI consumption
+     * Formats ToolResult into string for AI context
+     */
+    ToolExecutor.prototype.formatResultForAI = function (result) {
+        if (result.success) {
+            return JSON.stringify(result.data);
+        }
+        else {
+            return "Error: ".concat(result.error).concat(result.code ? " (".concat(result.code, ")") : "");
+        }
+    };
+    /**
+     * Check if user has permission to use this tool
+     * Used by AgentRunner to filter tools before showing to LLM
+     *
+     * @param user - User object
+     * @param input - Tool input (for function-based permissions)
+     * @param userPermissions - Optional resolved permissions from auth plugin (preferred)
+     * @param conversationContext - Optional conversation context
+     */
+    ToolExecutor.prototype.checkPermissions = function (user, input, userPermissions, conversationContext) {
+        return __awaiter(this, void 0, void 0, function () {
+            var perms, effectivePerms, requiredPerms;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        perms = this.toolProps.permissions;
+                        if (!perms)
+                            return [2 /*return*/, true];
+                        if (!(typeof perms === "function")) return [3 /*break*/, 2];
+                        return [4 /*yield*/, perms(input !== null && input !== void 0 ? input : {}, user)];
+                    case 1: return [2 /*return*/, _a.sent()];
+                    case 2:
+                        effectivePerms = userPermissions || (user === null || user === void 0 ? void 0 : user.permissions) || [];
+                        // If no user and no explicit permissions, deny access
+                        if (!user && !userPermissions)
+                            return [2 /*return*/, false];
+                        requiredPerms = Array.isArray(perms) ? perms : [perms];
+                        return [2 /*return*/, requiredPerms.every(function (p) { return effectivePerms.includes(p); })];
+                }
+            });
+        });
+    };
+    ToolExecutor.prototype.checkPermissionsInternal = function (input, user, userPermissions, conversationContext) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.checkPermissions(user, input, userPermissions, conversationContext)];
+            });
+        });
+    };
+    /**
+     * Format Zod validation errors into LLM-friendly error messages
+     * Provides specific guidance on what's missing or incorrect
+     */
+    ToolExecutor.prototype.formatZodError = function (err, receivedInput) {
+        // Check if it's a Zod error with issues array
+        if (err.issues && Array.isArray(err.issues)) {
+            var issues = err.issues.map(function (issue) {
+                var path = issue.path.join(".");
+                var field = path || "input";
+                if (issue.code === "invalid_type") {
+                    if (issue.received === "undefined") {
+                        return "Missing required field '".concat(field, "' (expected ").concat(issue.expected, ")");
+                    }
+                    return "Field '".concat(field, "' has wrong type: expected ").concat(issue.expected, ", got ").concat(issue.received);
+                }
+                if (issue.code === "too_small") {
+                    if (issue.type === "string") {
+                        return "Field '".concat(field, "' is too short (minimum ").concat(issue.minimum, " characters)");
+                    }
+                    return "Field '".concat(field, "' is too small (minimum ").concat(issue.minimum, ")");
+                }
+                if (issue.code === "too_big") {
+                    if (issue.type === "string") {
+                        return "Field '".concat(field, "' is too long (maximum ").concat(issue.maximum, " characters)");
+                    }
+                    return "Field '".concat(field, "' is too large (maximum ").concat(issue.maximum, ")");
+                }
+                // Generic fallback
+                return "".concat(field, ": ").concat(issue.message);
+            });
+            if (receivedInput) {
+                var inputInfo = Object.keys(receivedInput || {}).length === 0 ? "You provided an empty object {}." : "You provided: ".concat(JSON.stringify(receivedInput));
+                return "".concat(issues.join("; "), ". ").concat(inputInfo);
+            }
+            return issues.join("; ");
+        }
+        // Fallback for non-Zod errors
+        return err.message || "Unknown validation error";
+    };
+    /**
+     * Format AJV validation errors into LLM-friendly error messages
+     */
+    ToolExecutor.prototype.formatAjvErrors = function (errors, receivedInput) {
+        var issues = errors.map(function (error) {
+            var field = error.instancePath ? error.instancePath.substring(1).replace(/\//g, ".") : "input";
+            if (error.keyword === "required") {
+                return "Missing required field '".concat(error.params.missingProperty, "'");
+            }
+            if (error.keyword === "type") {
+                return "Field '".concat(field, "' has wrong type: expected ").concat(error.params.type);
+            }
+            if (error.keyword === "minLength") {
+                return "Field '".concat(field, "' is too short (minimum ").concat(error.params.limit, " characters)");
+            }
+            if (error.keyword === "maxLength") {
+                return "Field '".concat(field, "' is too long (maximum ").concat(error.params.limit, " characters)");
+            }
+            if (error.keyword === "minimum") {
+                return "Field '".concat(field, "' is too small (minimum ").concat(error.params.limit, ")");
+            }
+            if (error.keyword === "maximum") {
+                return "Field '".concat(field, "' is too large (maximum ").concat(error.params.limit, ")");
+            }
+            return "".concat(field, ": ").concat(error.message);
+        });
+        if (receivedInput) {
+            var inputInfo = Object.keys(receivedInput || {}).length === 0 ? "You provided an empty object {}." : "You provided: ".concat(JSON.stringify(receivedInput));
+            return "".concat(issues.join("; "), ". ").concat(inputInfo);
+        }
+        return issues.join("; ");
+    };
+    return ToolExecutor;
+}());
+exports.ToolExecutor = ToolExecutor;

package/dist/src/ai/agentInstructions.d.ts

@@ -0,0 +1,68 @@
+import { FlinkContext } from "../FlinkContext";
+import { InstructionsCallback, AgentExecuteContext } from "./FlinkAgent";
+/**
+ * Load agent instructions from external files with template variable support
+ *
+ * Supports multiple file types: .md, .yaml, .txt, etc. (loaded as plain text)
+ *
+ * ## Path Resolution
+ *
+ * - `./` or `../` prefix: Agent-relative path (based on caller's file location)
+ * - Otherwise: Project root-relative path
+ *
+ * ## Template Variables
+ *
+ * Uses Handlebars templating with automatic context helpers:
+ * - `ctx`: Full FlinkContext
+ * - `agentContext`: AgentExecuteContext
+ * - `user`: Shortcut to agentContext.user
+ * - Custom variables from static object or callback
+ *
+ * ## Caching
+ *
+ * Files are cached in-memory and reloaded only when modification time changes
+ *
+ * @example Agent-relative path with static variables
+ * ```typescript
+ * export default class CarAgent extends FlinkAgent<AppCtx> {
+ *   id = "car-agent";
+ *   instructions = agentInstructions("./instructions/car-agent.md");
+ *   tools = [SearchCarsTool];
+ * }
+ * ```
+ *
+ * @example Dynamic variables with callback
+ * ```typescript
+ * export default class SupportAgent extends FlinkAgent<AppCtx> {
+ *   id = "support-agent";
+ *   instructions = agentInstructions(
+ *     "./instructions/support-agent.md",
+ *     (ctx, agentContext) => ({
+ *       isBusinessHours: new Date().getHours() >= 9 && new Date().getHours() < 17,
+ *       customerTier: agentContext.user?.tier || "standard",
+ *     })
+ *   );
+ *   tools = [CreateTicketTool];
+ * }
+ * ```
+ *
+ * @example Template file (instructions/support-agent.md)
+ * ```markdown
+ * You are a customer support agent.
+ *
+ * Customer: {{user.name}} ({{customerTier}})
+ * {{#if user.isPremium}}
+ * ⭐ VIP CUSTOMER - Provide white-glove service!
+ * {{/if}}
+ *
+ * {{#unless isBusinessHours}}
+ * NOTE: Outside business hours. Suggest emergency contact.
+ * {{/unless}}
+ * ```
+ *
+ * @param filePath - Path to instructions file (./ for agent-relative, otherwise project root)
+ * @param variables - Static object or callback returning template variables
+ * @returns InstructionsCallback compatible with FlinkAgent.instructions property
+ */
+export declare function agentInstructions<Ctx extends FlinkContext = FlinkContext>(filePath: string, variables?: Record<string, any> | ((ctx: Ctx, agentContext: AgentExecuteContext) => Record<string, any> | Promise<Record<string, any>>)): InstructionsCallback<Ctx>;
+export type { InstructionsCallback, AgentExecuteContext, InstructionsReturn } from "./FlinkAgent";