@anthropic-field/core 0.1.0

package/dist/src/tools/memoryTool.js

@@ -0,0 +1,269 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { BaseDeclarativeTool, BaseToolInvocation, Kind, ToolConfirmationOutcome, } from './tools.js';
+import * as fs from 'node:fs/promises';
+import * as path from 'node:path';
+import { Storage } from '../config/storage.js';
+import * as Diff from 'diff';
+import { DEFAULT_DIFF_OPTIONS } from './diffOptions.js';
+import { tildeifyPath } from '../utils/paths.js';
+import { ToolErrorType } from './tool-error.js';
+import { MEMORY_TOOL_NAME } from './tool-names.js';
+const memoryToolSchemaData = {
+    name: MEMORY_TOOL_NAME,
+    description: 'Saves a specific piece of information or fact to your long-term memory. Use this when the user explicitly asks you to remember something, or when they state a clear, concise fact that seems important to retain for future interactions.',
+    parametersJsonSchema: {
+        type: 'object',
+        properties: {
+            fact: {
+                type: 'string',
+                description: 'The specific fact or piece of information to remember. Should be a clear, self-contained statement.',
+            },
+        },
+        required: ['fact'],
+    },
+};
+const memoryToolDescription = `
+Saves a specific piece of information or fact to your long-term memory.
+
+Use this tool:
+
+- When the user explicitly asks you to remember something (e.g., "Remember that I like pineapple on pizza", "Please save this: my cat's name is Whiskers").
+- When the user states a clear, concise fact about themselves, their preferences, or their environment that seems important for you to retain for future interactions to provide a more personalized and effective assistance.
+
+Do NOT use this tool:
+
+- To remember conversational context that is only relevant for the current session.
+- To save long, complex, or rambling pieces of text. The fact should be relatively short and to the point.
+- If you are unsure whether the information is a fact worth remembering long-term. If in doubt, you can ask the user, "Should I remember that for you?"
+
+## Parameters
+
+- \`fact\` (string, required): The specific fact or piece of information to remember. This should be a clear, self-contained statement. For example, if the user says "My favorite color is blue", the fact would be "My favorite color is blue".`;
+export const DEFAULT_CONTEXT_FILENAME = 'GEMINI.md';
+export const MEMORY_SECTION_HEADER = '## Gemini Added Memories';
+// This variable will hold the currently configured filename for GEMINI.md context files.
+// It defaults to DEFAULT_CONTEXT_FILENAME but can be overridden by setGeminiMdFilename.
+let currentGeminiMdFilename = DEFAULT_CONTEXT_FILENAME;
+export function setGeminiMdFilename(newFilename) {
+    if (Array.isArray(newFilename)) {
+        if (newFilename.length > 0) {
+            currentGeminiMdFilename = newFilename.map((name) => name.trim());
+        }
+    }
+    else if (newFilename && newFilename.trim() !== '') {
+        currentGeminiMdFilename = newFilename.trim();
+    }
+}
+export function getCurrentGeminiMdFilename() {
+    if (Array.isArray(currentGeminiMdFilename)) {
+        return currentGeminiMdFilename[0];
+    }
+    return currentGeminiMdFilename;
+}
+export function getAllGeminiMdFilenames() {
+    if (Array.isArray(currentGeminiMdFilename)) {
+        return currentGeminiMdFilename;
+    }
+    return [currentGeminiMdFilename];
+}
+export function getGlobalMemoryFilePath() {
+    return path.join(Storage.getGlobalGeminiDir(), getCurrentGeminiMdFilename());
+}
+/**
+ * Ensures proper newline separation before appending content.
+ */
+function ensureNewlineSeparation(currentContent) {
+    if (currentContent.length === 0)
+        return '';
+    if (currentContent.endsWith('\n\n') || currentContent.endsWith('\r\n\r\n'))
+        return '';
+    if (currentContent.endsWith('\n') || currentContent.endsWith('\r\n'))
+        return '\n';
+    return '\n\n';
+}
+/**
+ * Reads the current content of the memory file
+ */
+async function readMemoryFileContent() {
+    try {
+        return await fs.readFile(getGlobalMemoryFilePath(), 'utf-8');
+    }
+    catch (err) {
+        const error = err;
+        if (!(error instanceof Error) || error.code !== 'ENOENT')
+            throw err;
+        return '';
+    }
+}
+/**
+ * Computes the new content that would result from adding a memory entry
+ */
+function computeNewContent(currentContent, fact) {
+    let processedText = fact.trim();
+    processedText = processedText.replace(/^(-+\s*)+/, '').trim();
+    const newMemoryItem = `- ${processedText}`;
+    const headerIndex = currentContent.indexOf(MEMORY_SECTION_HEADER);
+    if (headerIndex === -1) {
+        // Header not found, append header and then the entry
+        const separator = ensureNewlineSeparation(currentContent);
+        return (currentContent +
+            `${separator}${MEMORY_SECTION_HEADER}\n${newMemoryItem}\n`);
+    }
+    else {
+        // Header found, find where to insert the new memory entry
+        const startOfSectionContent = headerIndex + MEMORY_SECTION_HEADER.length;
+        let endOfSectionIndex = currentContent.indexOf('\n## ', startOfSectionContent);
+        if (endOfSectionIndex === -1) {
+            endOfSectionIndex = currentContent.length; // End of file
+        }
+        const beforeSectionMarker = currentContent
+            .substring(0, startOfSectionContent)
+            .trimEnd();
+        let sectionContent = currentContent
+            .substring(startOfSectionContent, endOfSectionIndex)
+            .trimEnd();
+        const afterSectionMarker = currentContent.substring(endOfSectionIndex);
+        sectionContent += `\n${newMemoryItem}`;
+        return (`${beforeSectionMarker}\n${sectionContent.trimStart()}\n${afterSectionMarker}`.trimEnd() +
+            '\n');
+    }
+}
+class MemoryToolInvocation extends BaseToolInvocation {
+    static allowlist = new Set();
+    constructor(params, messageBus, toolName, displayName) {
+        super(params, messageBus, toolName, displayName);
+    }
+    getDescription() {
+        const memoryFilePath = getGlobalMemoryFilePath();
+        return `in ${tildeifyPath(memoryFilePath)}`;
+    }
+    async getConfirmationDetails(_abortSignal) {
+        const memoryFilePath = getGlobalMemoryFilePath();
+        const allowlistKey = memoryFilePath;
+        if (MemoryToolInvocation.allowlist.has(allowlistKey)) {
+            return false;
+        }
+        const currentContent = await readMemoryFileContent();
+        const newContent = computeNewContent(currentContent, this.params.fact);
+        const fileName = path.basename(memoryFilePath);
+        const fileDiff = Diff.createPatch(fileName, currentContent, newContent, 'Current', 'Proposed', DEFAULT_DIFF_OPTIONS);
+        const confirmationDetails = {
+            type: 'edit',
+            title: `Confirm Memory Save: ${tildeifyPath(memoryFilePath)}`,
+            fileName: memoryFilePath,
+            filePath: memoryFilePath,
+            fileDiff,
+            originalContent: currentContent,
+            newContent,
+            onConfirm: async (outcome) => {
+                if (outcome === ToolConfirmationOutcome.ProceedAlways) {
+                    MemoryToolInvocation.allowlist.add(allowlistKey);
+                }
+                await this.publishPolicyUpdate(outcome);
+            },
+        };
+        return confirmationDetails;
+    }
+    async execute(_signal) {
+        const { fact, modified_by_user, modified_content } = this.params;
+        try {
+            if (modified_by_user && modified_content !== undefined) {
+                // User modified the content in external editor, write it directly
+                await fs.mkdir(path.dirname(getGlobalMemoryFilePath()), {
+                    recursive: true,
+                });
+                await fs.writeFile(getGlobalMemoryFilePath(), modified_content, 'utf-8');
+                const successMessage = `Okay, I've updated the memory file with your modifications.`;
+                return {
+                    llmContent: JSON.stringify({
+                        success: true,
+                        message: successMessage,
+                    }),
+                    returnDisplay: successMessage,
+                };
+            }
+            else {
+                // Use the normal memory entry logic
+                await MemoryTool.performAddMemoryEntry(fact, getGlobalMemoryFilePath(), {
+                    readFile: fs.readFile,
+                    writeFile: fs.writeFile,
+                    mkdir: fs.mkdir,
+                });
+                const successMessage = `Okay, I've remembered that: "${fact}"`;
+                return {
+                    llmContent: JSON.stringify({
+                        success: true,
+                        message: successMessage,
+                    }),
+                    returnDisplay: successMessage,
+                };
+            }
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : String(error);
+            return {
+                llmContent: JSON.stringify({
+                    success: false,
+                    error: `Failed to save memory. Detail: ${errorMessage}`,
+                }),
+                returnDisplay: `Error saving memory: ${errorMessage}`,
+                error: {
+                    message: errorMessage,
+                    type: ToolErrorType.MEMORY_TOOL_EXECUTION_ERROR,
+                },
+            };
+        }
+    }
+}
+export class MemoryTool extends BaseDeclarativeTool {
+    static Name = MEMORY_TOOL_NAME;
+    constructor(messageBus) {
+        super(MemoryTool.Name, 'SaveMemory', memoryToolDescription, Kind.Think, memoryToolSchemaData.parametersJsonSchema, messageBus, true, false);
+    }
+    validateToolParamValues(params) {
+        if (params.fact.trim() === '') {
+            return 'Parameter "fact" must be a non-empty string.';
+        }
+        return null;
+    }
+    createInvocation(params, messageBus, toolName, displayName) {
+        return new MemoryToolInvocation(params, messageBus, toolName ?? this.name, displayName ?? this.displayName);
+    }
+    static async performAddMemoryEntry(text, memoryFilePath, fsAdapter) {
+        try {
+            await fsAdapter.mkdir(path.dirname(memoryFilePath), { recursive: true });
+            let currentContent = '';
+            try {
+                currentContent = await fsAdapter.readFile(memoryFilePath, 'utf-8');
+            }
+            catch (_e) {
+                // File doesn't exist, which is fine. currentContent will be empty.
+            }
+            const newContent = computeNewContent(currentContent, text);
+            await fsAdapter.writeFile(memoryFilePath, newContent, 'utf-8');
+        }
+        catch (error) {
+            throw new Error(`[MemoryTool] Failed to add memory entry: ${error instanceof Error ? error.message : String(error)}`);
+        }
+    }
+    getModifyContext(_abortSignal) {
+        return {
+            getFilePath: (_params) => getGlobalMemoryFilePath(),
+            getCurrentContent: async (_params) => readMemoryFileContent(),
+            getProposedContent: async (params) => {
+                const currentContent = await readMemoryFileContent();
+                return computeNewContent(currentContent, params.fact);
+            },
+            createUpdatedParams: (_oldContent, modifiedProposedContent, originalParams) => ({
+                ...originalParams,
+                modified_by_user: true,
+                modified_content: modifiedProposedContent,
+            }),
+        };
+    }
+}
+//# sourceMappingURL=memoryTool.js.map

