@anthropic-field/core 0.1.0

package/dist/src/tools/write-file.js

@@ -0,0 +1,341 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import fs from 'node:fs';
+import fsPromises from 'node:fs/promises';
+import path from 'node:path';
+import os from 'node:os';
+import * as Diff from 'diff';
+import { WRITE_FILE_TOOL_NAME } from './tool-names.js';
+import { ApprovalMode } from '../policy/types.js';
+import { BaseDeclarativeTool, BaseToolInvocation, Kind, ToolConfirmationOutcome, } from './tools.js';
+import { ToolErrorType } from './tool-error.js';
+import { makeRelative, shortenPath } from '../utils/paths.js';
+import { getErrorMessage, isNodeError } from '../utils/errors.js';
+import { ensureCorrectEdit, ensureCorrectFileContent, } from '../utils/editCorrector.js';
+import { detectLineEnding } from '../utils/textUtils.js';
+import { DEFAULT_DIFF_OPTIONS, getDiffStat } from './diffOptions.js';
+import { IdeClient } from '../ide/ide-client.js';
+import { logFileOperation } from '../telemetry/loggers.js';
+import { FileOperationEvent } from '../telemetry/types.js';
+import { FileOperation } from '../telemetry/metrics.js';
+import { getSpecificMimeType } from '../utils/fileUtils.js';
+import { getLanguageFromFilePath } from '../utils/language-detection.js';
+import { debugLogger } from '../utils/debugLogger.js';
+export async function getCorrectedFileContent(config, filePath, proposedContent, abortSignal) {
+    let originalContent = '';
+    let fileExists = false;
+    let correctedContent = proposedContent;
+    try {
+        originalContent = await config
+            .getFileSystemService()
+            .readTextFile(filePath);
+        fileExists = true; // File exists and was read
+    }
+    catch (err) {
+        if (isNodeError(err) && err.code === 'ENOENT') {
+            fileExists = false;
+            originalContent = '';
+        }
+        else {
+            // File exists but could not be read (permissions, etc.)
+            fileExists = true; // Mark as existing but problematic
+            originalContent = ''; // Can't use its content
+            const error = {
+                message: getErrorMessage(err),
+                code: isNodeError(err) ? err.code : undefined,
+            };
+            // Return early as we can't proceed with content correction meaningfully
+            return { originalContent, correctedContent, fileExists, error };
+        }
+    }
+    // If readError is set, we have returned.
+    // So, file was either read successfully (fileExists=true, originalContent set)
+    // or it was ENOENT (fileExists=false, originalContent='').
+    if (fileExists) {
+        // This implies originalContent is available
+        const { params: correctedParams } = await ensureCorrectEdit(filePath, originalContent, {
+            old_string: originalContent, // Treat entire current content as old_string
+            new_string: proposedContent,
+            file_path: filePath,
+        }, config.getGeminiClient(), config.getBaseLlmClient(), abortSignal, config.getDisableLLMCorrection());
+        correctedContent = correctedParams.new_string;
+    }
+    else {
+        // This implies new file (ENOENT)
+        correctedContent = await ensureCorrectFileContent(proposedContent, config.getBaseLlmClient(), abortSignal, config.getDisableLLMCorrection());
+    }
+    return { originalContent, correctedContent, fileExists };
+}
+class WriteFileToolInvocation extends BaseToolInvocation {
+    config;
+    resolvedPath;
+    constructor(config, params, messageBus, toolName, displayName) {
+        super(params, messageBus, toolName, displayName);
+        this.config = config;
+        this.resolvedPath = path.resolve(this.config.getTargetDir(), this.params.file_path);
+    }
+    toolLocations() {
+        return [{ path: this.resolvedPath }];
+    }
+    getDescription() {
+        const relativePath = makeRelative(this.resolvedPath, this.config.getTargetDir());
+        return `Writing to ${shortenPath(relativePath)}`;
+    }
+    async getConfirmationDetails(abortSignal) {
+        if (this.config.getApprovalMode() === ApprovalMode.AUTO_EDIT) {
+            return false;
+        }
+        const correctedContentResult = await getCorrectedFileContent(this.config, this.resolvedPath, this.params.content, abortSignal);
+        if (correctedContentResult.error) {
+            // If file exists but couldn't be read, we can't show a diff for confirmation.
+            return false;
+        }
+        const { originalContent, correctedContent } = correctedContentResult;
+        const relativePath = makeRelative(this.resolvedPath, this.config.getTargetDir());
+        const fileName = path.basename(this.resolvedPath);
+        const fileDiff = Diff.createPatch(fileName, originalContent, // Original content (empty if new file or unreadable)
+        correctedContent, // Content after potential correction
+        'Current', 'Proposed', DEFAULT_DIFF_OPTIONS);
+        const ideClient = await IdeClient.getInstance();
+        const ideConfirmation = this.config.getIdeMode() && ideClient.isDiffingEnabled()
+            ? ideClient.openDiff(this.resolvedPath, correctedContent)
+            : undefined;
+        const confirmationDetails = {
+            type: 'edit',
+            title: `Confirm Write: ${shortenPath(relativePath)}`,
+            fileName,
+            filePath: this.resolvedPath,
+            fileDiff,
+            originalContent,
+            newContent: correctedContent,
+            onConfirm: async (outcome) => {
+                if (outcome === ToolConfirmationOutcome.ProceedAlways) {
+                    // No need to publish a policy update as the default policy for
+                    // AUTO_EDIT already reflects always approving write-file.
+                    this.config.setApprovalMode(ApprovalMode.AUTO_EDIT);
+                }
+                else {
+                    await this.publishPolicyUpdate(outcome);
+                }
+                if (ideConfirmation) {
+                    const result = await ideConfirmation;
+                    if (result.status === 'accepted' && result.content) {
+                        this.params.content = result.content;
+                    }
+                }
+            },
+            ideConfirmation,
+        };
+        return confirmationDetails;
+    }
+    async execute(abortSignal) {
+        const validationError = this.config.validatePathAccess(this.resolvedPath);
+        if (validationError) {
+            return {
+                llmContent: validationError,
+                returnDisplay: 'Error: Path not in workspace.',
+                error: {
+                    message: validationError,
+                    type: ToolErrorType.PATH_NOT_IN_WORKSPACE,
+                },
+            };
+        }
+        const { content, ai_proposed_content, modified_by_user } = this.params;
+        const correctedContentResult = await getCorrectedFileContent(this.config, this.resolvedPath, content, abortSignal);
+        if (correctedContentResult.error) {
+            const errDetails = correctedContentResult.error;
+            const errorMsg = errDetails.code
+                ? `Error checking existing file '${this.resolvedPath}': ${errDetails.message} (${errDetails.code})`
+                : `Error checking existing file: ${errDetails.message}`;
+            return {
+                llmContent: errorMsg,
+                returnDisplay: errorMsg,
+                error: {
+                    message: errorMsg,
+                    type: ToolErrorType.FILE_WRITE_FAILURE,
+                },
+            };
+        }
+        const { originalContent, correctedContent: fileContent, fileExists, } = correctedContentResult;
+        // fileExists is true if the file existed (and was readable or unreadable but caught by readError).
+        // fileExists is false if the file did not exist (ENOENT).
+        const isNewFile = !fileExists ||
+            (correctedContentResult.error !== undefined &&
+                !correctedContentResult.fileExists);
+        try {
+            const dirName = path.dirname(this.resolvedPath);
+            try {
+                await fsPromises.access(dirName);
+            }
+            catch {
+                await fsPromises.mkdir(dirName, { recursive: true });
+            }
+            let finalContent = fileContent;
+            const useCRLF = !isNewFile && originalContent
+                ? detectLineEnding(originalContent) === '\r\n'
+                : os.EOL === '\r\n';
+            if (useCRLF) {
+                finalContent = finalContent.replace(/\r?\n/g, '\r\n');
+            }
+            await this.config
+                .getFileSystemService()
+                .writeTextFile(this.resolvedPath, finalContent);
+            // Generate diff for display result
+            const fileName = path.basename(this.resolvedPath);
+            // If there was a readError, originalContent in correctedContentResult is '',
+            // but for the diff, we want to show the original content as it was before the write if possible.
+            // However, if it was unreadable, currentContentForDiff will be empty.
+            const currentContentForDiff = correctedContentResult.error
+                ? '' // Or some indicator of unreadable content
+                : originalContent;
+            const fileDiff = Diff.createPatch(fileName, currentContentForDiff, fileContent, 'Original', 'Written', DEFAULT_DIFF_OPTIONS);
+            const originallyProposedContent = ai_proposed_content || content;
+            const diffStat = getDiffStat(fileName, currentContentForDiff, originallyProposedContent, content);
+            const llmSuccessMessageParts = [
+                isNewFile
+                    ? `Successfully created and wrote to new file: ${this.resolvedPath}.`
+                    : `Successfully overwrote file: ${this.resolvedPath}.`,
+            ];
+            if (modified_by_user) {
+                llmSuccessMessageParts.push(`User modified the \`content\` to be: ${content}`);
+            }
+            // Log file operation for telemetry (without diff_stat to avoid double-counting)
+            const mimetype = getSpecificMimeType(this.resolvedPath);
+            const programmingLanguage = getLanguageFromFilePath(this.resolvedPath);
+            const extension = path.extname(this.resolvedPath);
+            const operation = isNewFile ? FileOperation.CREATE : FileOperation.UPDATE;
+            logFileOperation(this.config, new FileOperationEvent(WRITE_FILE_TOOL_NAME, operation, fileContent.split('\n').length, mimetype, extension, programmingLanguage));
+            const displayResult = {
+                fileDiff,
+                fileName,
+                filePath: this.resolvedPath,
+                originalContent: correctedContentResult.originalContent,
+                newContent: correctedContentResult.correctedContent,
+                diffStat,
+                isNewFile,
+            };
+            return {
+                llmContent: llmSuccessMessageParts.join(' '),
+                returnDisplay: displayResult,
+            };
+        }
+        catch (error) {
+            // Capture detailed error information for debugging
+            let errorMsg;
+            let errorType = ToolErrorType.FILE_WRITE_FAILURE;
+            if (isNodeError(error)) {
+                // Handle specific Node.js errors with their error codes
+                errorMsg = `Error writing to file '${this.resolvedPath}': ${error.message} (${error.code})`;
+                // Log specific error types for better debugging
+                if (error.code === 'EACCES') {
+                    errorMsg = `Permission denied writing to file: ${this.resolvedPath} (${error.code})`;
+                    errorType = ToolErrorType.PERMISSION_DENIED;
+                }
+                else if (error.code === 'ENOSPC') {
+                    errorMsg = `No space left on device: ${this.resolvedPath} (${error.code})`;
+                    errorType = ToolErrorType.NO_SPACE_LEFT;
+                }
+                else if (error.code === 'EISDIR') {
+                    errorMsg = `Target is a directory, not a file: ${this.resolvedPath} (${error.code})`;
+                    errorType = ToolErrorType.TARGET_IS_DIRECTORY;
+                }
+                // Include stack trace in debug mode for better troubleshooting
+                if (this.config.getDebugMode() && error.stack) {
+                    debugLogger.error('Write file error stack:', error.stack);
+                }
+            }
+            else if (error instanceof Error) {
+                errorMsg = `Error writing to file: ${error.message}`;
+            }
+            else {
+                errorMsg = `Error writing to file: ${String(error)}`;
+            }
+            return {
+                llmContent: errorMsg,
+                returnDisplay: errorMsg,
+                error: {
+                    message: errorMsg,
+                    type: errorType,
+                },
+            };
+        }
+    }
+}
+/**
+ * Implementation of the WriteFile tool logic
+ */
+export class WriteFileTool extends BaseDeclarativeTool {
+    config;
+    static Name = WRITE_FILE_TOOL_NAME;
+    constructor(config, messageBus) {
+        super(WriteFileTool.Name, 'WriteFile', `Writes content to a specified file in the local filesystem.
+
+      The user has the ability to modify \`content\`. If modified, this will be stated in the response.`, Kind.Edit, {
+            properties: {
+                file_path: {
+                    description: 'The path to the file to write to.',
+                    type: 'string',
+                },
+                content: {
+                    description: 'The content to write to the file.',
+                    type: 'string',
+                },
+            },
+            required: ['file_path', 'content'],
+            type: 'object',
+        }, messageBus, true, false);
+        this.config = config;
+    }
+    validateToolParamValues(params) {
+        const filePath = params.file_path;
+        if (!filePath) {
+            return `Missing or empty "file_path"`;
+        }
+        const resolvedPath = path.resolve(this.config.getTargetDir(), filePath);
+        const validationError = this.config.validatePathAccess(resolvedPath);
+        if (validationError) {
+            return validationError;
+        }
+        try {
+            if (fs.existsSync(resolvedPath)) {
+                const stats = fs.lstatSync(resolvedPath);
+                if (stats.isDirectory()) {
+                    return `Path is a directory, not a file: ${resolvedPath}`;
+                }
+            }
+        }
+        catch (statError) {
+            return `Error accessing path properties for validation: ${resolvedPath}. Reason: ${statError instanceof Error ? statError.message : String(statError)}`;
+        }
+        return null;
+    }
+    createInvocation(params, messageBus) {
+        return new WriteFileToolInvocation(this.config, params, messageBus ?? this.messageBus, this.name, this.displayName);
+    }
+    getModifyContext(abortSignal) {
+        return {
+            getFilePath: (params) => params.file_path,
+            getCurrentContent: async (params) => {
+                const correctedContentResult = await getCorrectedFileContent(this.config, params.file_path, params.content, abortSignal);
+                return correctedContentResult.originalContent;
+            },
+            getProposedContent: async (params) => {
+                const correctedContentResult = await getCorrectedFileContent(this.config, params.file_path, params.content, abortSignal);
+                return correctedContentResult.correctedContent;
+            },
+            createUpdatedParams: (_oldContent, modifiedProposedContent, originalParams) => {
+                const content = originalParams.content;
+                return {
+                    ...originalParams,
+                    ai_proposed_content: content,
+                    content: modifiedProposedContent,
+                    modified_by_user: true,
+                };
+            },
+        };
+    }
+}
+//# sourceMappingURL=write-file.js.map

