@aws/lsp-codewhisperer 0.0.32 → 0.0.34

package/out/language-server/agenticChat/tools/fileSearch.js

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileSearch = void 0;
+// FileSearch tool based on ListDirectory implementation
+const toolShared_1 = require("./toolShared");
+const lsp_core_1 = require("@aws/lsp-core");
+const path_1 = require("@aws/lsp-core/out/util/path");
+const constants_1 = require("../../chat/constants");
+class FileSearch {
+    logging;
+    workspace;
+    lsp;
+    constructor(features) {
+        this.logging = features.logging;
+        this.workspace = features.workspace;
+        this.lsp = features.lsp;
+    }
+    async validate(params) {
+        if (params.maxDepth !== undefined && params.maxDepth < 0) {
+            throw new Error('MaxDepth cannot be negative.');
+        }
+        await (0, toolShared_1.validatePath)(params.path, this.workspace.fs.exists);
+        // Validate regex pattern
+        try {
+            new RegExp(params.pattern, params.caseSensitive ? '' : 'i');
+        }
+        catch (error) {
+            throw new Error(`Invalid regex pattern: ${error.message}`);
+        }
+    }
+    async queueDescription(params, updates, requiresAcceptance) {
+        const writer = updates.getWriter();
+        const closeWriter = async (w) => {
+            await w.close();
+            w.releaseLock();
+        };
+        if (!requiresAcceptance) {
+            await writer.write('');
+            await closeWriter(writer);
+            return;
+        }
+        const caseSensitiveText = params.caseSensitive ? 'case-sensitive' : 'case-insensitive';
+        if (params.maxDepth === undefined) {
+            await writer.write(`Searching recursively in ${params.path} for files matching pattern "${params.pattern}" (${caseSensitiveText})`);
+        }
+        else if (params.maxDepth === 0) {
+            await writer.write(`Searching in ${params.path} for files matching pattern "${params.pattern}" (${caseSensitiveText})`);
+        }
+        else {
+            const level = params.maxDepth > 1 ? 'levels' : 'level';
+            await writer.write(`Searching in ${params.path} limited to ${params.maxDepth} subfolder ${level} for files matching pattern "${params.pattern}" (${caseSensitiveText})`);
+        }
+        await closeWriter(writer);
+    }
+    async requiresAcceptance(params, approvedPaths) {
+        return (0, toolShared_1.requiresPathAcceptance)(params.path, this.lsp, this.logging, approvedPaths);
+    }
+    async invoke(params) {
+        const path = (0, path_1.sanitize)(params.path);
+        try {
+            // Get all files and directories
+            const listing = await lsp_core_1.workspaceUtils.readDirectoryRecursively({ workspace: this.workspace, logging: this.logging }, path, { maxDepth: params.maxDepth, excludePatterns: constants_1.DEFAULT_EXCLUDE_PATTERNS });
+            // Create regex pattern for filtering
+            const regex = new RegExp(params.pattern, params.caseSensitive ? '' : 'i');
+            // Filter the results based on the pattern
+            const filteredResults = listing.filter(item => regex.test(item));
+            if (filteredResults.length === 0) {
+                return this.createOutput(`No files matching pattern "${params.pattern}" found in ${path}`);
+            }
+            return this.createOutput(filteredResults.join('\n'));
+        }
+        catch (error) {
+            this.logging.error(`Failed to search directory "${path}": ${error.message || error}`);
+            throw new Error(`Failed to search directory "${path}": ${error.message || error}`);
+        }
+    }
+    createOutput(content) {
+        return {
+            output: {
+                kind: 'text',
+                content: content,
+            },
+        };
+    }
+    getSpec() {
+        return {
+            name: 'fileSearch',
+            description: 'Search for files in a directory and its subdirectories using regex patterns. It filters out build outputs such as `build/`, `out/` and `dist` and dependency directories such as `node_modules/`.\n * Results are filtered by the provided regex pattern.\n * Case sensitivity can be controlled with the caseSensitive parameter.\n * Results clearly distinguish between files, directories or symlinks with [F], [D] and [L] prefixes.',
+            inputSchema: {
+                type: 'object',
+                properties: {
+                    path: {
+                        type: 'string',
+                        description: 'Absolute path to a directory, e.g., `/repo`.',
+                    },
+                    pattern: {
+                        type: 'string',
+                        description: 'Regex pattern to match against file and directory names.',
+                    },
+                    maxDepth: {
+                        type: 'number',
+                        description: 'Maximum depth to traverse when searching directories. Use `0` to search only the specified directory, `1` to include immediate subdirectories, etc. If it is not provided, it will search all subdirectories recursively.',
+                    },
+                    caseSensitive: {
+                        type: 'boolean',
+                        description: 'Whether the pattern matching should be case-sensitive. Defaults to false if not provided.',
+                    },
+                },
+                required: ['path', 'pattern'],
+            },
+        };
+    }
+}
+exports.FileSearch = FileSearch;
+//# sourceMappingURL=fileSearch.js.map