package/dist/src/tools/memoryTool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"memoryTool.js","sourceRoot":"","sources":["../../../src/tools/memoryTool.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EACL,mBAAmB,EACnB,kBAAkB,EAClB,IAAI,EACJ,uBAAuB,GACxB,MAAM,YAAY,CAAC;AAEpB,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACvC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAKjD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAGnD,MAAM,oBAAoB,GAAwB;IAChD,IAAI,EAAE,gBAAgB;IACtB,WAAW,EACT,4OAA4O;IAC9O,oBAAoB,EAAE;QACpB,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,qGAAqG;aACxG;SACF;QACD,QAAQ,EAAE,CAAC,MAAM,CAAC;KACnB;CACF,CAAC;AAEF,MAAM,qBAAqB,GAAG;;;;;;;;;;;;;;;;kPAgBoN,CAAC;AAEnP,MAAM,CAAC,MAAM,wBAAwB,GAAG,WAAW,CAAC;AACpD,MAAM,CAAC,MAAM,qBAAqB,GAAG,0BAA0B,CAAC;AAEhE,yFAAyF;AACzF,wFAAwF;AACxF,IAAI,uBAAuB,GAAsB,wBAAwB,CAAC;AAE1E,MAAM,UAAU,mBAAmB,CAAC,WAA8B;IAChE,IAAI,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;QAC/B,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,uBAAuB,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;SAAM,IAAI,WAAW,IAAI,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACpD,uBAAuB,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC;IAC/C,CAAC;AACH,CAAC;AAED,MAAM,UAAU,0BAA0B;IACxC,IAAI,KAAK,CAAC,OAAO,CAAC,uBAAuB,CAAC,EAAE,CAAC;QAC3C,OAAO,uBAAuB,CAAC,CAAC,CAAC,CAAC;IACpC,CAAC;IACD,OAAO,uBAAuB,CAAC;AACjC,CAAC;AAED,MAAM,UAAU,uBAAuB;IACrC,IAAI,KAAK,CAAC,OAAO,CAAC,uBAAuB,CAAC,EAAE,CAAC;QAC3C,OAAO,uBAAuB,CAAC;IACjC,CAAC;IACD,OAAO,CAAC,uBAAuB,CAAC,CAAC;AACnC,CAAC;AAQD,MAAM,UAAU,uBAAuB;IACrC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,0BAA0B,EAAE,CAAC,CAAC;AAC/E,CAAC;AAED;;GAEG;AACH,SAAS,uBAAuB,CAAC,cAAsB;IACrD,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IAC3C,IAAI,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,cAAc,CAAC,QAAQ,CAAC,UAAU,CAAC;QACxE,OAAO,EAAE,CAAC;IACZ,IAAI,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC;QAClE,OAAO,IAAI,CAAC;IACd,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,qBAAqB;IAClC,IAAI,CAAC;QACH,OAAO,MAAM,EAAE,CAAC,QAAQ,CAAC,uBAAuB,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,KAAK,GAAG,GAAgC,CAAC;QAC/C,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ;YAAE,MAAM,GAAG,CAAC;QACpE,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAS,iBAAiB,CAAC,cAAsB,EAAE,IAAY;IAC7D,IAAI,aAAa,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAChC,aAAa,GAAG,aAAa,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAC9D,MAAM,aAAa,GAAG,KAAK,aAAa,EAAE,CAAC;IAE3C,MAAM,WAAW,GAAG,cAAc,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAElE,IAAI,WAAW,KAAK,CAAC,CAAC,EAAE,CAAC;QACvB,qDAAqD;QACrD,MAAM,SAAS,GAAG,uBAAuB,CAAC,cAAc,CAAC,CAAC;QAC1D,OAAO,CACL,cAAc;YACd,GAAG,SAAS,GAAG,qBAAqB,KAAK,aAAa,IAAI,CAC3D,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,0DAA0D;QAC1D,MAAM,qBAAqB,GAAG,WAAW,GAAG,qBAAqB,CAAC,MAAM,CAAC;QACzE,IAAI,iBAAiB,GAAG,cAAc,CAAC,OAAO,CAC5C,OAAO,EACP,qBAAqB,CACtB,CAAC;QACF,IAAI,iBAAiB,KAAK,CAAC,CAAC,EAAE,CAAC;YAC7B,iBAAiB,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,cAAc;QAC3D,CAAC;QAED,MAAM,mBAAmB,GAAG,cAAc;aACvC,SAAS,CAAC,CAAC,EAAE,qBAAqB,CAAC;aACnC,OAAO,EAAE,CAAC;QACb,IAAI,cAAc,GAAG,cAAc;aAChC,SAAS,CAAC,qBAAqB,EAAE,iBAAiB,CAAC;aACnD,OAAO,EAAE,CAAC;QACb,MAAM,kBAAkB,GAAG,cAAc,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;QAEvE,cAAc,IAAI,KAAK,aAAa,EAAE,CAAC;QACvC,OAAO,CACL,GAAG,mBAAmB,KAAK,cAAc,CAAC,SAAS,EAAE,KAAK,kBAAkB,EAAE,CAAC,OAAO,EAAE;YACxF,IAAI,CACL,CAAC;IACJ,CAAC;AACH,CAAC;AAED,MAAM,oBAAqB,SAAQ,kBAGlC;IACS,MAAM,CAAU,SAAS,GAAgB,IAAI,GAAG,EAAE,CAAC;IAE3D,YACE,MAAwB,EACxB,UAAsB,EACtB,QAAiB,EACjB,WAAoB;QAEpB,KAAK,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;IACnD,CAAC;IAED,cAAc;QACZ,MAAM,cAAc,GAAG,uBAAuB,EAAE,CAAC;QACjD,OAAO,MAAM,YAAY,CAAC,cAAc,CAAC,EAAE,CAAC;IAC9C,CAAC;IAEkB,KAAK,CAAC,sBAAsB,CAC7C,YAAyB;QAEzB,MAAM,cAAc,GAAG,uBAAuB,EAAE,CAAC;QACjD,MAAM,YAAY,GAAG,cAAc,CAAC;QAEpC,IAAI,oBAAoB,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;YACrD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,cAAc,GAAG,MAAM,qBAAqB,EAAE,CAAC;QACrD,MAAM,UAAU,GAAG,iBAAiB,CAAC,cAAc,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAEvE,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;QAC/C,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAC/B,QAAQ,EACR,cAAc,EACd,UAAU,EACV,SAAS,EACT,UAAU,EACV,oBAAoB,CACrB,CAAC;QAEF,MAAM,mBAAmB,GAAgC;YACvD,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,wBAAwB,YAAY,CAAC,cAAc,CAAC,EAAE;YAC7D,QAAQ,EAAE,cAAc;YACxB,QAAQ,EAAE,cAAc;YACxB,QAAQ;YACR,eAAe,EAAE,cAAc;YAC/B,UAAU;YACV,SAAS,EAAE,KAAK,EAAE,OAAgC,EAAE,EAAE;gBACpD,IAAI,OAAO,KAAK,uBAAuB,CAAC,aAAa,EAAE,CAAC;oBACtD,oBAAoB,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;gBACnD,CAAC;gBACD,MAAM,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;YAC1C,CAAC;SACF,CAAC;QACF,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,OAAoB;QAChC,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;QAEjE,IAAI,CAAC;YACH,IAAI,gBAAgB,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;gBACvD,kEAAkE;gBAClE,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,uBAAuB,EAAE,CAAC,EAAE;oBACtD,SAAS,EAAE,IAAI;iBAChB,CAAC,CAAC;gBACH,MAAM,EAAE,CAAC,SAAS,CAChB,uBAAuB,EAAE,EACzB,gBAAgB,EAChB,OAAO,CACR,CAAC;gBACF,MAAM,cAAc,GAAG,6DAA6D,CAAC;gBACrF,OAAO;oBACL,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC;wBACzB,OAAO,EAAE,IAAI;wBACb,OAAO,EAAE,cAAc;qBACxB,CAAC;oBACF,aAAa,EAAE,cAAc;iBAC9B,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,oCAAoC;gBACpC,MAAM,UAAU,CAAC,qBAAqB,CACpC,IAAI,EACJ,uBAAuB,EAAE,EACzB;oBACE,QAAQ,EAAE,EAAE,CAAC,QAAQ;oBACrB,SAAS,EAAE,EAAE,CAAC,SAAS;oBACvB,KAAK,EAAE,EAAE,CAAC,KAAK;iBAChB,CACF,CAAC;gBACF,MAAM,cAAc,GAAG,gCAAgC,IAAI,GAAG,CAAC;gBAC/D,OAAO;oBACL,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC;wBACzB,OAAO,EAAE,IAAI;wBACb,OAAO,EAAE,cAAc;qBACxB,CAAC;oBACF,aAAa,EAAE,cAAc;iBAC9B,CAAC;YACJ,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,YAAY,GAChB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACzD,OAAO;gBACL,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC;oBACzB,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,kCAAkC,YAAY,EAAE;iBACxD,CAAC;gBACF,aAAa,EAAE,wBAAwB,YAAY,EAAE;gBACrD,KAAK,EAAE;oBACL,OAAO,EAAE,YAAY;oBACrB,IAAI,EAAE,aAAa,CAAC,2BAA2B;iBAChD;aACF,CAAC;QACJ,CAAC;IACH,CAAC;;AAGH,MAAM,OAAO,UACX,SAAQ,mBAAiD;IAGzD,MAAM,CAAU,IAAI,GAAG,gBAAgB,CAAC;IAExC,YAAY,UAAsB;QAChC,KAAK,CACH,UAAU,CAAC,IAAI,EACf,YAAY,EACZ,qBAAqB,EACrB,IAAI,CAAC,KAAK,EACV,oBAAoB,CAAC,oBAA+C,EACpE,UAAU,EACV,IAAI,EACJ,KAAK,CACN,CAAC;IACJ,CAAC;IAEkB,uBAAuB,CACxC,MAAwB;QAExB,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YAC9B,OAAO,8CAA8C,CAAC;QACxD,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAES,gBAAgB,CACxB,MAAwB,EACxB,UAAsB,EACtB,QAAiB,EACjB,WAAoB;QAEpB,OAAO,IAAI,oBAAoB,CAC7B,MAAM,EACN,UAAU,EACV,QAAQ,IAAI,IAAI,CAAC,IAAI,EACrB,WAAW,IAAI,IAAI,CAAC,WAAW,CAChC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAChC,IAAY,EACZ,cAAsB,EACtB,SAWC;QAED,IAAI,CAAC;YACH,MAAM,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACzE,IAAI,cAAc,GAAG,EAAE,CAAC;YACxB,IAAI,CAAC;gBACH,cAAc,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;YACrE,CAAC;YAAC,OAAO,EAAE,EAAE,CAAC;gBACZ,mEAAmE;YACrE,CAAC;YAED,MAAM,UAAU,GAAG,iBAAiB,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;YAE3D,MAAM,SAAS,CAAC,SAAS,CAAC,cAAc,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;QACjE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CACb,4CAA4C,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CACrG,CAAC;QACJ,CAAC;IACH,CAAC;IAED,gBAAgB,CAAC,YAAyB;QACxC,OAAO;YACL,WAAW,EAAE,CAAC,OAAyB,EAAE,EAAE,CAAC,uBAAuB,EAAE;YACrE,iBAAiB,EAAE,KAAK,EAAE,OAAyB,EAAmB,EAAE,CACtE,qBAAqB,EAAE;YACzB,kBAAkB,EAAE,KAAK,EAAE,MAAwB,EAAmB,EAAE;gBACtE,MAAM,cAAc,GAAG,MAAM,qBAAqB,EAAE,CAAC;gBACrD,OAAO,iBAAiB,CAAC,cAAc,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;YACxD,CAAC;YACD,mBAAmB,EAAE,CACnB,WAAmB,EACnB,uBAA+B,EAC/B,cAAgC,EACd,EAAE,CAAC,CAAC;gBACtB,GAAG,cAAc;gBACjB,gBAAgB,EAAE,IAAI;gBACtB,gBAAgB,EAAE,uBAAuB;aAC1C,CAAC;SACH,CAAC;IACJ,CAAC"}