package/dist/src/tools/write-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"write-file.js","sourceRoot":"","sources":["../../../src/tools/write-file.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAC1C,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAEvD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAUlD,OAAO,EACL,mBAAmB,EACnB,kBAAkB,EAClB,IAAI,EACJ,uBAAuB,GACxB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAClE,OAAO,EACL,iBAAiB,EACjB,wBAAwB,GACzB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAKrE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AAEzE,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAkCtD,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,MAAc,EACd,QAAgB,EAChB,eAAuB,EACvB,WAAwB;IAExB,IAAI,eAAe,GAAG,EAAE,CAAC;IACzB,IAAI,UAAU,GAAG,KAAK,CAAC;IACvB,IAAI,gBAAgB,GAAG,eAAe,CAAC;IAEvC,IAAI,CAAC;QACH,eAAe,GAAG,MAAM,MAAM;aAC3B,oBAAoB,EAAE;aACtB,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC1B,UAAU,GAAG,IAAI,CAAC,CAAC,2BAA2B;IAChD,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,WAAW,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC9C,UAAU,GAAG,KAAK,CAAC;YACnB,eAAe,GAAG,EAAE,CAAC;QACvB,CAAC;aAAM,CAAC;YACN,wDAAwD;YACxD,UAAU,GAAG,IAAI,CAAC,CAAC,mCAAmC;YACtD,eAAe,GAAG,EAAE,CAAC,CAAC,wBAAwB;YAC9C,MAAM,KAAK,GAAG;gBACZ,OAAO,EAAE,eAAe,CAAC,GAAG,CAAC;gBAC7B,IAAI,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;aAC9C,CAAC;YACF,wEAAwE;YACxE,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;QAClE,CAAC;IACH,CAAC;IAED,yCAAyC;IACzC,+EAA+E;IAC/E,2DAA2D;IAE3D,IAAI,UAAU,EAAE,CAAC;QACf,4CAA4C;QAC5C,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,iBAAiB,CACzD,QAAQ,EACR,eAAe,EACf;YACE,UAAU,EAAE,eAAe,EAAE,6CAA6C;YAC1E,UAAU,EAAE,eAAe;YAC3B,SAAS,EAAE,QAAQ;SACpB,EACD,MAAM,CAAC,eAAe,EAAE,EACxB,MAAM,CAAC,gBAAgB,EAAE,EACzB,WAAW,EACX,MAAM,CAAC,uBAAuB,EAAE,CACjC,CAAC;QACF,gBAAgB,GAAG,eAAe,CAAC,UAAU,CAAC;IAChD,CAAC;SAAM,CAAC;QACN,iCAAiC;QACjC,gBAAgB,GAAG,MAAM,wBAAwB,CAC/C,eAAe,EACf,MAAM,CAAC,gBAAgB,EAAE,EACzB,WAAW,EACX,MAAM,CAAC,uBAAuB,EAAE,CACjC,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,UAAU,EAAE,CAAC;AAC3D,CAAC;AAED,MAAM,uBAAwB,SAAQ,kBAGrC;IAIoB;IAHF,YAAY,CAAS;IAEtC,YACmB,MAAc,EAC/B,MAA2B,EAC3B,UAAsB,EACtB,QAAiB,EACjB,WAAoB;QAEpB,KAAK,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;QANhC,WAAM,GAAN,MAAM,CAAQ;QAO/B,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,OAAO,CAC9B,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,EAC1B,IAAI,CAAC,MAAM,CAAC,SAAS,CACtB,CAAC;IACJ,CAAC;IAEQ,aAAa;QACpB,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;IACvC,CAAC;IAEQ,cAAc;QACrB,MAAM,YAAY,GAAG,YAAY,CAC/B,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAC3B,CAAC;QACF,OAAO,cAAc,WAAW,CAAC,YAAY,CAAC,EAAE,CAAC;IACnD,CAAC;IAEkB,KAAK,CAAC,sBAAsB,CAC7C,WAAwB;QAExB,IAAI,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,KAAK,YAAY,CAAC,SAAS,EAAE,CAAC;YAC7D,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,sBAAsB,GAAG,MAAM,uBAAuB,CAC1D,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,MAAM,CAAC,OAAO,EACnB,WAAW,CACZ,CAAC;QAEF,IAAI,sBAAsB,CAAC,KAAK,EAAE,CAAC;YACjC,8EAA8E;YAC9E,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,EAAE,eAAe,EAAE,gBAAgB,EAAE,GAAG,sBAAsB,CAAC;QACrE,MAAM,YAAY,GAAG,YAAY,CAC/B,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAC3B,CAAC;QACF,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAElD,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAC/B,QAAQ,EACR,eAAe,EAAE,qDAAqD;QACtE,gBAAgB,EAAE,qCAAqC;QACvD,SAAS,EACT,UAAU,EACV,oBAAoB,CACrB,CAAC;QAEF,MAAM,SAAS,GAAG,MAAM,SAAS,CAAC,WAAW,EAAE,CAAC;QAChD,MAAM,eAAe,GACnB,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,SAAS,CAAC,gBAAgB,EAAE;YACtD,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,gBAAgB,CAAC;YACzD,CAAC,CAAC,SAAS,CAAC;QAEhB,MAAM,mBAAmB,GAAgC;YACvD,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,kBAAkB,WAAW,CAAC,YAAY,CAAC,EAAE;YACpD,QAAQ;YACR,QAAQ,EAAE,IAAI,CAAC,YAAY;YAC3B,QAAQ;YACR,eAAe;YACf,UAAU,EAAE,gBAAgB;YAC5B,SAAS,EAAE,KAAK,EAAE,OAAgC,EAAE,EAAE;gBACpD,IAAI,OAAO,KAAK,uBAAuB,CAAC,aAAa,EAAE,CAAC;oBACtD,+DAA+D;oBAC/D,0DAA0D;oBAC1D,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;gBACtD,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;gBAC1C,CAAC;gBAED,IAAI,eAAe,EAAE,CAAC;oBACpB,MAAM,MAAM,GAAG,MAAM,eAAe,CAAC;oBACrC,IAAI,MAAM,CAAC,MAAM,KAAK,UAAU,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;wBACnD,IAAI,CAAC,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;oBACvC,CAAC;gBACH,CAAC;YACH,CAAC;YACD,eAAe;SAChB,CAAC;QACF,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,WAAwB;QACpC,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC1E,IAAI,eAAe,EAAE,CAAC;YACpB,OAAO;gBACL,UAAU,EAAE,eAAe;gBAC3B,aAAa,EAAE,+BAA+B;gBAC9C,KAAK,EAAE;oBACL,OAAO,EAAE,eAAe;oBACxB,IAAI,EAAE,aAAa,CAAC,qBAAqB;iBAC1C;aACF,CAAC;QACJ,CAAC;QAED,MAAM,EAAE,OAAO,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;QACvE,MAAM,sBAAsB,GAAG,MAAM,uBAAuB,CAC1D,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,YAAY,EACjB,OAAO,EACP,WAAW,CACZ,CAAC;QAEF,IAAI,sBAAsB,CAAC,KAAK,EAAE,CAAC;YACjC,MAAM,UAAU,GAAG,sBAAsB,CAAC,KAAK,CAAC;YAChD,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI;gBAC9B,CAAC,CAAC,iCAAiC,IAAI,CAAC,YAAY,MAAM,UAAU,CAAC,OAAO,KAAK,UAAU,CAAC,IAAI,GAAG;gBACnG,CAAC,CAAC,iCAAiC,UAAU,CAAC,OAAO,EAAE,CAAC;YAC1D,OAAO;gBACL,UAAU,EAAE,QAAQ;gBACpB,aAAa,EAAE,QAAQ;gBACvB,KAAK,EAAE;oBACL,OAAO,EAAE,QAAQ;oBACjB,IAAI,EAAE,aAAa,CAAC,kBAAkB;iBACvC;aACF,CAAC;QACJ,CAAC;QAED,MAAM,EACJ,eAAe,EACf,gBAAgB,EAAE,WAAW,EAC7B,UAAU,GACX,GAAG,sBAAsB,CAAC;QAC3B,mGAAmG;QACnG,0DAA0D;QAC1D,MAAM,SAAS,GACb,CAAC,UAAU;YACX,CAAC,sBAAsB,CAAC,KAAK,KAAK,SAAS;gBACzC,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;QAExC,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAChD,IAAI,CAAC;gBACH,MAAM,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YACnC,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM,UAAU,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACvD,CAAC;YAED,IAAI,YAAY,GAAG,WAAW,CAAC;YAC/B,MAAM,OAAO,GACX,CAAC,SAAS,IAAI,eAAe;gBAC3B,CAAC,CAAC,gBAAgB,CAAC,eAAe,CAAC,KAAK,MAAM;gBAC9C,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,MAAM,CAAC;YAExB,IAAI,OAAO,EAAE,CAAC;gBACZ,YAAY,GAAG,YAAY,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YACxD,CAAC;YAED,MAAM,IAAI,CAAC,MAAM;iBACd,oBAAoB,EAAE;iBACtB,aAAa,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;YAElD,mCAAmC;YACnC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAClD,6EAA6E;YAC7E,iGAAiG;YACjG,sEAAsE;YACtE,MAAM,qBAAqB,GAAG,sBAAsB,CAAC,KAAK;gBACxD,CAAC,CAAC,EAAE,CAAC,0CAA0C;gBAC/C,CAAC,CAAC,eAAe,CAAC;YAEpB,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAC/B,QAAQ,EACR,qBAAqB,EACrB,WAAW,EACX,UAAU,EACV,SAAS,EACT,oBAAoB,CACrB,CAAC;YAEF,MAAM,yBAAyB,GAAG,mBAAmB,IAAI,OAAO,CAAC;YACjE,MAAM,QAAQ,GAAG,WAAW,CAC1B,QAAQ,EACR,qBAAqB,EACrB,yBAAyB,EACzB,OAAO,CACR,CAAC;YAEF,MAAM,sBAAsB,GAAG;gBAC7B,SAAS;oBACP,CAAC,CAAC,+CAA+C,IAAI,CAAC,YAAY,GAAG;oBACrE,CAAC,CAAC,gCAAgC,IAAI,CAAC,YAAY,GAAG;aACzD,CAAC;YACF,IAAI,gBAAgB,EAAE,CAAC;gBACrB,sBAAsB,CAAC,IAAI,CACzB,wCAAwC,OAAO,EAAE,CAClD,CAAC;YACJ,CAAC;YAED,gFAAgF;YAChF,MAAM,QAAQ,GAAG,mBAAmB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACxD,MAAM,mBAAmB,GAAG,uBAAuB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACvE,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAClD,MAAM,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC;YAE1E,gBAAgB,CACd,IAAI,CAAC,MAAM,EACX,IAAI,kBAAkB,CACpB,oBAAoB,EACpB,SAAS,EACT,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,EAC9B,QAAQ,EACR,SAAS,EACT,mBAAmB,CACpB,CACF,CAAC;YAEF,MAAM,aAAa,GAAa;gBAC9B,QAAQ;gBACR,QAAQ;gBACR,QAAQ,EAAE,IAAI,CAAC,YAAY;gBAC3B,eAAe,EAAE,sBAAsB,CAAC,eAAe;gBACvD,UAAU,EAAE,sBAAsB,CAAC,gBAAgB;gBACnD,QAAQ;gBACR,SAAS;aACV,CAAC;YAEF,OAAO;gBACL,UAAU,EAAE,sBAAsB,CAAC,IAAI,CAAC,GAAG,CAAC;gBAC5C,aAAa,EAAE,aAAa;aAC7B,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,mDAAmD;YACnD,IAAI,QAAgB,CAAC;YACrB,IAAI,SAAS,GAAG,aAAa,CAAC,kBAAkB,CAAC;YAEjD,IAAI,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;gBACvB,wDAAwD;gBACxD,QAAQ,GAAG,0BAA0B,IAAI,CAAC,YAAY,MAAM,KAAK,CAAC,OAAO,KAAK,KAAK,CAAC,IAAI,GAAG,CAAC;gBAE5F,gDAAgD;gBAChD,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAC5B,QAAQ,GAAG,sCAAsC,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,IAAI,GAAG,CAAC;oBACrF,SAAS,GAAG,aAAa,CAAC,iBAAiB,CAAC;gBAC9C,CAAC;qBAAM,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBACnC,QAAQ,GAAG,4BAA4B,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,IAAI,GAAG,CAAC;oBAC3E,SAAS,GAAG,aAAa,CAAC,aAAa,CAAC;gBAC1C,CAAC;qBAAM,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBACnC,QAAQ,GAAG,sCAAsC,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,IAAI,GAAG,CAAC;oBACrF,SAAS,GAAG,aAAa,CAAC,mBAAmB,CAAC;gBAChD,CAAC;gBAED,+DAA+D;gBAC/D,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;oBAC9C,WAAW,CAAC,KAAK,CAAC,yBAAyB,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;gBAC5D,CAAC;YACH,CAAC;iBAAM,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;gBAClC,QAAQ,GAAG,0BAA0B,KAAK,CAAC,OAAO,EAAE,CAAC;YACvD,CAAC;iBAAM,CAAC;gBACN,QAAQ,GAAG,0BAA0B,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACvD,CAAC;YAED,OAAO;gBACL,UAAU,EAAE,QAAQ;gBACpB,aAAa,EAAE,QAAQ;gBACvB,KAAK,EAAE;oBACL,OAAO,EAAE,QAAQ;oBACjB,IAAI,EAAE,SAAS;iBAChB;aACF,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,aACX,SAAQ,mBAAoD;IAMzC;IAHnB,MAAM,CAAU,IAAI,GAAG,oBAAoB,CAAC;IAE5C,YACmB,MAAc,EAC/B,UAAsB;QAEtB,KAAK,CACH,aAAa,CAAC,IAAI,EAClB,WAAW,EACX;;wGAEkG,EAClG,IAAI,CAAC,IAAI,EACT;YACE,UAAU,EAAE;gBACV,SAAS,EAAE;oBACT,WAAW,EAAE,mCAAmC;oBAChD,IAAI,EAAE,QAAQ;iBACf;gBACD,OAAO,EAAE;oBACP,WAAW,EAAE,mCAAmC;oBAChD,IAAI,EAAE,QAAQ;iBACf;aACF;YACD,QAAQ,EAAE,CAAC,WAAW,EAAE,SAAS,CAAC;YAClC,IAAI,EAAE,QAAQ;SACf,EACD,UAAU,EACV,IAAI,EACJ,KAAK,CACN,CAAC;QA3Be,WAAM,GAAN,MAAM,CAAQ;IA4BjC,CAAC;IAEkB,uBAAuB,CACxC,MAA2B;QAE3B,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC;QAElC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,8BAA8B,CAAC;QACxC,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,QAAQ,CAAC,CAAC;QAExE,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QACrE,IAAI,eAAe,EAAE,CAAC;YACpB,OAAO,eAAe,CAAC;QACzB,CAAC;QAED,IAAI,CAAC;YACH,IAAI,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;gBAChC,MAAM,KAAK,GAAG,EAAE,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;gBACzC,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;oBACxB,OAAO,oCAAoC,YAAY,EAAE,CAAC;gBAC5D,CAAC;YACH,CAAC;QACH,CAAC;QAAC,OAAO,SAAkB,EAAE,CAAC;YAC5B,OAAO,mDAAmD,YAAY,aACpE,SAAS,YAAY,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CACnE,EAAE,CAAC;QACL,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAES,gBAAgB,CACxB,MAA2B,EAC3B,UAAsB;QAEtB,OAAO,IAAI,uBAAuB,CAChC,IAAI,CAAC,MAAM,EACX,MAAM,EACN,UAAU,IAAI,IAAI,CAAC,UAAU,EAC7B,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,WAAW,CACjB,CAAC;IACJ,CAAC;IAED,gBAAgB,CACd,WAAwB;QAExB,OAAO;YACL,WAAW,EAAE,CAAC,MAA2B,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS;YAC9D,iBAAiB,EAAE,KAAK,EAAE,MAA2B,EAAE,EAAE;gBACvD,MAAM,sBAAsB,GAAG,MAAM,uBAAuB,CAC1D,IAAI,CAAC,MAAM,EACX,MAAM,CAAC,SAAS,EAChB,MAAM,CAAC,OAAO,EACd,WAAW,CACZ,CAAC;gBACF,OAAO,sBAAsB,CAAC,eAAe,CAAC;YAChD,CAAC;YACD,kBAAkB,EAAE,KAAK,EAAE,MAA2B,EAAE,EAAE;gBACxD,MAAM,sBAAsB,GAAG,MAAM,uBAAuB,CAC1D,IAAI,CAAC,MAAM,EACX,MAAM,CAAC,SAAS,EAChB,MAAM,CAAC,OAAO,EACd,WAAW,CACZ,CAAC;gBACF,OAAO,sBAAsB,CAAC,gBAAgB,CAAC;YACjD,CAAC;YACD,mBAAmB,EAAE,CACnB,WAAmB,EACnB,uBAA+B,EAC/B,cAAmC,EACnC,EAAE;gBACF,MAAM,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC;gBACvC,OAAO;oBACL,GAAG,cAAc;oBACjB,mBAAmB,EAAE,OAAO;oBAC5B,OAAO,EAAE,uBAAuB;oBAChC,gBAAgB,EAAE,IAAI;iBACvB,CAAC;YACJ,CAAC;SACF,CAAC;IACJ,CAAC"}