package/out/language-server/agenticChat/tools/fileSearch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileSearch.js","sourceRoot":"","sources":["../../../../src/language-server/agenticChat/tools/fileSearch.ts"],"names":[],"mappings":";;;AAAA,wDAAwD;AACxD,6CAAoG;AACpG,4CAA8C;AAE9C,sDAAsD;AACtD,oDAA+D;AAU/D,MAAa,UAAU;IACF,OAAO,CAAqB;IAC5B,SAAS,CAAuB;IAChC,GAAG,CAAiB;IAErC,YAAY,QAAyD;QACjE,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAA;QAC/B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAA;QACnC,IAAI,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAA;IAC3B,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,MAAwB;QAC1C,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS,IAAI,MAAM,CAAC,QAAQ,GAAG,CAAC,EAAE,CAAC;YACvD,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;QACnD,CAAC;QACD,MAAM,IAAA,yBAAY,EAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,CAAC,CAAA;QAEzD,yBAAyB;QACzB,IAAI,CAAC;YACD,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;QAC/D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,0BAA2B,KAAe,CAAC,OAAO,EAAE,CAAC,CAAA;QACzE,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,MAAwB,EAAE,OAAuB,EAAE,kBAA2B;QACxG,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAA;QAClC,MAAM,WAAW,GAAG,KAAK,EAAE,CAA8B,EAAE,EAAE;YACzD,MAAM,CAAC,CAAC,KAAK,EAAE,CAAA;YACf,CAAC,CAAC,WAAW,EAAE,CAAA;QACnB,CAAC,CAAA;QACD,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACtB,MAAM,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;YACtB,MAAM,WAAW,CAAC,MAAM,CAAC,CAAA;YACzB,OAAM;QACV,CAAC;QAED,MAAM,iBAAiB,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,kBAAkB,CAAA;QACtF,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,MAAM,CAAC,KAAK,CACd,4BAA4B,MAAM,CAAC,IAAI,gCAAgC,MAAM,CAAC,OAAO,MAAM,iBAAiB,GAAG,CAClH,CAAA;QACL,CAAC;aAAM,IAAI,MAAM,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;YAC/B,MAAM,MAAM,CAAC,KAAK,CACd,gBAAgB,MAAM,CAAC,IAAI,gCAAgC,MAAM,CAAC,OAAO,MAAM,iBAAiB,GAAG,CACtG,CAAA;QACL,CAAC;aAAM,CAAC;YACJ,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAA;YACtD,MAAM,MAAM,CAAC,KAAK,CACd,gBAAgB,MAAM,CAAC,IAAI,eAAe,MAAM,CAAC,QAAQ,cAAc,KAAK,gCAAgC,MAAM,CAAC,OAAO,MAAM,iBAAiB,GAAG,CACvJ,CAAA;QACL,CAAC;QACD,MAAM,WAAW,CAAC,MAAM,CAAC,CAAA;IAC7B,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,MAAwB,EAAE,aAA2B;QACjF,OAAO,IAAA,mCAAsB,EAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,CAAA;IACrF,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,MAAwB;QACxC,MAAM,IAAI,GAAG,IAAA,eAAQ,EAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QAClC,IAAI,CAAC;YACD,gCAAgC;YAChC,MAAM,OAAO,GAAG,MAAM,yBAAc,CAAC,wBAAwB,CACzD,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,EACpD,IAAI,EACJ,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,eAAe,EAAE,oCAAwB,EAAE,CAC3E,CAAA;YAED,qCAAqC;YACrC,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;YAEzE,0CAA0C;YAC1C,MAAM,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;YAEhE,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC/B,OAAO,IAAI,CAAC,YAAY,CAAC,8BAA8B,MAAM,CAAC,OAAO,cAAc,IAAI,EAAE,CAAC,CAAA;YAC9F,CAAC;YAED,OAAO,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QACxD,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YAClB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,+BAA+B,IAAI,MAAM,KAAK,CAAC,OAAO,IAAI,KAAK,EAAE,CAAC,CAAA;YACrF,MAAM,IAAI,KAAK,CAAC,+BAA+B,IAAI,MAAM,KAAK,CAAC,OAAO,IAAI,KAAK,EAAE,CAAC,CAAA;QACtF,CAAC;IACL,CAAC;IAEO,YAAY,CAAC,OAAe;QAChC,OAAO;YACH,MAAM,EAAE;gBACJ,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE,OAAO;aACnB;SACJ,CAAA;IACL,CAAC;IAEM,OAAO;QACV,OAAO;YACH,IAAI,EAAE,YAAY;YAClB,WAAW,EACP,2aAA2a;YAC/a,WAAW,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACR,IAAI,EAAE;wBACF,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,8CAA8C;qBAC9D;oBACD,OAAO,EAAE;wBACL,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,0DAA0D;qBAC1E;oBACD,QAAQ,EAAE;wBACN,IAAI,EAAE,QAAQ;wBACd,WAAW,EACP,2NAA2N;qBAClO;oBACD,aAAa,EAAE;wBACX,IAAI,EAAE,SAAS;wBACf,WAAW,EACP,2FAA2F;qBAClG;iBACJ;gBACD,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC;aAChC;SACK,CAAA;IACd,CAAC;CACJ;AA9HD,gCA8HC"}

package/out/language-server/agenticChat/tools/fsRead.d.ts