package/dist/src/tools/modifiable-tool.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { EditorType } from '../utils/editor.js';
+import type { AnyDeclarativeTool, DeclarativeTool, ToolResult } from './tools.js';
+/**
+ * A declarative tool that supports a modify operation.
+ */
+export interface ModifiableDeclarativeTool<TParams extends object> extends DeclarativeTool<TParams, ToolResult> {
+    getModifyContext(abortSignal: AbortSignal): ModifyContext<TParams>;
+}
+export interface ModifyContext<ToolParams> {
+    getFilePath: (params: ToolParams) => string;
+    getCurrentContent: (params: ToolParams) => Promise<string>;
+    getProposedContent: (params: ToolParams) => Promise<string>;
+    createUpdatedParams: (oldContent: string, modifiedProposedContent: string, originalParams: ToolParams) => ToolParams;
+}
+export interface ModifyResult<ToolParams> {
+    updatedParams: ToolParams;
+    updatedDiff: string;
+}
+export interface ModifyContentOverrides {
+    currentContent?: string | null;
+    proposedContent?: string;
+}
+/**
+ * Type guard to check if a declarative tool is modifiable.
+ */
+export declare function isModifiableDeclarativeTool(tool: AnyDeclarativeTool): tool is ModifiableDeclarativeTool<object>;
+/**
+ * Triggers an external editor for the user to modify the proposed content,
+ * and returns the updated tool parameters and the diff after the user has modified the proposed content.
+ */
+export declare function modifyWithEditor<ToolParams>(originalParams: ToolParams, modifyContext: ModifyContext<ToolParams>, editorType: EditorType, _abortSignal: AbortSignal, overrides?: ModifyContentOverrides): Promise<ModifyResult<ToolParams>>;