package/dist/src/tools/write-todos.d.ts

@@ -0,0 +1,50 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { ToolInvocation } from './tools.js';
+import { BaseDeclarativeTool, type Todo, type ToolResult } from './tools.js';
+import type { MessageBus } from '../confirmation-bus/message-bus.js';
+export declare const WRITE_TODOS_DESCRIPTION = "This tool can help you list out the current subtasks that are required to be completed for a given user request. The list of subtasks helps you keep track of the current task, organize complex queries and help ensure that you don't miss any steps. With this list, the user can also see the current progress you are making in executing a given task.\n\nDepending on the task complexity, you should first divide a given task into subtasks and then use this tool to list out the subtasks that are required to be completed for a given user request.\nEach of the subtasks should be clear and distinct. \n\nUse this tool for complex queries that require multiple steps. If you find that the request is actually complex after you have started executing the user task, create a todo list and use it. If execution of the user task requires multiple steps, planning and generally is higher complexity than a simple Q&A, use this tool.\n\nDO NOT use this tool for simple tasks that can be completed in less than 2 steps. If the user query is simple and straightforward, do not use the tool. If you can respond with an answer in a single turn then this tool is not required.\n\n## Task state definitions\n\n- pending: Work has not begun on a given subtask.\n- in_progress: Marked just prior to beginning work on a given subtask. You should only have one subtask as in_progress at a time.\n- completed: Subtask was successfully completed with no errors or issues. If the subtask required more steps to complete, update the todo list with the subtasks. All steps should be identified as completed only when they are completed.\n- cancelled: As you update the todo list, some tasks are not required anymore due to the dynamic nature of the task. In this case, mark the subtasks as cancelled.\n\n\n## Methodology for using this tool\n1. Use this todo list as soon as you receive a user request based on the complexity of the task.\n2. Keep track of every subtask that you update the list with.\n3. Mark a subtask as in_progress before you begin working on it. You should only have one subtask as in_progress at a time.\n4. Update the subtask list as you proceed in executing the task. The subtask list is not static and should reflect your progress and current plans, which may evolve as you acquire new information.\n5. Mark a subtask as completed when you have completed it.\n6. Mark a subtask as cancelled if the subtask is no longer needed.\n7. You must update the todo list as soon as you start, stop or cancel a subtask. Don't batch or wait to update the todo list.\n\n\n## Examples of When to Use the Todo List\n\n<example>\nUser request: Create a website with a React for creating fancy logos using gemini-2.5-flash-image\n\nToDo list created by the agent:\n1. Initialize a new React project environment (e.g., using Vite).\n2. Design and build the core UI components: a text input (prompt field) for the logo description, selection controls for style parameters (if the API supports them), and an image preview area.\n3. Implement state management (e.g., React Context or Zustand) to manage the user's input prompt, the API loading status (pending, success, error), and the resulting image data.\n4. Create an API service module within the React app (using \"fetch\" or \"axios\") to securely format and send the prompt data via an HTTP POST request to the specified \"gemini-2.5-flash-image\" (Gemini model) endpoint.\n5. Implement asynchronous logic to handle the API call: show a loading indicator while the request is pending, retrieve the generated image (e.g., as a URL or base64 string) upon success, and display any errors.\n6. Display the returned \"fancy logo\" from the API response in the preview area component.\n7. Add functionality (e.g., a \"Download\" button) to allow the user to save the generated image file.\n8. Deploy the application to a web server or hosting platform.\n\n<reasoning>\nThe agent used the todo list to break the task into distinct, manageable steps:\n1. Building an entire interactive web application from scratch is a highly complex, multi-stage process involving setup, UI development, logic integration, and deployment.\n2. The agent inferred the core functionality required for a \"logo creator,\" such as UI controls for customization (Task 3) and an export feature (Task 7), which must be tracked as distinct goals.\n3. The agent rightly inferred the requirement of an API service model for interacting with the image model endpoint.\n</reasoning>\n</example>\n\n\n## Examples of When NOT to Use the Todo List\n\n<example>\nUser request: Ensure that the test <test file> passes.\n\nAgent:\n<Goes into a loop of running the test, identifying errors, and updating the code until the test passes.>\n\n<reasoning>\nThe agent did not use the todo list because this task could be completed by a tight loop of execute test->edit->execute test.\n</reasoning>\n</example>\n";
+export interface WriteTodosToolParams {
+    /**
+     * The full list of todos. This will overwrite any existing list.
+     */
+    todos: Todo[];
+}
+export declare class WriteTodosTool extends BaseDeclarativeTool<WriteTodosToolParams, ToolResult> {
+    static readonly Name = "write_todos";
+    constructor(messageBus: MessageBus);
+    get schema(): {
+        name: string;
+        description: string;
+        parametersJsonSchema: unknown;
+        responseJsonSchema: {
+            type: string;
+            properties: {
+                todos: {
+                    type: string;
+                    items: {
+                        type: string;
+                        properties: {
+                            description: {
+                                type: string;
+                            };
+                            status: {
+                                type: string;
+                                enum: readonly ["pending", "in_progress", "completed", "cancelled"];
+                            };
+                        };
+                        required: string[];
+                        additionalProperties: boolean;
+                    };
+                };
+            };
+            required: string[];
+            additionalProperties: boolean;
+        };
+    };
+    protected validateToolParamValues(params: WriteTodosToolParams): string | null;
+    protected createInvocation(params: WriteTodosToolParams, messageBus: MessageBus, _toolName?: string, _displayName?: string): ToolInvocation<WriteTodosToolParams, ToolResult>;
+}

