andy-stack_vaultkeeper-ai/AIClasses/FunctionDefinitions/Functions/CompleteTask.ts

import { AIFunction } from "Enums/AIFunction";
import type { IAIFunctionDefinition } from "../IAIFunctionDefinition";

export const CompleteTask: IAIFunctionDefinition = {
    name: AIFunction.CompleteTask,
    description: `Signals that you have finished executing all of your assigned instructions.

This function MUST be called exactly once, only after you have fully completed or can no longer make progress on everything you were asked to do.

Call this function:
- When you have completed everything you were instructed to do (success: true)
- When you have encountered a blocker that prevents further progress on your instructions (success: false)

Do NOT use this function:
- After completing individual actions or sub-tasks
- While you still have remaining work from your instructions`,
    parameters: {
      type: "object",
      properties: {
        success: {
          type: "boolean",
          description: "Whether you successfully completed all of your assigned instructions. Set to true only if everything was accomplished, false if anything remains incomplete or failed."
        },
        description: {
          type: "string",
          description: "A summary of what was accomplished, any outputs produced, or what prevented completion."
        },
        context: {
          type: "string",
          description: "Optional contextual information that should be preserved or passed forward after task completion. Include any relevant state, findings, file paths, or intermediate results that might be useful for subsequent operations or for the user to understand what was done. Examples: 'Created 3 new notes in /Projects folder', 'Found configuration in settings.json', 'Modified files: note1.md, note2.md'"
        }
      },
      required: ["success", "description"]
    }
  };