package/dist/src/tools/modifiable-tool.js

@@ -0,0 +1,110 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { openDiff } from '../utils/editor.js';
+import os from 'node:os';
+import path from 'node:path';
+import fs from 'node:fs';
+import * as Diff from 'diff';
+import { DEFAULT_DIFF_OPTIONS } from './diffOptions.js';
+import { isNodeError } from '../utils/errors.js';
+import { debugLogger } from '../utils/debugLogger.js';
+/**
+ * Type guard to check if a declarative tool is modifiable.
+ */
+export function isModifiableDeclarativeTool(tool) {
+    return 'getModifyContext' in tool;
+}
+function createTempFilesForModify(currentContent, proposedContent, file_path) {
+    const diffDir = fs.mkdtempSync(path.join(os.tmpdir(), 'gemini-cli-tool-modify-'));
+    try {
+        fs.chmodSync(diffDir, 0o700);
+    }
+    catch (e) {
+        debugLogger.error(`Error setting permissions on temp diff directory: ${diffDir}`, e);
+        throw e;
+    }
+    const ext = path.extname(file_path);
+    const fileName = path.basename(file_path, ext);
+    const timestamp = Date.now();
+    const tempOldPath = path.join(diffDir, `gemini-cli-modify-${fileName}-old-${timestamp}${ext}`);
+    const tempNewPath = path.join(diffDir, `gemini-cli-modify-${fileName}-new-${timestamp}${ext}`);
+    fs.writeFileSync(tempOldPath, currentContent, {
+        encoding: 'utf8',
+        mode: 0o600,
+    });
+    fs.writeFileSync(tempNewPath, proposedContent, {
+        encoding: 'utf8',
+        mode: 0o600,
+    });
+    return { oldPath: tempOldPath, newPath: tempNewPath, dirPath: diffDir };
+}
+function getUpdatedParams(tmpOldPath, tempNewPath, originalParams, modifyContext) {
+    let oldContent = '';
+    let newContent = '';
+    try {
+        oldContent = fs.readFileSync(tmpOldPath, 'utf8');
+    }
+    catch (err) {
+        if (!isNodeError(err) || err.code !== 'ENOENT')
+            throw err;
+        oldContent = '';
+    }
+    try {
+        newContent = fs.readFileSync(tempNewPath, 'utf8');
+    }
+    catch (err) {
+        if (!isNodeError(err) || err.code !== 'ENOENT')
+            throw err;
+        newContent = '';
+    }
+    const updatedParams = modifyContext.createUpdatedParams(oldContent, newContent, originalParams);
+    const updatedDiff = Diff.createPatch(path.basename(modifyContext.getFilePath(originalParams)), oldContent, newContent, 'Current', 'Proposed', DEFAULT_DIFF_OPTIONS);
+    return { updatedParams, updatedDiff };
+}
+function deleteTempFiles(oldPath, newPath, dirPath) {
+    try {
+        fs.unlinkSync(oldPath);
+    }
+    catch {
+        debugLogger.error(`Error deleting temp diff file: ${oldPath}`);
+    }
+    try {
+        fs.unlinkSync(newPath);
+    }
+    catch {
+        debugLogger.error(`Error deleting temp diff file: ${newPath}`);
+    }
+    try {
+        fs.rmdirSync(dirPath);
+    }
+    catch {
+        debugLogger.error(`Error deleting temp diff directory: ${dirPath}`);
+    }
+}
+/**
+ * Triggers an external editor for the user to modify the proposed content,
+ * and returns the updated tool parameters and the diff after the user has modified the proposed content.
+ */
+export async function modifyWithEditor(originalParams, modifyContext, editorType, _abortSignal, overrides) {
+    const hasCurrentOverride = overrides !== undefined && 'currentContent' in overrides;
+    const hasProposedOverride = overrides !== undefined && 'proposedContent' in overrides;
+    const currentContent = hasCurrentOverride
+        ? (overrides.currentContent ?? '')
+        : await modifyContext.getCurrentContent(originalParams);
+    const proposedContent = hasProposedOverride
+        ? (overrides.proposedContent ?? '')
+        : await modifyContext.getProposedContent(originalParams);
+    const { oldPath, newPath, dirPath } = createTempFilesForModify(currentContent ?? '', proposedContent ?? '', modifyContext.getFilePath(originalParams));
+    try {
+        await openDiff(oldPath, newPath, editorType);
+        const result = getUpdatedParams(oldPath, newPath, originalParams, modifyContext);
+        return result;
+    }
+    finally {
+        deleteTempFiles(oldPath, newPath, dirPath);
+    }
+}
+//# sourceMappingURL=modifiable-tool.js.map