package/dist/src/tools/write-todos.js

@@ -0,0 +1,194 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { BaseDeclarativeTool, BaseToolInvocation, Kind, } from './tools.js';
+import { WRITE_TODOS_TOOL_NAME } from './tool-names.js';
+const TODO_STATUSES = [
+    'pending',
+    'in_progress',
+    'completed',
+    'cancelled',
+];
+// Inspired by langchain/deepagents.
+export const WRITE_TODOS_DESCRIPTION = `This tool can help you list out the current subtasks that are required to be completed for a given user request. The list of subtasks helps you keep track of the current task, organize complex queries and help ensure that you don't miss any steps. With this list, the user can also see the current progress you are making in executing a given task.
+
+Depending on the task complexity, you should first divide a given task into subtasks and then use this tool to list out the subtasks that are required to be completed for a given user request.
+Each of the subtasks should be clear and distinct. 
+
+Use this tool for complex queries that require multiple steps. If you find that the request is actually complex after you have started executing the user task, create a todo list and use it. If execution of the user task requires multiple steps, planning and generally is higher complexity than a simple Q&A, use this tool.
+
+DO NOT use this tool for simple tasks that can be completed in less than 2 steps. If the user query is simple and straightforward, do not use the tool. If you can respond with an answer in a single turn then this tool is not required.
+
+## Task state definitions
+
+- pending: Work has not begun on a given subtask.
+- in_progress: Marked just prior to beginning work on a given subtask. You should only have one subtask as in_progress at a time.
+- completed: Subtask was successfully completed with no errors or issues. If the subtask required more steps to complete, update the todo list with the subtasks. All steps should be identified as completed only when they are completed.
+- cancelled: As you update the todo list, some tasks are not required anymore due to the dynamic nature of the task. In this case, mark the subtasks as cancelled.
+
+
+## Methodology for using this tool
+1. Use this todo list as soon as you receive a user request based on the complexity of the task.
+2. Keep track of every subtask that you update the list with.
+3. Mark a subtask as in_progress before you begin working on it. You should only have one subtask as in_progress at a time.
+4. Update the subtask list as you proceed in executing the task. The subtask list is not static and should reflect your progress and current plans, which may evolve as you acquire new information.
+5. Mark a subtask as completed when you have completed it.
+6. Mark a subtask as cancelled if the subtask is no longer needed.
+7. You must update the todo list as soon as you start, stop or cancel a subtask. Don't batch or wait to update the todo list.
+
+
+## Examples of When to Use the Todo List
+
+<example>
+User request: Create a website with a React for creating fancy logos using gemini-2.5-flash-image
+
+ToDo list created by the agent:
+1. Initialize a new React project environment (e.g., using Vite).
+2. Design and build the core UI components: a text input (prompt field) for the logo description, selection controls for style parameters (if the API supports them), and an image preview area.
+3. Implement state management (e.g., React Context or Zustand) to manage the user's input prompt, the API loading status (pending, success, error), and the resulting image data.
+4. Create an API service module within the React app (using "fetch" or "axios") to securely format and send the prompt data via an HTTP POST request to the specified "gemini-2.5-flash-image" (Gemini model) endpoint.
+5. Implement asynchronous logic to handle the API call: show a loading indicator while the request is pending, retrieve the generated image (e.g., as a URL or base64 string) upon success, and display any errors.
+6. Display the returned "fancy logo" from the API response in the preview area component.
+7. Add functionality (e.g., a "Download" button) to allow the user to save the generated image file.
+8. Deploy the application to a web server or hosting platform.
+
+<reasoning>
+The agent used the todo list to break the task into distinct, manageable steps:
+1. Building an entire interactive web application from scratch is a highly complex, multi-stage process involving setup, UI development, logic integration, and deployment.
+2. The agent inferred the core functionality required for a "logo creator," such as UI controls for customization (Task 3) and an export feature (Task 7), which must be tracked as distinct goals.
+3. The agent rightly inferred the requirement of an API service model for interacting with the image model endpoint.
+</reasoning>
+</example>
+
+
+## Examples of When NOT to Use the Todo List
+
+<example>
+User request: Ensure that the test <test file> passes.
+
+Agent:
+<Goes into a loop of running the test, identifying errors, and updating the code until the test passes.>
+
+<reasoning>
+The agent did not use the todo list because this task could be completed by a tight loop of execute test->edit->execute test.
+</reasoning>
+</example>
+`;
+class WriteTodosToolInvocation extends BaseToolInvocation {
+    constructor(params, messageBus, _toolName, _toolDisplayName) {
+        super(params, messageBus, _toolName, _toolDisplayName);
+    }
+    getDescription() {
+        const count = this.params.todos?.length ?? 0;
+        if (count === 0) {
+            return 'Cleared todo list';
+        }
+        return `Set ${count} todo(s)`;
+    }
+    async execute(_signal, _updateOutput) {
+        const todos = this.params.todos ?? [];
+        const todoListString = todos
+            .map((todo, index) => `${index + 1}. [${todo.status}] ${todo.description}`)
+            .join('\n');
+        const llmContent = todos.length > 0
+            ? `Successfully updated the todo list. The current list is now:\n${todoListString}`
+            : 'Successfully cleared the todo list.';
+        return {
+            llmContent,
+            returnDisplay: { todos },
+        };
+    }
+}
+export class WriteTodosTool extends BaseDeclarativeTool {
+    static Name = WRITE_TODOS_TOOL_NAME;
+    constructor(messageBus) {
+        super(WriteTodosTool.Name, 'WriteTodos', WRITE_TODOS_DESCRIPTION, Kind.Other, {
+            type: 'object',
+            properties: {
+                todos: {
+                    type: 'array',
+                    description: 'The complete list of todo items. This will replace the existing list.',
+                    items: {
+                        type: 'object',
+                        description: 'A single todo item.',
+                        properties: {
+                            description: {
+                                type: 'string',
+                                description: 'The description of the task.',
+                            },
+                            status: {
+                                type: 'string',
+                                description: 'The current status of the task.',
+                                enum: TODO_STATUSES,
+                            },
+                        },
+                        required: ['description', 'status'],
+                        additionalProperties: false,
+                    },
+                },
+            },
+            required: ['todos'],
+            additionalProperties: false,
+        }, messageBus, true, // isOutputMarkdown
+        false);
+    }
+    get schema() {
+        return {
+            name: this.name,
+            description: this.description,
+            parametersJsonSchema: this.parameterSchema,
+            responseJsonSchema: {
+                type: 'object',
+                properties: {
+                    todos: {
+                        type: 'array',
+                        items: {
+                            type: 'object',
+                            properties: {
+                                description: {
+                                    type: 'string',
+                                },
+                                status: {
+                                    type: 'string',
+                                    enum: TODO_STATUSES,
+                                },
+                            },
+                            required: ['description', 'status'],
+                            additionalProperties: false,
+                        },
+                    },
+                },
+                required: ['todos'],
+                additionalProperties: false,
+            },
+        };
+    }
+    validateToolParamValues(params) {
+        const todos = params?.todos;
+        if (!params || !Array.isArray(todos)) {
+            return '`todos` parameter must be an array';
+        }
+        for (const todo of todos) {
+            if (typeof todo !== 'object' || todo === null) {
+                return 'Each todo item must be an object';
+            }
+            if (typeof todo.description !== 'string' || !todo.description.trim()) {
+                return 'Each todo must have a non-empty description string';
+            }
+            if (!TODO_STATUSES.includes(todo.status)) {
+                return `Each todo must have a valid status (${TODO_STATUSES.join(', ')})`;
+            }
+        }
+        const inProgressCount = todos.filter((todo) => todo.status === 'in_progress').length;
+        if (inProgressCount > 1) {
+            return 'Invalid parameters: Only one task can be "in_progress" at a time.';
+        }
+        return null;
+    }
+    createInvocation(params, messageBus, _toolName, _displayName) {
+        return new WriteTodosToolInvocation(params, messageBus, _toolName, _displayName);
+    }
+}
+//# sourceMappingURL=write-todos.js.map

