@google/gemini-cli-core 0.1.0-development.1

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

@@ -0,0 +1,103 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import path from 'path';
+import { SchemaValidator } from '../utils/schemaValidator.js';
+import { makeRelative, shortenPath } from '../utils/paths.js';
+import { BaseTool } from './tools.js';
+import { isWithinRoot, processSingleFileContent, getSpecificMimeType, } from '../utils/fileUtils.js';
+import { recordFileOperationMetric, FileOperation, } from '../telemetry/metrics.js';
+/**
+ * Implementation of the ReadFile tool logic
+ */
+export class ReadFileTool extends BaseTool {
+    rootDirectory;
+    config;
+    static Name = 'read_file';
+    constructor(rootDirectory, config) {
+        super(ReadFileTool.Name, 'ReadFile', 'Reads and returns the content of a specified file from the local filesystem. Handles text, images (PNG, JPG, GIF, WEBP, SVG, BMP), and PDF files. For text files, it can read specific line ranges.', {
+            properties: {
+                absolute_path: {
+                    description: "The absolute path to the file to read (e.g., '/home/user/project/file.txt'). Relative paths are not supported. You must provide an absolute path.",
+                    type: 'string',
+                    pattern: '^/',
+                },
+                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: ['absolute_path'],
+            type: 'object',
+        });
+        this.rootDirectory = rootDirectory;
+        this.config = config;
+        this.rootDirectory = path.resolve(rootDirectory);
+    }
+    validateToolParams(params) {
+        if (this.schema.parameters &&
+            !SchemaValidator.validate(this.schema.parameters, params)) {
+            return 'Parameters failed schema validation.';
+        }
+        const filePath = params.absolute_path;
+        if (!path.isAbsolute(filePath)) {
+            return `File path must be absolute, but was relative: ${filePath}. You must provide an absolute path.`;
+        }
+        if (!isWithinRoot(filePath, this.rootDirectory)) {
+            return `File path must be within the root directory (${this.rootDirectory}): ${filePath}`;
+        }
+        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 fileService = this.config.getFileService();
+        if (fileService.shouldGeminiIgnoreFile(params.absolute_path)) {
+            const relativePath = makeRelative(params.absolute_path, this.rootDirectory);
+            return `File path '${shortenPath(relativePath)}' is ignored by .geminiignore pattern(s).`;
+        }
+        return null;
+    }
+    getDescription(params) {
+        if (!params ||
+            typeof params.absolute_path !== 'string' ||
+            params.absolute_path.trim() === '') {
+            return `Path unavailable`;
+        }
+        const relativePath = makeRelative(params.absolute_path, this.rootDirectory);
+        return shortenPath(relativePath);
+    }
+    async execute(params, _signal) {
+        const validationError = this.validateToolParams(params);
+        if (validationError) {
+            return {
+                llmContent: `Error: Invalid parameters provided. Reason: ${validationError}`,
+                returnDisplay: validationError,
+            };
+        }
+        const result = await processSingleFileContent(params.absolute_path, this.rootDirectory, params.offset, params.limit);
+        if (result.error) {
+            return {
+                llmContent: result.error, // The detailed error for LLM
+                returnDisplay: result.returnDisplay, // User-friendly error
+            };
+        }
+        const lines = typeof result.llmContent === 'string'
+            ? result.llmContent.split('\n').length
+            : undefined;
+        const mimetype = getSpecificMimeType(params.absolute_path);
+        recordFileOperationMetric(this.config, FileOperation.READ, lines, mimetype, path.extname(params.absolute_path));
+        return {
+            llmContent: result.llmContent,
+            returnDisplay: result.returnDisplay,
+        };
+    }
+}
+//# 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;AAEH,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,QAAQ,EAAc,MAAM,YAAY,CAAC;AAClD,OAAO,EACL,YAAY,EACZ,wBAAwB,EACxB,mBAAmB,GACpB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EACL,yBAAyB,EACzB,aAAa,GACd,MAAM,yBAAyB,CAAC;AAsBjC;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,QAAwC;IAI9D;IACA;IAJV,MAAM,CAAU,IAAI,GAAW,WAAW,CAAC;IAE3C,YACU,aAAqB,EACrB,MAAc;QAEtB,KAAK,CACH,YAAY,CAAC,IAAI,EACjB,UAAU,EACV,qMAAqM,EACrM;YACE,UAAU,EAAE;gBACV,aAAa,EAAE;oBACb,WAAW,EACT,mJAAmJ;oBACrJ,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,IAAI;iBACd;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,eAAe,CAAC;YAC3B,IAAI,EAAE,QAAQ;SACf,CACF,CAAC;QA7BM,kBAAa,GAAb,aAAa,CAAQ;QACrB,WAAM,GAAN,MAAM,CAAQ;QA6BtB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IACnD,CAAC;IAED,kBAAkB,CAAC,MAA0B;QAC3C,IACE,IAAI,CAAC,MAAM,CAAC,UAAU;YACtB,CAAC,eAAe,CAAC,QAAQ,CACvB,IAAI,CAAC,MAAM,CAAC,UAAqC,EACjD,MAAM,CACP,EACD,CAAC;YACD,OAAO,sCAAsC,CAAC;QAChD,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,CAAC,aAAa,CAAC;QACtC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC/B,OAAO,iDAAiD,QAAQ,sCAAsC,CAAC;QACzG,CAAC;QACD,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;YAChD,OAAO,gDAAgD,IAAI,CAAC,aAAa,MAAM,QAAQ,EAAE,CAAC;QAC5F,CAAC;QACD,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,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;QACjD,IAAI,WAAW,CAAC,sBAAsB,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;YAC7D,MAAM,YAAY,GAAG,YAAY,CAC/B,MAAM,CAAC,aAAa,EACpB,IAAI,CAAC,aAAa,CACnB,CAAC;YACF,OAAO,cAAc,WAAW,CAAC,YAAY,CAAC,2CAA2C,CAAC;QAC5F,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,cAAc,CAAC,MAA0B;QACvC,IACE,CAAC,MAAM;YACP,OAAO,MAAM,CAAC,aAAa,KAAK,QAAQ;YACxC,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,EAAE,EAClC,CAAC;YACD,OAAO,kBAAkB,CAAC;QAC5B,CAAC;QACD,MAAM,YAAY,GAAG,YAAY,CAAC,MAAM,CAAC,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAC5E,OAAO,WAAW,CAAC,YAAY,CAAC,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,OAAO,CACX,MAA0B,EAC1B,OAAoB;QAEpB,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACxD,IAAI,eAAe,EAAE,CAAC;YACpB,OAAO;gBACL,UAAU,EAAE,+CAA+C,eAAe,EAAE;gBAC5E,aAAa,EAAE,eAAe;aAC/B,CAAC;QACJ,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,wBAAwB,CAC3C,MAAM,CAAC,aAAa,EACpB,IAAI,CAAC,aAAa,EAClB,MAAM,CAAC,MAAM,EACb,MAAM,CAAC,KAAK,CACb,CAAC;QAEF,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,OAAO;gBACL,UAAU,EAAE,MAAM,CAAC,KAAK,EAAE,6BAA6B;gBACvD,aAAa,EAAE,MAAM,CAAC,aAAa,EAAE,sBAAsB;aAC5D,CAAC;QACJ,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,MAAM,CAAC,aAAa,CAAC,CAAC;QAC3D,yBAAyB,CACvB,IAAI,CAAC,MAAM,EACX,aAAa,CAAC,IAAI,EAClB,KAAK,EACL,QAAQ,EACR,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CACnC,CAAC;QAEF,OAAO;YACL,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,aAAa,EAAE,MAAM,CAAC,aAAa;SACpC,CAAC;IACJ,CAAC"}

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

@@ -0,0 +1,6 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export {};

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

@@ -0,0 +1,180 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { vi, describe, it, expect, beforeEach, afterEach } from 'vitest';
+import { ReadFileTool } from './read-file.js';
+import * as fileUtils from '../utils/fileUtils.js';
+import path from 'path';
+import os from 'os';
+import fs from 'fs'; // For actual fs operations in setup
+import { FileDiscoveryService } from '../services/fileDiscoveryService.js';
+// Mock fileUtils.processSingleFileContent
+vi.mock('../utils/fileUtils', async () => {
+    const actualFileUtils = await vi.importActual('../utils/fileUtils');
+    return {
+        ...actualFileUtils, // Spread actual implementations
+        processSingleFileContent: vi.fn(), // Mock specific function
+    };
+});
+const mockProcessSingleFileContent = fileUtils.processSingleFileContent;
+describe('ReadFileTool', () => {
+    let tempRootDir;
+    let tool;
+    const abortSignal = new AbortController().signal;
+    beforeEach(() => {
+        // Create a unique temporary root directory for each test run
+        tempRootDir = fs.mkdtempSync(path.join(os.tmpdir(), 'read-file-tool-root-'));
+        fs.writeFileSync(path.join(tempRootDir, '.geminiignore'), ['foo.*'].join('\n'));
+        const fileService = new FileDiscoveryService(tempRootDir);
+        const mockConfigInstance = {
+            getFileService: () => fileService,
+        };
+        tool = new ReadFileTool(tempRootDir, mockConfigInstance);
+        mockProcessSingleFileContent.mockReset();
+    });
+    afterEach(() => {
+        // Clean up the temporary root directory
+        if (fs.existsSync(tempRootDir)) {
+            fs.rmSync(tempRootDir, { recursive: true, force: true });
+        }
+    });
+    describe('validateToolParams', () => {
+        it('should return null for valid params (absolute path within root)', () => {
+            const params = {
+                absolute_path: path.join(tempRootDir, 'test.txt'),
+            };
+            expect(tool.validateToolParams(params)).toBeNull();
+        });
+        it('should return null for valid params with offset and limit', () => {
+            const params = {
+                absolute_path: path.join(tempRootDir, 'test.txt'),
+                offset: 0,
+                limit: 10,
+            };
+            expect(tool.validateToolParams(params)).toBeNull();
+        });
+        it('should return error for relative path', () => {
+            const params = { absolute_path: 'test.txt' };
+            expect(tool.validateToolParams(params)).toMatch(/File path must be absolute/);
+        });
+        it('should return error for path outside root', () => {
+            const outsidePath = path.resolve(os.tmpdir(), 'outside-root.txt');
+            const params = { absolute_path: outsidePath };
+            expect(tool.validateToolParams(params)).toMatch(/File path must be within the root directory/);
+        });
+        it('should return error for negative offset', () => {
+            const params = {
+                absolute_path: path.join(tempRootDir, 'test.txt'),
+                offset: -1,
+                limit: 10,
+            };
+            expect(tool.validateToolParams(params)).toBe('Offset must be a non-negative number');
+        });
+        it('should return error for non-positive limit', () => {
+            const paramsZero = {
+                absolute_path: path.join(tempRootDir, 'test.txt'),
+                offset: 0,
+                limit: 0,
+            };
+            expect(tool.validateToolParams(paramsZero)).toBe('Limit must be a positive number');
+            const paramsNegative = {
+                absolute_path: path.join(tempRootDir, 'test.txt'),
+                offset: 0,
+                limit: -5,
+            };
+            expect(tool.validateToolParams(paramsNegative)).toBe('Limit must be a positive number');
+        });
+        it('should return error for schema validation failure (e.g. missing path)', () => {
+            const params = { offset: 0 };
+            expect(tool.validateToolParams(params)).toBe('Parameters failed schema validation.');
+        });
+    });
+    describe('getDescription', () => {
+        it('should return a shortened, relative path', () => {
+            const filePath = path.join(tempRootDir, 'sub', 'dir', 'file.txt');
+            const params = { absolute_path: filePath };
+            // Assuming tempRootDir is something like /tmp/read-file-tool-root-XXXXXX
+            // The relative path would be sub/dir/file.txt
+            expect(tool.getDescription(params)).toBe('sub/dir/file.txt');
+        });
+        it('should return . if path is the root directory', () => {
+            const params = { absolute_path: tempRootDir };
+            expect(tool.getDescription(params)).toBe('.');
+        });
+    });
+    describe('execute', () => {
+        it('should return validation error if params are invalid', async () => {
+            const params = { absolute_path: 'relative/path.txt' };
+            const result = await tool.execute(params, abortSignal);
+            expect(result.llmContent).toMatch(/Error: Invalid parameters provided/);
+            expect(result.returnDisplay).toMatch(/File path must be absolute/);
+        });
+        it('should return error from processSingleFileContent if it fails', async () => {
+            const filePath = path.join(tempRootDir, 'error.txt');
+            const params = { absolute_path: filePath };
+            const errorMessage = 'Simulated read error';
+            mockProcessSingleFileContent.mockResolvedValue({
+                llmContent: `Error reading file ${filePath}: ${errorMessage}`,
+                returnDisplay: `Error reading file ${filePath}: ${errorMessage}`,
+                error: errorMessage,
+            });
+            const result = await tool.execute(params, abortSignal);
+            expect(mockProcessSingleFileContent).toHaveBeenCalledWith(filePath, tempRootDir, undefined, undefined);
+            expect(result.llmContent).toContain(errorMessage);
+            expect(result.returnDisplay).toContain(errorMessage);
+        });
+        it('should return success result for a text file', async () => {
+            const filePath = path.join(tempRootDir, 'textfile.txt');
+            const fileContent = 'This is a test file.';
+            const params = { absolute_path: filePath };
+            mockProcessSingleFileContent.mockResolvedValue({
+                llmContent: fileContent,
+                returnDisplay: `Read text file: ${path.basename(filePath)}`,
+            });
+            const result = await tool.execute(params, abortSignal);
+            expect(mockProcessSingleFileContent).toHaveBeenCalledWith(filePath, tempRootDir, undefined, undefined);
+            expect(result.llmContent).toBe(fileContent);
+            expect(result.returnDisplay).toBe(`Read text file: ${path.basename(filePath)}`);
+        });
+        it('should return success result for an image file', async () => {
+            const filePath = path.join(tempRootDir, 'image.png');
+            const imageData = {
+                inlineData: { mimeType: 'image/png', data: 'base64...' },
+            };
+            const params = { absolute_path: filePath };
+            mockProcessSingleFileContent.mockResolvedValue({
+                llmContent: imageData,
+                returnDisplay: `Read image file: ${path.basename(filePath)}`,
+            });
+            const result = await tool.execute(params, abortSignal);
+            expect(mockProcessSingleFileContent).toHaveBeenCalledWith(filePath, tempRootDir, undefined, undefined);
+            expect(result.llmContent).toEqual(imageData);
+            expect(result.returnDisplay).toBe(`Read image file: ${path.basename(filePath)}`);
+        });
+        it('should pass offset and limit to processSingleFileContent', async () => {
+            const filePath = path.join(tempRootDir, 'paginated.txt');
+            const params = {
+                absolute_path: filePath,
+                offset: 10,
+                limit: 5,
+            };
+            mockProcessSingleFileContent.mockResolvedValue({
+                llmContent: 'some lines',
+                returnDisplay: 'Read text file (paginated)',
+            });
+            await tool.execute(params, abortSignal);
+            expect(mockProcessSingleFileContent).toHaveBeenCalledWith(filePath, tempRootDir, 10, 5);
+        });
+        it('should return error if path is ignored by a .geminiignore pattern', async () => {
+            const params = {
+                absolute_path: path.join(tempRootDir, 'foo.bar'),
+            };
+            const result = await tool.execute(params, abortSignal);
+            expect(result.returnDisplay).toContain('foo.bar');
+            expect(result.returnDisplay).not.toContain('foo.baz');
+        });
+    });
+});
+//# sourceMappingURL=read-file.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"read-file.test.js","sourceRoot":"","sources":["../../../src/tools/read-file.test.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAQ,MAAM,QAAQ,CAAC;AAC/E,OAAO,EAAE,YAAY,EAAsB,MAAM,gBAAgB,CAAC;AAClE,OAAO,KAAK,SAAS,MAAM,uBAAuB,CAAC;AACnD,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAE,MAAM,IAAI,CAAC,CAAC,oCAAoC;AAEzD,OAAO,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAE3E,0CAA0C;AAC1C,EAAE,CAAC,IAAI,CAAC,oBAAoB,EAAE,KAAK,IAAI,EAAE;IACvC,MAAM,eAAe,GACnB,MAAM,EAAE,CAAC,YAAY,CAAmB,oBAAoB,CAAC,CAAC;IAChE,OAAO;QACL,GAAG,eAAe,EAAE,gCAAgC;QACpD,wBAAwB,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,yBAAyB;KAC7D,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,MAAM,4BAA4B,GAAG,SAAS,CAAC,wBAAgC,CAAC;AAEhF,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,IAAI,WAAmB,CAAC;IACxB,IAAI,IAAkB,CAAC;IACvB,MAAM,WAAW,GAAG,IAAI,eAAe,EAAE,CAAC,MAAM,CAAC;IAEjD,UAAU,CAAC,GAAG,EAAE;QACd,6DAA6D;QAC7D,WAAW,GAAG,EAAE,CAAC,WAAW,CAC1B,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,sBAAsB,CAAC,CAC/C,CAAC;QACF,EAAE,CAAC,aAAa,CACd,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,eAAe,CAAC,EACvC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CACrB,CAAC;QACF,MAAM,WAAW,GAAG,IAAI,oBAAoB,CAAC,WAAW,CAAC,CAAC;QAC1D,MAAM,kBAAkB,GAAG;YACzB,cAAc,EAAE,GAAG,EAAE,CAAC,WAAW;SACb,CAAC;QACvB,IAAI,GAAG,IAAI,YAAY,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAC;QACzD,4BAA4B,CAAC,SAAS,EAAE,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,wCAAwC;QACxC,IAAI,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YAC/B,EAAE,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;YACzE,MAAM,MAAM,GAAuB;gBACjC,aAAa,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC;aAClD,CAAC;YACF,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;QACrD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;YACnE,MAAM,MAAM,GAAuB;gBACjC,aAAa,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC;gBACjD,MAAM,EAAE,CAAC;gBACT,KAAK,EAAE,EAAE;aACV,CAAC;YACF,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;QACrD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;YAC/C,MAAM,MAAM,GAAuB,EAAE,aAAa,EAAE,UAAU,EAAE,CAAC;YACjE,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAC7C,4BAA4B,CAC7B,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;YACnD,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,kBAAkB,CAAC,CAAC;YAClE,MAAM,MAAM,GAAuB,EAAE,aAAa,EAAE,WAAW,EAAE,CAAC;YAClE,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAC7C,6CAA6C,CAC9C,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;YACjD,MAAM,MAAM,GAAuB;gBACjC,aAAa,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC;gBACjD,MAAM,EAAE,CAAC,CAAC;gBACV,KAAK,EAAE,EAAE;aACV,CAAC;YACF,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAC1C,sCAAsC,CACvC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,MAAM,UAAU,GAAuB;gBACrC,aAAa,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC;gBACjD,MAAM,EAAE,CAAC;gBACT,KAAK,EAAE,CAAC;aACT,CAAC;YACF,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAC9C,iCAAiC,CAClC,CAAC;YACF,MAAM,cAAc,GAAuB;gBACzC,aAAa,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC;gBACjD,MAAM,EAAE,CAAC;gBACT,KAAK,EAAE,CAAC,CAAC;aACV,CAAC;YACF,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAClD,iCAAiC,CAClC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uEAAuE,EAAE,GAAG,EAAE;YAC/E,MAAM,MAAM,GAAG,EAAE,MAAM,EAAE,CAAC,EAAmC,CAAC;YAC9D,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAC1C,sCAAsC,CACvC,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;YAClD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;YAClE,MAAM,MAAM,GAAuB,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC;YAC/D,yEAAyE;YACzE,8CAA8C;YAC9C,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAC/D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;YACvD,MAAM,MAAM,GAAuB,EAAE,aAAa,EAAE,WAAW,EAAE,CAAC;YAClE,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;QACvB,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;YACpE,MAAM,MAAM,GAAuB,EAAE,aAAa,EAAE,mBAAmB,EAAE,CAAC;YAC1E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;YACvD,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,oCAAoC,CAAC,CAAC;YACxE,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,4BAA4B,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+DAA+D,EAAE,KAAK,IAAI,EAAE;YAC7E,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YACrD,MAAM,MAAM,GAAuB,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC;YAC/D,MAAM,YAAY,GAAG,sBAAsB,CAAC;YAC5C,4BAA4B,CAAC,iBAAiB,CAAC;gBAC7C,UAAU,EAAE,sBAAsB,QAAQ,KAAK,YAAY,EAAE;gBAC7D,aAAa,EAAE,sBAAsB,QAAQ,KAAK,YAAY,EAAE;gBAChE,KAAK,EAAE,YAAY;aACpB,CAAC,CAAC;YAEH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;YACvD,MAAM,CAAC,4BAA4B,CAAC,CAAC,oBAAoB,CACvD,QAAQ,EACR,WAAW,EACX,SAAS,EACT,SAAS,CACV,CAAC;YACF,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;YAClD,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;YAC5D,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;YACxD,MAAM,WAAW,GAAG,sBAAsB,CAAC;YAC3C,MAAM,MAAM,GAAuB,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC;YAC/D,4BAA4B,CAAC,iBAAiB,CAAC;gBAC7C,UAAU,EAAE,WAAW;gBACvB,aAAa,EAAE,mBAAmB,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;aAC5D,CAAC,CAAC;YAEH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;YACvD,MAAM,CAAC,4BAA4B,CAAC,CAAC,oBAAoB,CACvD,QAAQ,EACR,WAAW,EACX,SAAS,EACT,SAAS,CACV,CAAC;YACF,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC5C,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAC/B,mBAAmB,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAC7C,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;YAC9D,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YACrD,MAAM,SAAS,GAAG;gBAChB,UAAU,EAAE,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW,EAAE;aACzD,CAAC;YACF,MAAM,MAAM,GAAuB,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC;YAC/D,4BAA4B,CAAC,iBAAiB,CAAC;gBAC7C,UAAU,EAAE,SAAS;gBACrB,aAAa,EAAE,oBAAoB,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;aAC7D,CAAC,CAAC;YAEH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;YACvD,MAAM,CAAC,4BAA4B,CAAC,CAAC,oBAAoB,CACvD,QAAQ,EACR,WAAW,EACX,SAAS,EACT,SAAS,CACV,CAAC;YACF,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC7C,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAC/B,oBAAoB,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAC9C,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;YACxE,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC;YACzD,MAAM,MAAM,GAAuB;gBACjC,aAAa,EAAE,QAAQ;gBACvB,MAAM,EAAE,EAAE;gBACV,KAAK,EAAE,CAAC;aACT,CAAC;YACF,4BAA4B,CAAC,iBAAiB,CAAC;gBAC7C,UAAU,EAAE,YAAY;gBACxB,aAAa,EAAE,4BAA4B;aAC5C,CAAC,CAAC;YAEH,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;YACxC,MAAM,CAAC,4BAA4B,CAAC,CAAC,oBAAoB,CACvD,QAAQ,EACR,WAAW,EACX,EAAE,EACF,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mEAAmE,EAAE,KAAK,IAAI,EAAE;YACjF,MAAM,MAAM,GAAuB;gBACjC,aAAa,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC;aACjD,CAAC;YACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;YACvD,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;YAClD,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/src/tools/read-many-files.d.ts

@@ -0,0 +1,65 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { BaseTool, ToolResult } from './tools.js';
+import { Config } from '../config/config.js';
+/**
+ * Parameters for the ReadManyFilesTool.
+ */
+export interface ReadManyFilesParams {
+    /**
+     * An array of file paths or directory paths to search within.
+     * Paths are relative to the tool's configured target directory.
+     * Glob patterns can be used directly in these paths.
+     */
+    paths: string[];
+    /**
+     * Optional. Glob patterns for files to include.
+     * These are effectively combined with the `paths`.
+     * Example: ["*.ts", "src/** /*.md"]
+     */
+    include?: string[];
+    /**
+     * Optional. Glob patterns for files/directories to exclude.
+     * Applied as ignore patterns.
+     * Example: ["*.log", "dist/**"]
+     */
+    exclude?: string[];
+    /**
+     * Optional. Search directories recursively.
+     * This is generally controlled by glob patterns (e.g., `**`).
+     * The glob implementation is recursive by default for `**`.
+     * For simplicity, we'll rely on `**` for recursion.
+     */
+    recursive?: boolean;
+    /**
+     * Optional. Apply default exclusion patterns. Defaults to true.
+     */
+    useDefaultExcludes?: boolean;
+    /**
+     * Optional. Whether to respect .gitignore patterns. Defaults to true.
+     */
+    respect_git_ignore?: boolean;
+}
+/**
+ * Tool implementation for finding and reading multiple text files from the local filesystem
+ * within a specified target directory. The content is concatenated.
+ * It is intended to run in an environment with access to the local file system (e.g., a Node.js backend).
+ */
+export declare class ReadManyFilesTool extends BaseTool<ReadManyFilesParams, ToolResult> {
+    readonly targetDir: string;
+    private config;
+    static readonly Name: string;
+    private readonly geminiIgnorePatterns;
+    /**
+     * Creates an instance of ReadManyFilesTool.
+     * @param targetDir The absolute root directory within which this tool is allowed to operate.
+     * All paths provided in `params` will be resolved relative to this directory.
+     */
+    constructor(targetDir: string, config: Config);
+    validateParams(params: ReadManyFilesParams): string | null;
+    getDescription(params: ReadManyFilesParams): string;
+    execute(params: ReadManyFilesParams, signal: AbortSignal): Promise<ToolResult>;
+}