package/dist/src/tools/modifiable-tool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"modifiable-tool.js","sourceRoot":"","sources":["../../../src/tools/modifiable-tool.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAMjD,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAkCtD;;GAEG;AACH,MAAM,UAAU,2BAA2B,CACzC,IAAwB;IAExB,OAAO,kBAAkB,IAAI,IAAI,CAAC;AACpC,CAAC;AAED,SAAS,wBAAwB,CAC/B,cAAsB,EACtB,eAAuB,EACvB,SAAiB;IAEjB,MAAM,OAAO,GAAG,EAAE,CAAC,WAAW,CAC5B,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,yBAAyB,CAAC,CAClD,CAAC;IAEF,IAAI,CAAC;QACH,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC/B,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,WAAW,CAAC,KAAK,CACf,qDAAqD,OAAO,EAAE,EAC9D,CAAC,CACF,CAAC;QACF,MAAM,CAAC,CAAC;IACV,CAAC;IAED,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IAC/C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC7B,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAC3B,OAAO,EACP,qBAAqB,QAAQ,QAAQ,SAAS,GAAG,GAAG,EAAE,CACvD,CAAC;IACF,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAC3B,OAAO,EACP,qBAAqB,QAAQ,QAAQ,SAAS,GAAG,GAAG,EAAE,CACvD,CAAC;IAEF,EAAE,CAAC,aAAa,CAAC,WAAW,EAAE,cAAc,EAAE;QAC5C,QAAQ,EAAE,MAAM;QAChB,IAAI,EAAE,KAAK;KACZ,CAAC,CAAC;IACH,EAAE,CAAC,aAAa,CAAC,WAAW,EAAE,eAAe,EAAE;QAC7C,QAAQ,EAAE,MAAM;QAChB,IAAI,EAAE,KAAK;KACZ,CAAC,CAAC;IAEH,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;AAC1E,CAAC;AAED,SAAS,gBAAgB,CACvB,UAAkB,EAClB,WAAmB,EACnB,cAA0B,EAC1B,aAAwC;IAExC,IAAI,UAAU,GAAG,EAAE,CAAC;IACpB,IAAI,UAAU,GAAG,EAAE,CAAC;IAEpB,IAAI,CAAC;QACH,UAAU,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACnD,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ;YAAE,MAAM,GAAG,CAAC;QAC1D,UAAU,GAAG,EAAE,CAAC;IAClB,CAAC;IAED,IAAI,CAAC;QACH,UAAU,GAAG,EAAE,CAAC,YAAY,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ;YAAE,MAAM,GAAG,CAAC;QAC1D,UAAU,GAAG,EAAE,CAAC;IAClB,CAAC;IAED,MAAM,aAAa,GAAG,aAAa,CAAC,mBAAmB,CACrD,UAAU,EACV,UAAU,EACV,cAAc,CACf,CAAC;IACF,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAClC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,EACxD,UAAU,EACV,UAAU,EACV,SAAS,EACT,UAAU,EACV,oBAAoB,CACrB,CAAC;IAEF,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,CAAC;AACxC,CAAC;AAED,SAAS,eAAe,CACtB,OAAe,EACf,OAAe,EACf,OAAe;IAEf,IAAI,CAAC;QACH,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IACzB,CAAC;IAAC,MAAM,CAAC;QACP,WAAW,CAAC,KAAK,CAAC,kCAAkC,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,IAAI,CAAC;QACH,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IACzB,CAAC;IAAC,MAAM,CAAC;QACP,WAAW,CAAC,KAAK,CAAC,kCAAkC,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,IAAI,CAAC;QACH,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACxB,CAAC;IAAC,MAAM,CAAC;QACP,WAAW,CAAC,KAAK,CAAC,uCAAuC,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,cAA0B,EAC1B,aAAwC,EACxC,UAAsB,EACtB,YAAyB,EACzB,SAAkC;IAElC,MAAM,kBAAkB,GACtB,SAAS,KAAK,SAAS,IAAI,gBAAgB,IAAI,SAAS,CAAC;IAC3D,MAAM,mBAAmB,GACvB,SAAS,KAAK,SAAS,IAAI,iBAAiB,IAAI,SAAS,CAAC;IAE5D,MAAM,cAAc,GAAG,kBAAkB;QACvC,CAAC,CAAC,CAAC,SAAS,CAAC,cAAc,IAAI,EAAE,CAAC;QAClC,CAAC,CAAC,MAAM,aAAa,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;IAE1D,MAAM,eAAe,GAAG,mBAAmB;QACzC,CAAC,CAAC,CAAC,SAAS,CAAC,eAAe,IAAI,EAAE,CAAC;QACnC,CAAC,CAAC,MAAM,aAAa,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAC;IAE3D,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,wBAAwB,CAC5D,cAAc,IAAI,EAAE,EACpB,eAAe,IAAI,EAAE,EACrB,aAAa,CAAC,WAAW,CAAC,cAAc,CAAC,CAC1C,CAAC;IAEF,IAAI,CAAC;QACH,MAAM,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAC7C,MAAM,MAAM,GAAG,gBAAgB,CAC7B,OAAO,EACP,OAAO,EACP,cAAc,EACd,aAAa,CACd,CAAC;QAEF,OAAO,MAAM,CAAC;IAChB,CAAC;YAAS,CAAC;QACT,eAAe,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;AACH,CAAC"}