package/dist/src/tools/write-todos.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"write-todos.js","sourceRoot":"","sources":["../../../src/tools/write-todos.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EACL,mBAAmB,EACnB,kBAAkB,EAClB,IAAI,GAGL,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAExD,MAAM,aAAa,GAAG;IACpB,SAAS;IACT,aAAa;IACb,WAAW;IACX,WAAW;CACH,CAAC;AAEX,oCAAoC;AACpC,MAAM,CAAC,MAAM,uBAAuB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+DtC,CAAC;AASF,MAAM,wBAAyB,SAAQ,kBAGtC;IACC,YACE,MAA4B,EAC5B,UAAsB,EACtB,SAAkB,EAClB,gBAAyB;QAEzB,KAAK,CAAC,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,gBAAgB,CAAC,CAAC;IACzD,CAAC;IAED,cAAc;QACZ,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC,CAAC;QAC7C,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YAChB,OAAO,mBAAmB,CAAC;QAC7B,CAAC;QACD,OAAO,OAAO,KAAK,UAAU,CAAC;IAChC,CAAC;IAED,KAAK,CAAC,OAAO,CACX,OAAoB,EACpB,aAAwC;QAExC,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC;QACtC,MAAM,cAAc,GAAG,KAAK;aACzB,GAAG,CACF,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,GAAG,CAAC,MAAM,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,WAAW,EAAE,CACtE;aACA,IAAI,CAAC,IAAI,CAAC,CAAC;QAEd,MAAM,UAAU,GACd,KAAK,CAAC,MAAM,GAAG,CAAC;YACd,CAAC,CAAC,iEAAiE,cAAc,EAAE;YACnF,CAAC,CAAC,qCAAqC,CAAC;QAE5C,OAAO;YACL,UAAU;YACV,aAAa,EAAE,EAAE,KAAK,EAAE;SACzB,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,cAAe,SAAQ,mBAGnC;IACC,MAAM,CAAU,IAAI,GAAG,qBAAqB,CAAC;IAE7C,YAAY,UAAsB;QAChC,KAAK,CACH,cAAc,CAAC,IAAI,EACnB,YAAY,EACZ,uBAAuB,EACvB,IAAI,CAAC,KAAK,EACV;YACE,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,KAAK,EAAE;oBACL,IAAI,EAAE,OAAO;oBACb,WAAW,EACT,uEAAuE;oBACzE,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,qBAAqB;wBAClC,UAAU,EAAE;4BACV,WAAW,EAAE;gCACX,IAAI,EAAE,QAAQ;gCACd,WAAW,EAAE,8BAA8B;6BAC5C;4BACD,MAAM,EAAE;gCACN,IAAI,EAAE,QAAQ;gCACd,WAAW,EAAE,iCAAiC;gCAC9C,IAAI,EAAE,aAAa;6BACpB;yBACF;wBACD,QAAQ,EAAE,CAAC,aAAa,EAAE,QAAQ,CAAC;wBACnC,oBAAoB,EAAE,KAAK;qBAC5B;iBACF;aACF;YACD,QAAQ,EAAE,CAAC,OAAO,CAAC;YACnB,oBAAoB,EAAE,KAAK;SAC5B,EACD,UAAU,EACV,IAAI,EAAE,mBAAmB;QACzB,KAAK,CACN,CAAC;IACJ,CAAC;IAED,IAAa,MAAM;QACjB,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,oBAAoB,EAAE,IAAI,CAAC,eAAe;YAC1C,kBAAkB,EAAE;gBAClB,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE;4BACL,IAAI,EAAE,QAAQ;4BACd,UAAU,EAAE;gCACV,WAAW,EAAE;oCACX,IAAI,EAAE,QAAQ;iCACf;gCACD,MAAM,EAAE;oCACN,IAAI,EAAE,QAAQ;oCACd,IAAI,EAAE,aAAa;iCACpB;6BACF;4BACD,QAAQ,EAAE,CAAC,aAAa,EAAE,QAAQ,CAAC;4BACnC,oBAAoB,EAAE,KAAK;yBAC5B;qBACF;iBACF;gBACD,QAAQ,EAAE,CAAC,OAAO,CAAC;gBACnB,oBAAoB,EAAE,KAAK;aAC5B;SACF,CAAC;IACJ,CAAC;IAEkB,uBAAuB,CACxC,MAA4B;QAE5B,MAAM,KAAK,GAAG,MAAM,EAAE,KAAK,CAAC;QAC5B,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACrC,OAAO,oCAAoC,CAAC;QAC9C,CAAC;QAED,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;gBAC9C,OAAO,kCAAkC,CAAC;YAC5C,CAAC;YACD,IAAI,OAAO,IAAI,CAAC,WAAW,KAAK,QAAQ,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,CAAC;gBACrE,OAAO,oDAAoD,CAAC;YAC9D,CAAC;YACD,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;gBACzC,OAAO,uCAAuC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;YAC5E,CAAC;QACH,CAAC;QAED,MAAM,eAAe,GAAG,KAAK,CAAC,MAAM,CAClC,CAAC,IAAU,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,aAAa,CAC9C,CAAC,MAAM,CAAC;QAET,IAAI,eAAe,GAAG,CAAC,EAAE,CAAC;YACxB,OAAO,mEAAmE,CAAC;QAC7E,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAES,gBAAgB,CACxB,MAA4B,EAC5B,UAAsB,EACtB,SAAkB,EAClB,YAAqB;QAErB,OAAO,IAAI,wBAAwB,CACjC,MAAM,EACN,UAAU,EACV,SAAS,EACT,YAAY,CACb,CAAC;IACJ,CAAC"}

package/dist/src/utils/apiConversionUtils.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { GenerateContentParameters } from '@google/genai';
+/**
+ * Transforms a standard SDK GenerateContentParameters object into the
+ * equivalent REST API payload format. This is primarily used for debugging
+ * and exporting requests.
+ */
+export declare function convertToRestPayload(req: GenerateContentParameters): Record<string, unknown>;