@@ -1,35 +1,39 @@
-import { InvokeOutput } from './toolShared';
+import { CommandValidation, InvokeOutput } from './toolShared';
 import { Features } from '@aws/language-server-runtimes/server-interface/server';
 export interface FsReadParams {
     path: string;
     readRange?: number[];
 }
 export declare class FsRead {
+    static maxResponseSize: number;
     private readonly logging;
     private readonly workspace;
-    constructor(features: Pick<Features, 'workspace' | 'logging'> & Partial<Features>);
+    private readonly lsp;
+    constructor(features: Pick<Features, 'lsp' | 'workspace' | 'logging'> & Partial<Features>);
+    validate(params: FsReadParams): Promise<void>;
+    queueDescription(params: FsReadParams, updates: WritableStream, requiresAcceptance: boolean): Promise<void>;
+    requiresAcceptance(params: FsReadParams, approvedPaths?: Set<string>): Promise<CommandValidation>;
     invoke(params: FsReadParams): Promise<InvokeOutput>;
     private readFile;
     private handleFileRange;
     private parseLineRange;
-    private enforceMaxSize;
     private createOutput;
     getSpec(): {
         readonly name: "fsRead";
-        readonly description: "A tool for reading a file. \n* This tool returns the contents of a file, and the optional `readRange` determines what range of lines will be read from the specified file.";
+        readonly description: string;
         readonly inputSchema: {
             readonly type: "object";
-            readonly parameters: {
+            readonly properties: {
                 readonly path: {
-                    readonly description: "Absolute path to a file, e.g. `/repo/file.py`.";
+                    readonly description: "Absolute path to a file, e.g. `/repo/file.py` for Unix-like system including Unix/Linux/macOS or `d:\\repo\\file.py` for Windows.";
                     readonly type: "string";
                 };
                 readonly readRange: {
-                    readonly description: "Optional parameter when reading files.\n* If none is given, the full file is shown. If provided, the file will be shown in the indicated line number range, e.g. [11, 12] will show lines 11 and 12. Indexing at 1 to start. Setting `[startLine, -1]` shows all lines from `startLine` to the end of the file.";
+                    readonly description: "Optional parameter when reading files.\n * If none is given, the full file is shown. If provided, the file will be shown in the indicated line number range, e.g. [11, 12] will show lines 11 and 12. Indexing at 1 to start. Setting `[startLine, -1]` shows all lines from `startLine` to the end of the file.";
+                    readonly type: "array";
                     readonly items: {
-                        readonly type: "integer";
+                        readonly type: "number";
                     };
-                    readonly type: "array";
                 };
             };
             readonly required: readonly ["path"];

package/out/language-server/agenticChat/tools/fsRead.js

@@ -1,18 +1,47 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FsRead = void 0;
-/*!
- * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
- * SPDX-License-Identifier: Apache-2.0
- */
 const path_1 = require("@aws/lsp-core/out/util/path");
 const toolShared_1 = require("./toolShared");
 class FsRead {
+    static maxResponseSize = 200_000;
     logging;
     workspace;
+    lsp;
     constructor(features) {
         this.logging = features.logging;
         this.workspace = features.workspace;
+        this.lsp = features.lsp;
+    }
+    async validate(params) {
+        await (0, toolShared_1.validatePath)(params.path, this.workspace.fs.exists);
+    }
+    async queueDescription(params, updates, requiresAcceptance) {
+        const updateWriter = updates.getWriter();
+        const closeWriter = async (w) => {
+            await w.close();
+            w.releaseLock();
+        };
+        if (!requiresAcceptance) {
+            await closeWriter(updateWriter);
+            return;
+        }
+        await updateWriter.write(`Reading file: [${params.path}]`);
+        const [start, end] = params.readRange ?? [];
+        if (start && end) {
+            await updateWriter.write(`from line ${start} to ${end}`);
+        }
+        else if (start) {
+            const msg = start > 0 ? `from line ${start} to end of file` : `${start} line from the end of file to end of file`;
+            await updateWriter.write(msg);
+        }
+        else {
+            await updateWriter.write('all lines');
+        }
+        await closeWriter(updateWriter);
+    }
+    async requiresAcceptance(params, approvedPaths) {
+        return (0, toolShared_1.requiresPathAcceptance)(params.path, this.lsp, this.logging, approvedPaths);
     }
     async invoke(params) {
         const path = (0, path_1.sanitize)(params.path);
@@ -27,7 +56,7 @@ class FsRead {
     handleFileRange(params, fullText) {
         if (!params.readRange || params.readRange.length === 0) {
             this.logging.log('No range provided. returning entire file.');
-            return this.createOutput(this.enforceMaxSize(fullText));
+            return this.createOutput(fullText);
         }
         const lines = fullText.split('\n');
         const [start, end] = this.parseLineRange(lines.length, params.readRange);
@@ -37,7 +66,7 @@ class FsRead {
         }
         this.logging.log(`Reading file: ${params.path}, lines ${start + 1}-${end + 1}`);
         const slice = lines.slice(start, end + 1).join('\n');
-        return this.createOutput(this.enforceMaxSize(slice));
+        return this.createOutput(slice);
     }
     parseLineRange(lineCount, range) {
         const startIdx = range[0];
@@ -52,39 +81,56 @@ class FsRead {
         const finalEnd = Math.max(0, Math.min(lineCount - 1, convert(endIdx)));
         return [finalStart, finalEnd];
     }
-    enforceMaxSize(content) {
-        const byteCount = Buffer.byteLength(content, 'utf8');
-        if (byteCount > toolShared_1.maxToolResponseSize) {
-            throw new Error(`This tool only supports reading ${toolShared_1.maxToolResponseSize} bytes at a time.
-                You tried to read ${byteCount} bytes. Try executing with fewer lines specified.`);
-        }
-        return content;
-    }
     createOutput(content) {
+        const exceedsMaxSize = content.length > FsRead.maxResponseSize;
+        if (exceedsMaxSize) {
+            this.logging.info(`FsRead: truncating response to first ${FsRead.maxResponseSize} characters`);
+            content = content.substring(0, FsRead.maxResponseSize - 3) + '...';
+        }
         return {
             output: {
-                kind: 'text',
-                content: content,
+                kind: 'json',
+                content: {
+                    content,
+                    truncated: exceedsMaxSize,
+                },
             },
         };
     }
     getSpec() {
         return {
             name: 'fsRead',
-            description: 'A tool for reading a file. \n* This tool returns the contents of a file, and the optional `readRange` determines what range of lines will be read from the specified file.',
+            description: 'A tool for reading a file.\n\n' +
+                '## Overview\n' +
+                'This tool returns the contents of a file, with optional line range specification.\n\n' +
+                '## When to use\n' +
+                '- When you need to examine the content of a file\n' +
+                '- When you need to read specific line ranges from a file\n' +
+                '- When you need to analyze code or configuration files\n\n' +
+                '## When not to use\n' +
+                '- When you need to search for patterns across multiple files\n' +
+                '- When you need to process files in binary format\n\n' +
+                '## Notes\n' +
+                '- This tool is more effective than running a command like `head -n` using `executeBash` tool\n' +
+                '- If the file exceeds 200K characters, this tool will only read the first 200K characters of the file with a `truncated=true` in the output\n' +
+                '- For large files (>200K characters), you may need to make multiple calls with specific `readRange` values, but ONLY do this if:\n' +
+                '  * The initial read was truncated (indicated by `truncated=true` in the output)\n' +
+                '  * A specific `readRange` is needed to focus on relevant sections\n' +
+                '  * The user explicitly asks to read more of the file\n' +
+                '- DO NOT re-read the file again using `readRange` unless explicitly asked by the user',
             inputSchema: {
                 type: 'object',
-                parameters: {
+                properties: {
                     path: {
-                        description: 'Absolute path to a file, e.g. `/repo/file.py`.',
+                        description: 'Absolute path to a file, e.g. `/repo/file.py` for Unix-like system including Unix/Linux/macOS or `d:\\repo\\file.py` for Windows.',
                         type: 'string',
                     },
                     readRange: {
-                        description: 'Optional parameter when reading files.\n* If none is given, the full file is shown. If provided, the file will be shown in the indicated line number range, e.g. [11, 12] will show lines 11 and 12. Indexing at 1 to start. Setting `[startLine, -1]` shows all lines from `startLine` to the end of the file.',
+                        description: 'Optional parameter when reading files.\n * If none is given, the full file is shown. If provided, the file will be shown in the indicated line number range, e.g. [11, 12] will show lines 11 and 12. Indexing at 1 to start. Setting `[startLine, -1]` shows all lines from `startLine` to the end of the file.',
+                        type: 'array',
                         items: {
-                            type: 'integer',
+                            type: 'number',
                         },
-                        type: 'array',
                     },
                 },
                 required: ['path'],

package/out/language-server/agenticChat/tools/fsRead.js.map

@@ -1 +1 @@
-{"version":3,"file":"fsRead.js","sourceRoot":"","sources":["../../../../src/language-server/agenticChat/tools/fsRead.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,sDAAsD;AACtD,6CAAgE;AAUhE,MAAa,MAAM;IACE,OAAO,CAAqB;IAC5B,SAAS,CAAuB;IAEjD,YAAY,QAAqE;QAC7E,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAA;QAC/B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAA;IACvC,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,MAAoB;QACpC,MAAM,IAAI,GAAG,IAAA,eAAQ,EAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QAClC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QAC9C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,IAAI,WAAW,YAAY,CAAC,MAAM,EAAE,CAAC,CAAA;QACrE,OAAO,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;IACrD,CAAC;IAEO,KAAK,CAAC,QAAQ,CAAC,QAAgB;QACnC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,QAAQ,EAAE,CAAC,CAAA;QAC9C,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;IACrD,CAAC;IAEO,eAAe,CAAC,MAAoB,EAAE,QAAgB;QAC1D,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2CAA2C,CAAC,CAAA;YAC7D,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAA;QAC3D,CAAC;QAED,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAClC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;QACxE,IAAI,KAAK,GAAG,GAAG,EAAE,CAAC;YACd,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,kBAAkB,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;YAClE,OAAO,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAA;QAChC,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,MAAM,CAAC,IAAI,WAAW,KAAK,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC,CAAA;QAC/E,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACpD,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAA;IACxD,CAAC;IAEO,cAAc,CAAC,SAAiB,EAAE,KAAe;QACrD,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,CAAA;QACzB,IAAI,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QAErD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,GAAG,CAAC,CAAC,CAAA;QACf,CAAC;QAED,MAAM,OAAO,GAAG,CAAC,CAAS,EAAU,EAAE;YAClC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;QACxC,CAAC,CAAA;QAED,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;QAC1E,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;QACtE,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;IACjC,CAAC;IAEO,cAAc,CAAC,OAAe;QAClC,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;QACpD,IAAI,SAAS,GAAG,gCAAmB,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CACX,mCAAmC,gCAAmB;oCAClC,SAAS,mDAAmD,CACnF,CAAA;QACL,CAAC;QACD,OAAO,OAAO,CAAA;IAClB,CAAC;IAEO,YAAY,CAAC,OAAe;QAChC,OAAO;YACH,MAAM,EAAE;gBACJ,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE,OAAO;aACnB;SACJ,CAAA;IACL,CAAC;IAEM,OAAO;QACV,OAAO;YACH,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,4KAA4K;YAChL,WAAW,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACR,IAAI,EAAE;wBACF,WAAW,EAAE,gDAAgD;wBAC7D,IAAI,EAAE,QAAQ;qBACjB;oBACD,SAAS,EAAE;wBACP,WAAW,EACP,iTAAiT;wBACrT,KAAK,EAAE;4BACH,IAAI,EAAE,SAAS;yBAClB;wBACD,IAAI,EAAE,OAAO;qBAChB;iBACJ;gBACD,QAAQ,EAAE,CAAC,MAAM,CAAC;aACrB;SACK,CAAA;IACd,CAAC;CACJ;AArGD,wBAqGC"}
+{"version":3,"file":"fsRead.js","sourceRoot":"","sources":["../../../../src/language-server/agenticChat/tools/fsRead.ts"],"names":[],"mappings":";;;AAAA,sDAAsD;AAEtD,6CAAoG;AAYpG,MAAa,MAAM;IACf,MAAM,CAAC,eAAe,GAAG,OAAO,CAAA;IACf,OAAO,CAAqB;IAC5B,SAAS,CAAuB;IAChC,GAAG,CAAiB;IAErC,YAAY,QAA6E;QACrF,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAA;QAC/B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAA;QACnC,IAAI,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAA;IAC3B,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,MAAoB;QACtC,MAAM,IAAA,yBAAY,EAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,CAAC,CAAA;IAC7D,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,MAAoB,EAAE,OAAuB,EAAE,kBAA2B;QACpG,MAAM,YAAY,GAAG,OAAO,CAAC,SAAS,EAAE,CAAA;QACxC,MAAM,WAAW,GAAG,KAAK,EAAE,CAA8B,EAAE,EAAE;YACzD,MAAM,CAAC,CAAC,KAAK,EAAE,CAAA;YACf,CAAC,CAAC,WAAW,EAAE,CAAA;QACnB,CAAC,CAAA;QACD,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACtB,MAAM,WAAW,CAAC,YAAY,CAAC,CAAA;YAC/B,OAAM;QACV,CAAC;QACD,MAAM,YAAY,CAAC,KAAK,CAAC,kBAAkB,MAAM,CAAC,IAAI,GAAG,CAAC,CAAA;QAE1D,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,SAAS,IAAI,EAAE,CAAA;QAE3C,IAAI,KAAK,IAAI,GAAG,EAAE,CAAC;YACf,MAAM,YAAY,CAAC,KAAK,CAAC,aAAa,KAAK,OAAO,GAAG,EAAE,CAAC,CAAA;QAC5D,CAAC;aAAM,IAAI,KAAK,EAAE,CAAC;YACf,MAAM,GAAG,GACL,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,KAAK,iBAAiB,CAAC,CAAC,CAAC,GAAG,KAAK,2CAA2C,CAAA;YACzG,MAAM,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACjC,CAAC;aAAM,CAAC;YACJ,MAAM,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;QACzC,CAAC;QACD,MAAM,WAAW,CAAC,YAAY,CAAC,CAAA;IACnC,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,MAAoB,EAAE,aAA2B;QAC7E,OAAO,IAAA,mCAAsB,EAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,CAAA;IACrF,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,MAAoB;QACpC,MAAM,IAAI,GAAG,IAAA,eAAQ,EAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QAClC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QAC9C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,IAAI,WAAW,YAAY,CAAC,MAAM,EAAE,CAAC,CAAA;QACrE,OAAO,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;IACrD,CAAC;IAEO,KAAK,CAAC,QAAQ,CAAC,QAAgB;QACnC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,QAAQ,EAAE,CAAC,CAAA;QAC9C,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;IACrD,CAAC;IAEO,eAAe,CAAC,MAAoB,EAAE,QAAgB;QAC1D,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2CAA2C,CAAC,CAAA;YAC7D,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;QACtC,CAAC;QAED,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAClC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;QACxE,IAAI,KAAK,GAAG,GAAG,EAAE,CAAC;YACd,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,kBAAkB,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;YAClE,OAAO,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAA;QAChC,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,MAAM,CAAC,IAAI,WAAW,KAAK,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC,CAAA;QAC/E,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACpD,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAA;IACnC,CAAC;IAEO,cAAc,CAAC,SAAiB,EAAE,KAAe;QACrD,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,CAAA;QACzB,IAAI,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QAErD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,GAAG,CAAC,CAAC,CAAA;QACf,CAAC;QAED,MAAM,OAAO,GAAG,CAAC,CAAS,EAAU,EAAE;YAClC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;QACxC,CAAC,CAAA;QAED,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;QAC1E,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;QACtE,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;IACjC,CAAC;IAEO,YAAY,CAAC,OAAe;QAChC,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,eAAe,CAAA;QAC9D,IAAI,cAAc,EAAE,CAAC;YACjB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wCAAwC,MAAM,CAAC,eAAe,aAAa,CAAC,CAAA;YAC9F,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,eAAe,GAAG,CAAC,CAAC,GAAG,KAAK,CAAA;QACtE,CAAC;QACD,OAAO;YACH,MAAM,EAAE;gBACJ,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE;oBACL,OAAO;oBACP,SAAS,EAAE,cAAc;iBAC5B;aACJ;SACJ,CAAA;IACL,CAAC;IAEM,OAAO;QACV,OAAO;YACH,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,gCAAgC;gBAChC,eAAe;gBACf,uFAAuF;gBACvF,kBAAkB;gBAClB,oDAAoD;gBACpD,4DAA4D;gBAC5D,4DAA4D;gBAC5D,sBAAsB;gBACtB,gEAAgE;gBAChE,uDAAuD;gBACvD,YAAY;gBACZ,gGAAgG;gBAChG,+IAA+I;gBAC/I,oIAAoI;gBACpI,oFAAoF;gBACpF,sEAAsE;gBACtE,yDAAyD;gBACzD,uFAAuF;YAC3F,WAAW,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACR,IAAI,EAAE;wBACF,WAAW,EACP,mIAAmI;wBACvI,IAAI,EAAE,QAAQ;qBACjB;oBACD,SAAS,EAAE;wBACP,WAAW,EACP,kTAAkT;wBACtT,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE;4BACH,IAAI,EAAE,QAAQ;yBACjB;qBACJ;iBACJ;gBACD,QAAQ,EAAE,CAAC,MAAM,CAAC;aACrB;SACK,CAAA;IACd,CAAC;;AAxJL,wBAyJC"}

package/out/language-server/agenticChat/tools/fsWrite.d.ts

@@ -1,12 +1,11 @@
-import { InvokeOutput } from './toolShared';
+import { CommandValidation, ExplanatoryParams, InvokeOutput } from './toolShared';
 import { Features } from '@aws/language-server-runtimes/server-interface/server';
-interface BaseParams {
+interface BaseParams extends ExplanatoryParams {
     path: string;
 }
 export interface CreateParams extends BaseParams {
     command: 'create';
-    fileText?: string;
-    newStr?: string;
+    fileText: string;
 }
 export interface StrReplaceParams extends BaseParams {
     command: 'strReplace';
@@ -23,35 +22,45 @@ export interface AppendParams extends BaseParams {
     newStr: string;
 }
 export type FsWriteParams = CreateParams | StrReplaceParams | InsertParams | AppendParams;
+export interface FsWriteBackup {
+    content: string;
+    isNew: boolean;
+}
 export declare class FsWrite {
     private readonly logging;
     private readonly workspace;
-    constructor(features: Pick<Features, 'workspace' | 'logging'> & Partial<Features>);
+    private readonly lsp;
+    constructor(features: Pick<Features, 'workspace' | 'logging' | 'lsp'> & Partial<Features>);
+    validate(params: FsWriteParams): Promise<void>;
     invoke(params: FsWriteParams): Promise<InvokeOutput>;
+    queueDescription(updates: WritableStream): Promise<void>;
+    requiresAcceptance(params: FsWriteParams, approvedPaths?: Set<string>): Promise<CommandValidation>;
     private handleCreate;
     private handleStrReplace;
     private handleInsert;
     private handleAppend;
-    private getCreateCommandText;
-    private escapeRegExp;
     getSpec(): {
         readonly name: "fsWrite";
-        readonly description: "A tool for creating and editing a file.\n * The `create` command will override the file at `path` if it already exists as a file, and otherwise create a new file\n * The `append` command will add content to the end of an existing file, automatically adding a newline if the file does not end with one. The file must exist.\n Notes for using the `strReplace` command:\n * The `oldStr` parameter should match EXACTLY one or more consecutive lines from the original file. Be mindful of whitespaces!\n * If the `oldStr` parameter is not unique in the file, the replacement will not be performed. Make sure to include enough context in `oldStr` to make it unique\n * The `newStr` parameter should contain the edited lines that should replace the `oldStr`. The `insert` command will insert `newStr` after `insertLine` and place it on its own line.";
+        readonly description: string;
         readonly inputSchema: {
             readonly type: "object";
-            readonly parameters: {
+            readonly properties: {
                 readonly command: {
                     readonly type: "string";
-                    readonly enum: readonly ["create", "strReplace", "insert", "append"];
+                    readonly enum: string[];
                     readonly description: "The commands to run. Allowed options are: `create`, `strReplace`, `insert`, `append`.";
                 };
+                readonly explanation: {
+                    readonly description: "One sentence explanation as to why this tool is being used, and how it contributes to the goal.";
+                    readonly type: "string";
+                };
                 readonly fileText: {
                     readonly description: "Required parameter of `create` command, with the content of the file to be created.";
                     readonly type: "string";
                 };
                 readonly insertLine: {
                     readonly description: "Required parameter of `insert` command. The `newStr` will be inserted AFTER the line `insertLine` of `path`.";
-                    readonly type: "integer";
+                    readonly type: "number";
                 };
                 readonly newStr: {
                     readonly description: "Required parameter of `strReplace` command containing the new string. Required parameter of `insert` command containing the string to insert. Required parameter of `append` command containing the content to append to the file.";
@@ -62,7 +71,7 @@ export declare class FsWrite {
                     readonly type: "string";
                 };
                 readonly path: {
-                    readonly description: "Absolute path to file or directory, e.g. `/repo/file.py` or `/repo`.";
+                    readonly description: "Absolute path to a file, e.g. `/repo/file.py` for Unix-like system including Unix/Linux/macOS or `d:\\repo\\file.py` for Windows.";
                     readonly type: "string";
                 };
             };

package/out/language-server/agenticChat/tools/fsWrite.js

@@ -1,13 +1,59 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FsWrite = void 0;
+const toolShared_1 = require("./toolShared");
 const path_1 = require("@aws/lsp-core/out/util/path");
 class FsWrite {
     logging;
     workspace;
+    lsp;
     constructor(features) {
         this.logging = features.logging;
         this.workspace = features.workspace;
+        this.lsp = features.lsp;
+    }
+    async validate(params) {
+        if (!params.path) {
+            throw new Error('Path must not be empty');
+        }
+        const sanitizedPath = (0, path_1.sanitize)(params.path);
+        switch (params.command) {
+            case 'create': {
+                if (params.fileText === undefined) {
+                    throw new Error('fileText must be provided for create command');
+                }
+                const fileExists = await this.workspace.fs.exists(sanitizedPath);
+                if (fileExists) {
+                    const oldContent = await this.workspace.fs.readFile(sanitizedPath);
+                    if (oldContent === params.fileText) {
+                        throw new Error('The file already exists with the same content');
+                    }
+                }
+                break;
+            }
+            case 'strReplace': {
+                if (params.oldStr === params.newStr) {
+                    throw new Error('The provided oldStr and newStr are the exact same, this is a no-op');
+                }
+                const fileExists = await this.workspace.fs.exists(sanitizedPath);
+                if (!fileExists) {
+                    throw new Error('The provided path must exist in order to replace contents into it');
+                }
+                break;
+            }
+            case 'insert': {
+                const fileExists = await this.workspace.fs.exists(sanitizedPath);
+                if (!fileExists) {
+                    throw new Error('The provided path must exist in order to insert contents into it');
+                }
+                break;
+            }
+            case 'append':
+                if (!params.newStr) {
+                    throw new Error('Content to append must not be empty');
+                }
+                break;
+        }
     }
     async invoke(params) {
         const sanitizedPath = (0, path_1.sanitize)(params.path);
@@ -32,79 +78,82 @@ class FsWrite {
             },
         };
     }
+    async queueDescription(updates) {
+        const updateWriter = updates.getWriter();
+        // Write an empty string because FsWrite should only show a chat message with header
+        await updateWriter.write(' ');
+        await updateWriter.close();
+        updateWriter.releaseLock();
+    }
+    async requiresAcceptance(params, approvedPaths) {
+        return (0, toolShared_1.requiresPathAcceptance)(params.path, this.lsp, this.logging, approvedPaths);
+    }
     async handleCreate(params, sanitizedPath) {
-        const content = this.getCreateCommandText(params);
+        const content = params.fileText;
         await this.workspace.fs.writeFile(sanitizedPath, content);
     }
     async handleStrReplace(params, sanitizedPath) {
         const fileContent = await this.workspace.fs.readFile(sanitizedPath);
-        const matches = [...fileContent.matchAll(new RegExp(this.escapeRegExp(params.oldStr), 'g'))];
-        if (matches.length === 0) {
-            throw new Error(`No occurrences of "${params.oldStr}" were found`);
-        }
-        if (matches.length > 1) {
-            throw new Error(`${matches.length} occurrences of oldStr were found when only 1 is expected`);
-        }
-        const newContent = fileContent.replace(params.oldStr, params.newStr);
+        const newContent = getStrReplaceContent(params, fileContent);
         await this.workspace.fs.writeFile(sanitizedPath, newContent);
     }
     async handleInsert(params, sanitizedPath) {
         const fileContent = await this.workspace.fs.readFile(sanitizedPath);
-        const lines = fileContent.split('\n');
-        const numLines = lines.length;
-        const insertLine = Math.max(0, Math.min(params.insertLine, numLines));
-        let newContent;
-        if (insertLine === 0) {
-            newContent = params.newStr + '\n' + fileContent;
-        }
-        else {
-            newContent = [...lines.slice(0, insertLine), params.newStr, ...lines.slice(insertLine)].join('\n');
-        }
+        const newContent = getInsertContent(params, fileContent);
         await this.workspace.fs.writeFile(sanitizedPath, newContent);
     }
     async handleAppend(params, sanitizedPath) {
         const fileContent = await this.workspace.fs.readFile(sanitizedPath);
-        const needsNewline = fileContent.length !== 0 && !fileContent.endsWith('\n');
-        let contentToAppend = params.newStr;
-        if (needsNewline) {
-            contentToAppend = '\n' + contentToAppend;
-        }
-        const newContent = fileContent + contentToAppend;
+        const newContent = getAppendContent(params, fileContent);
         await this.workspace.fs.writeFile(sanitizedPath, newContent);
     }
-    getCreateCommandText(params) {
-        if (params.fileText) {
-            return params.fileText;
-        }
-        if (params.newStr) {
-            this.logging.warn('Required field `fileText` is missing, use the provided `newStr` instead');
-            return params.newStr;
-        }
-        this.logging.warn('No content provided for the create command');
-        return '';
-    }
-    escapeRegExp(string) {
-        return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
-    }
     getSpec() {
+        const commands = ['create', 'strReplace', 'insert', 'append'];
         return {
             name: 'fsWrite',
-            description: 'A tool for creating and editing a file.\n * The `create` command will override the file at `path` if it already exists as a file, and otherwise create a new file\n * The `append` command will add content to the end of an existing file, automatically adding a newline if the file does not end with one. The file must exist.\n Notes for using the `strReplace` command:\n * The `oldStr` parameter should match EXACTLY one or more consecutive lines from the original file. Be mindful of whitespaces!\n * If the `oldStr` parameter is not unique in the file, the replacement will not be performed. Make sure to include enough context in `oldStr` to make it unique\n * The `newStr` parameter should contain the edited lines that should replace the `oldStr`. The `insert` command will insert `newStr` after `insertLine` and place it on its own line.',
+            description: 'A tool for creating and editing a file.\n\n' +
+                '## Overview\n' +
+                'This tool provides multiple commands for file operations including creating, replacing, inserting, and appending content.\n\n' +
+                '## When to use\n' +
+                '- When creating new files (create)\n' +
+                '- When replacing specific text in existing files (strReplace)\n' +
+                '- When inserting text at a specific line (insert)\n' +
+                '- When adding text to the end of a file (append)\n\n' +
+                '## When not to use\n' +
+                '- When you only need to read file content (use fsRead instead)\n' +
+                '- When you need to delete a file (no delete operation is available)\n' +
+                '- When you need to rename or move a file\n\n' +
+                '## Command details\n' +
+                '- The `create` command will override the file at `path` if it already exists as a file, and otherwise create a new file. Use this command for initial file creation, such as scaffolding a new project. You should also use this command when overwriting large boilerplate files where you want to replace the entire content at once.\n' +
+                '- The `insert` command will insert `newStr` after `insertLine` and place it on its own line.\n' +
+                '- The `append` command will add content to the end of an existing file, automatically adding a newline if the file does not end with one.\n' +
+                '- The `strReplace` command will replace `oldStr` in an existing file with `newStr`.\n\n' +
+                '## IMPORTANT Notes for using the `strReplace` command\n' +
+                '- Use this command to delete code by using empty `newStr` parameter.\n' +
+                '- If you need to make small changes to an existing file, consider using `strReplace` command to avoid unnecessary rewriting the entire file.\n' +
+                '- Prefer the `create` command if the complexity or number of changes would make `strReplace` unwieldy or error-prone.\n' +
+                '- The `oldStr` parameter should match EXACTLY one or more consecutive lines from the original file. Be mindful of whitespaces! Include just the changing lines, and a few surrounding lines if needed for uniqueness. Do not include long runs of unchanging lines in `oldStr`.\n' +
+                '- The `newStr` parameter should contain the edited lines that should replace the `oldStr`.\n' +
+                '- When multiple edits to the same file are needed, combine them into a single call whenever possible. This improves efficiency by reducing the number of tool calls and ensures the file remains in a consistent state.',
             inputSchema: {
                 type: 'object',
-                parameters: {
+                properties: {
                     command: {
                         type: 'string',
-                        enum: ['create', 'strReplace', 'insert', 'append'],
+                        enum: commands,
                         description: 'The commands to run. Allowed options are: `create`, `strReplace`, `insert`, `append`.',
                     },
+                    explanation: {
+                        description: 'One sentence explanation as to why this tool is being used, and how it contributes to the goal.',
+                        type: 'string',
+                    },
                     fileText: {
                         description: 'Required parameter of `create` command, with the content of the file to be created.',
                         type: 'string',
                     },
                     insertLine: {
                         description: 'Required parameter of `insert` command. The `newStr` will be inserted AFTER the line `insertLine` of `path`.',
-                        type: 'integer',
+                        type: 'number',
                     },
                     newStr: {
                         description: 'Required parameter of `strReplace` command containing the new string. Required parameter of `insert` command containing the string to insert. Required parameter of `append` command containing the content to append to the file.',
@@ -115,7 +164,7 @@ class FsWrite {
                         type: 'string',
                     },
                     path: {
-                        description: 'Absolute path to file or directory, e.g. `/repo/file.py` or `/repo`.',
+                        description: 'Absolute path to a file, e.g. `/repo/file.py` for Unix-like system including Unix/Linux/macOS or `d:\\repo\\file.py` for Windows.',
                         type: 'string',
                     },
                 },
@@ -125,4 +174,38 @@ class FsWrite {
     }
 }
 exports.FsWrite = FsWrite;
+const getAppendContent = (params, oldContent) => {
+    const needsNewline = oldContent.length !== 0 && !oldContent.endsWith('\n');
+    let contentToAppend = params.newStr;
+    if (needsNewline) {
+        contentToAppend = '\n' + contentToAppend;
+    }
+    return oldContent + contentToAppend;
+};
+const getInsertContent = (params, oldContent) => {
+    const lines = oldContent.split('\n');
+    const numLines = lines.length;
+    const insertLine = Math.max(0, Math.min(params.insertLine, numLines));
+    let newContent;
+    if (insertLine === 0) {
+        newContent = params.newStr + '\n' + oldContent;
+    }
+    else {
+        newContent = [...lines.slice(0, insertLine), params.newStr, ...lines.slice(insertLine)].join('\n');
+    }
+    return newContent;
+};
+const getStrReplaceContent = (params, oldContent) => {
+    const matches = [...oldContent.matchAll(new RegExp(escapeRegExp(params.oldStr), 'g'))];
+    if (matches.length === 0) {
+        throw new Error(`No occurrences of "${params.oldStr}" were found`);
+    }
+    if (matches.length > 1) {
+        throw new Error(`${matches.length} occurrences of oldStr were found when only 1 is expected`);
+    }
+    return oldContent.replace(params.oldStr, params.newStr);
+};
+const escapeRegExp = (string) => {
+    return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+};
 //# sourceMappingURL=fsWrite.js.map