package/dist/src/tools/read-file.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { MessageBus } from '../confirmation-bus/message-bus.js';
+import type { ToolInvocation, ToolResult } from './tools.js';
+import { BaseDeclarativeTool } from './tools.js';
+import type { Config } from '../config/config.js';
+/**
+ * Parameters for the ReadFile tool
+ */
+export interface ReadFileToolParams {
+    /**
+     * The path to the file to read
+     */
+    file_path: string;
+    /**
+     * The line number to start reading from (optional)
+     */
+    offset?: number;
+    /**
+     * The number of lines to read (optional)
+     */
+    limit?: number;
+}
+/**
+ * Implementation of the ReadFile tool logic
+ */
+export declare class ReadFileTool extends BaseDeclarativeTool<ReadFileToolParams, ToolResult> {
+    private config;
+    static readonly Name = "read_file";
+    private readonly fileDiscoveryService;
+    constructor(config: Config, messageBus: MessageBus);
+    protected validateToolParamValues(params: ReadFileToolParams): string | null;
+    protected createInvocation(params: ReadFileToolParams, messageBus: MessageBus, _toolName?: string, _toolDisplayName?: string): ToolInvocation<ReadFileToolParams, ToolResult>;
+}

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

@@ -0,0 +1,141 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import path from 'node:path';
+import { makeRelative, shortenPath } from '../utils/paths.js';
+import { BaseDeclarativeTool, BaseToolInvocation, Kind } from './tools.js';
+import { ToolErrorType } from './tool-error.js';
+import { processSingleFileContent, getSpecificMimeType, } from '../utils/fileUtils.js';
+import { FileOperation } from '../telemetry/metrics.js';
+import { getProgrammingLanguage } from '../telemetry/telemetry-utils.js';
+import { logFileOperation } from '../telemetry/loggers.js';
+import { FileOperationEvent } from '../telemetry/types.js';
+import { READ_FILE_TOOL_NAME } from './tool-names.js';
+import { FileDiscoveryService } from '../services/fileDiscoveryService.js';
+class ReadFileToolInvocation extends BaseToolInvocation {
+    config;
+    resolvedPath;
+    constructor(config, params, messageBus, _toolName, _toolDisplayName) {
+        super(params, messageBus, _toolName, _toolDisplayName);
+        this.config = config;
+        this.resolvedPath = path.resolve(this.config.getTargetDir(), this.params.file_path);
+    }
+    getDescription() {
+        const relativePath = makeRelative(this.resolvedPath, this.config.getTargetDir());
+        return shortenPath(relativePath);
+    }
+    toolLocations() {
+        return [{ path: this.resolvedPath, line: this.params.offset }];
+    }
+    async execute() {
+        const validationError = this.config.validatePathAccess(this.resolvedPath);
+        if (validationError) {
+            return {
+                llmContent: validationError,
+                returnDisplay: 'Path not in workspace.',
+                error: {
+                    message: validationError,
+                    type: ToolErrorType.PATH_NOT_IN_WORKSPACE,
+                },
+            };
+        }
+        const result = await processSingleFileContent(this.resolvedPath, this.config.getTargetDir(), this.config.getFileSystemService(), this.params.offset, this.params.limit);
+        if (result.error) {
+            return {
+                llmContent: result.llmContent,
+                returnDisplay: result.returnDisplay || 'Error reading file',
+                error: {
+                    message: result.error,
+                    type: result.errorType,
+                },
+            };
+        }
+        let llmContent;
+        if (result.isTruncated) {
+            const [start, end] = result.linesShown;
+            const total = result.originalLineCount;
+            const nextOffset = this.params.offset
+                ? this.params.offset + end - start + 1
+                : end;
+            llmContent = `
+IMPORTANT: The file content has been truncated.
+Status: Showing lines ${start}-${end} of ${total} total lines.
+Action: To read more of the file, you can use the 'offset' and 'limit' parameters in a subsequent 'read_file' call. For example, to read the next section of the file, use offset: ${nextOffset}.
+
+--- FILE CONTENT (truncated) ---
+${result.llmContent}`;
+        }
+        else {
+            llmContent = result.llmContent || '';
+        }
+        const lines = typeof result.llmContent === 'string'
+            ? result.llmContent.split('\n').length
+            : undefined;
+        const mimetype = getSpecificMimeType(this.resolvedPath);
+        const programming_language = getProgrammingLanguage({
+            file_path: this.resolvedPath,
+        });
+        logFileOperation(this.config, new FileOperationEvent(READ_FILE_TOOL_NAME, FileOperation.READ, lines, mimetype, path.extname(this.resolvedPath), programming_language));
+        return {
+            llmContent,
+            returnDisplay: result.returnDisplay || '',
+        };
+    }
+}
+/**
+ * Implementation of the ReadFile tool logic
+ */
+export class ReadFileTool extends BaseDeclarativeTool {
+    config;
+    static Name = READ_FILE_TOOL_NAME;
+    fileDiscoveryService;
+    constructor(config, messageBus) {
+        super(ReadFileTool.Name, 'ReadFile', `Reads and returns the content of a specified file. If the file is large, the content will be truncated. The tool's response will clearly indicate if truncation has occurred and will provide details on how to read more of the file using the 'offset' and 'limit' parameters. Handles text, images (PNG, JPG, GIF, WEBP, SVG, BMP), audio files (MP3, WAV, AIFF, AAC, OGG, FLAC), and PDF files. For text files, it can read specific line ranges.`, Kind.Read, {
+            properties: {
+                file_path: {
+                    description: 'The path to the file to read.',
+                    type: 'string',
+                },
+                offset: {
+                    description: "Optional: For text files, the 0-based line number to start reading from. Requires 'limit' to be set. Use for paginating through large files.",
+                    type: 'number',
+                },
+                limit: {
+                    description: "Optional: For text files, maximum number of lines to read. Use with 'offset' to paginate through large files. If omitted, reads the entire file (if feasible, up to a default limit).",
+                    type: 'number',
+                },
+            },
+            required: ['file_path'],
+            type: 'object',
+        }, messageBus, true, false);
+        this.config = config;
+        this.fileDiscoveryService = new FileDiscoveryService(config.getTargetDir(), config.getFileFilteringOptions());
+    }
+    validateToolParamValues(params) {
+        if (params.file_path.trim() === '') {
+            return "The 'file_path' parameter must be non-empty.";
+        }
+        const resolvedPath = path.resolve(this.config.getTargetDir(), params.file_path);
+        const validationError = this.config.validatePathAccess(resolvedPath);
+        if (validationError) {
+            return validationError;
+        }
+        if (params.offset !== undefined && params.offset < 0) {
+            return 'Offset must be a non-negative number';
+        }
+        if (params.limit !== undefined && params.limit <= 0) {
+            return 'Limit must be a positive number';
+        }
+        const fileFilteringOptions = this.config.getFileFilteringOptions();
+        if (this.fileDiscoveryService.shouldIgnoreFile(resolvedPath, fileFilteringOptions)) {
+            return `File path '${resolvedPath}' is ignored by configured ignore patterns.`;
+        }
+        return null;
+    }
+    createInvocation(params, messageBus, _toolName, _toolDisplayName) {
+        return new ReadFileToolInvocation(this.config, params, messageBus, _toolName, _toolDisplayName);
+    }
+}
+//# sourceMappingURL=read-file.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"read-file.js","sourceRoot":"","sources":["../../../src/tools/read-file.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAE9D,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAC3E,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGhD,OAAO,EACL,wBAAwB,EACxB,mBAAmB,GACpB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAsB3E,MAAM,sBAAuB,SAAQ,kBAGpC;IAGW;IAFO,YAAY,CAAS;IACtC,YACU,MAAc,EACtB,MAA0B,EAC1B,UAAsB,EACtB,SAAkB,EAClB,gBAAyB;QAEzB,KAAK,CAAC,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,gBAAgB,CAAC,CAAC;QAN/C,WAAM,GAAN,MAAM,CAAQ;QAOtB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,OAAO,CAC9B,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,EAC1B,IAAI,CAAC,MAAM,CAAC,SAAS,CACtB,CAAC;IACJ,CAAC;IAED,cAAc;QACZ,MAAM,YAAY,GAAG,YAAY,CAC/B,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAC3B,CAAC;QACF,OAAO,WAAW,CAAC,YAAY,CAAC,CAAC;IACnC,CAAC;IAEQ,aAAa;QACpB,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,KAAK,CAAC,OAAO;QACX,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,wBAAwB;gBACvC,KAAK,EAAE;oBACL,OAAO,EAAE,eAAe;oBACxB,IAAI,EAAE,aAAa,CAAC,qBAAqB;iBAC1C;aACF,CAAC;QACJ,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,wBAAwB,CAC3C,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,EAC1B,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,EAClC,IAAI,CAAC,MAAM,CAAC,MAAM,EAClB,IAAI,CAAC,MAAM,CAAC,KAAK,CAClB,CAAC;QAEF,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,OAAO;gBACL,UAAU,EAAE,MAAM,CAAC,UAAU;gBAC7B,aAAa,EAAE,MAAM,CAAC,aAAa,IAAI,oBAAoB;gBAC3D,KAAK,EAAE;oBACL,OAAO,EAAE,MAAM,CAAC,KAAK;oBACrB,IAAI,EAAE,MAAM,CAAC,SAAS;iBACvB;aACF,CAAC;QACJ,CAAC;QAED,IAAI,UAAqB,CAAC;QAC1B,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;YACvB,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,UAAW,CAAC;YACxC,MAAM,KAAK,GAAG,MAAM,CAAC,iBAAkB,CAAC;YACxC,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM;gBACnC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,GAAG,GAAG,KAAK,GAAG,CAAC;gBACtC,CAAC,CAAC,GAAG,CAAC;YACR,UAAU,GAAG;;wBAEK,KAAK,IAAI,GAAG,OAAO,KAAK;qLACqI,UAAU;;;EAG7L,MAAM,CAAC,UAAU,EAAE,CAAC;QAClB,CAAC;aAAM,CAAC;YACN,UAAU,GAAG,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC;QACvC,CAAC;QAED,MAAM,KAAK,GACT,OAAO,MAAM,CAAC,UAAU,KAAK,QAAQ;YACnC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM;YACtC,CAAC,CAAC,SAAS,CAAC;QAChB,MAAM,QAAQ,GAAG,mBAAmB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACxD,MAAM,oBAAoB,GAAG,sBAAsB,CAAC;YAClD,SAAS,EAAE,IAAI,CAAC,YAAY;SAC7B,CAAC,CAAC;QACH,gBAAgB,CACd,IAAI,CAAC,MAAM,EACX,IAAI,kBAAkB,CACpB,mBAAmB,EACnB,aAAa,CAAC,IAAI,EAClB,KAAK,EACL,QAAQ,EACR,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,EAC/B,oBAAoB,CACrB,CACF,CAAC;QAEF,OAAO;YACL,UAAU;YACV,aAAa,EAAE,MAAM,CAAC,aAAa,IAAI,EAAE;SAC1C,CAAC;IACJ,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,mBAGjC;IAKW;IAJV,MAAM,CAAU,IAAI,GAAG,mBAAmB,CAAC;IAC1B,oBAAoB,CAAuB;IAE5D,YACU,MAAc,EACtB,UAAsB;QAEtB,KAAK,CACH,YAAY,CAAC,IAAI,EACjB,UAAU,EACV,ubAAub,EACvb,IAAI,CAAC,IAAI,EACT;YACE,UAAU,EAAE;gBACV,SAAS,EAAE;oBACT,WAAW,EAAE,+BAA+B;oBAC5C,IAAI,EAAE,QAAQ;iBACf;gBACD,MAAM,EAAE;oBACN,WAAW,EACT,8IAA8I;oBAChJ,IAAI,EAAE,QAAQ;iBACf;gBACD,KAAK,EAAE;oBACL,WAAW,EACT,uLAAuL;oBACzL,IAAI,EAAE,QAAQ;iBACf;aACF;YACD,QAAQ,EAAE,CAAC,WAAW,CAAC;YACvB,IAAI,EAAE,QAAQ;SACf,EACD,UAAU,EACV,IAAI,EACJ,KAAK,CACN,CAAC;QA/BM,WAAM,GAAN,MAAM,CAAQ;QAgCtB,IAAI,CAAC,oBAAoB,GAAG,IAAI,oBAAoB,CAClD,MAAM,CAAC,YAAY,EAAE,EACrB,MAAM,CAAC,uBAAuB,EAAE,CACjC,CAAC;IACJ,CAAC;IAEkB,uBAAuB,CACxC,MAA0B;QAE1B,IAAI,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YACnC,OAAO,8CAA8C,CAAC;QACxD,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAC/B,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,EAC1B,MAAM,CAAC,SAAS,CACjB,CAAC;QAEF,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,MAAM,CAAC,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrD,OAAO,sCAAsC,CAAC;QAChD,CAAC;QACD,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,IAAI,CAAC,EAAE,CAAC;YACpD,OAAO,iCAAiC,CAAC;QAC3C,CAAC;QAED,MAAM,oBAAoB,GAAG,IAAI,CAAC,MAAM,CAAC,uBAAuB,EAAE,CAAC;QACnE,IACE,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,CACxC,YAAY,EACZ,oBAAoB,CACrB,EACD,CAAC;YACD,OAAO,cAAc,YAAY,6CAA6C,CAAC;QACjF,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAES,gBAAgB,CACxB,MAA0B,EAC1B,UAAsB,EACtB,SAAkB,EAClB,gBAAyB;QAEzB,OAAO,IAAI,sBAAsB,CAC/B,IAAI,CAAC,MAAM,EACX,MAAM,EACN,UAAU,EACV,SAAS,EACT,gBAAgB,CACjB,CAAC;IACJ,CAAC"}