@vybestack/llxprt-code-core 0.1.12

package/dist/src/tools/tool-registry.test.js

@@ -0,0 +1,398 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { describe, it, expect, vi, beforeEach, afterEach, } from 'vitest';
+import { ToolRegistry, sanitizeParameters, } from './tool-registry.js';
+import { DiscoveredMCPTool } from './mcp-tool.js';
+import { Config, ApprovalMode } from '../config/config.js';
+import { BaseTool } from './tools.js';
+import { mcpToTool, Type, } from '@google/genai';
+import { spawn } from 'node:child_process';
+// Use vi.hoisted to define the mock function so it can be used in the vi.mock factory
+const mockDiscoverMcpTools = vi.hoisted(() => vi.fn());
+// Mock ./mcp-client.js to control its behavior within tool-registry tests
+vi.mock('./mcp-client.js', () => ({
+    discoverMcpTools: mockDiscoverMcpTools,
+}));
+// Mock node:child_process
+vi.mock('node:child_process', async () => {
+    const actual = await vi.importActual('node:child_process');
+    return {
+        ...actual,
+        execSync: vi.fn(),
+        spawn: vi.fn(),
+    };
+});
+// Mock MCP SDK Client and Transports
+const mockMcpClientConnect = vi.fn();
+const mockMcpClientOnError = vi.fn();
+const mockStdioTransportClose = vi.fn();
+const mockSseTransportClose = vi.fn();
+vi.mock('@modelcontextprotocol/sdk/client/index.js', () => {
+    const MockClient = vi.fn().mockImplementation(() => ({
+        connect: mockMcpClientConnect,
+        set onerror(handler) {
+            mockMcpClientOnError(handler);
+        },
+    }));
+    return { Client: MockClient };
+});
+vi.mock('@modelcontextprotocol/sdk/client/stdio.js', () => {
+    const MockStdioClientTransport = vi.fn().mockImplementation(() => ({
+        stderr: {
+            on: vi.fn(),
+        },
+        close: mockStdioTransportClose,
+    }));
+    return { StdioClientTransport: MockStdioClientTransport };
+});
+vi.mock('@modelcontextprotocol/sdk/client/sse.js', () => {
+    const MockSSEClientTransport = vi.fn().mockImplementation(() => ({
+        close: mockSseTransportClose,
+    }));
+    return { SSEClientTransport: MockSSEClientTransport };
+});
+// Mock @google/genai mcpToTool
+vi.mock('@google/genai', async () => {
+    const actualGenai = await vi.importActual('@google/genai');
+    return {
+        ...actualGenai,
+        mcpToTool: vi.fn().mockImplementation(() => ({
+            tool: vi.fn().mockResolvedValue({ functionDeclarations: [] }),
+            callTool: vi.fn(),
+        })),
+    };
+});
+// Helper to create a mock CallableTool for specific test needs
+const createMockCallableTool = (toolDeclarations) => ({
+    tool: vi.fn().mockResolvedValue({ functionDeclarations: toolDeclarations }),
+    callTool: vi.fn(),
+});
+class MockTool extends BaseTool {
+    constructor(name = 'mock-tool', description = 'A mock tool') {
+        super(name, name, description, {
+            type: Type.OBJECT,
+            properties: {
+                param: { type: Type.STRING },
+            },
+            required: ['param'],
+        });
+    }
+    async execute(params) {
+        return {
+            llmContent: `Executed with ${params.param}`,
+            returnDisplay: `Executed with ${params.param}`,
+        };
+    }
+}
+const baseConfigParams = {
+    cwd: '/tmp',
+    model: 'test-model',
+    embeddingModel: 'test-embedding-model',
+    sandbox: undefined,
+    targetDir: '/test/dir',
+    debugMode: false,
+    userMemory: '',
+    llxprtMdFileCount: 0,
+    approvalMode: ApprovalMode.DEFAULT,
+    sessionId: 'test-session-id',
+};
+describe('ToolRegistry', () => {
+    let config;
+    let toolRegistry;
+    let mockConfigGetToolDiscoveryCommand;
+    beforeEach(() => {
+        config = new Config(baseConfigParams);
+        toolRegistry = new ToolRegistry(config);
+        vi.spyOn(console, 'warn').mockImplementation(() => { });
+        vi.spyOn(console, 'error').mockImplementation(() => { });
+        vi.spyOn(console, 'debug').mockImplementation(() => { });
+        vi.spyOn(console, 'log').mockImplementation(() => { });
+        mockMcpClientConnect.mockReset().mockResolvedValue(undefined);
+        mockStdioTransportClose.mockReset();
+        mockSseTransportClose.mockReset();
+        vi.mocked(mcpToTool).mockClear();
+        vi.mocked(mcpToTool).mockReturnValue(createMockCallableTool([]));
+        mockConfigGetToolDiscoveryCommand = vi.spyOn(config, 'getToolDiscoveryCommand');
+        vi.spyOn(config, 'getMcpServers');
+        vi.spyOn(config, 'getMcpServerCommand');
+        mockDiscoverMcpTools.mockReset().mockResolvedValue(undefined);
+    });
+    afterEach(() => {
+        vi.restoreAllMocks();
+    });
+    describe('registerTool', () => {
+        it('should register a new tool', () => {
+            const tool = new MockTool();
+            toolRegistry.registerTool(tool);
+            expect(toolRegistry.getTool('mock-tool')).toBe(tool);
+        });
+    });
+    describe('getToolsByServer', () => {
+        it('should return an empty array if no tools match the server name', () => {
+            toolRegistry.registerTool(new MockTool());
+            expect(toolRegistry.getToolsByServer('any-mcp-server')).toEqual([]);
+        });
+        it('should return only tools matching the server name', async () => {
+            const server1Name = 'mcp-server-uno';
+            const server2Name = 'mcp-server-dos';
+            const mockCallable = {};
+            const mcpTool1 = new DiscoveredMCPTool(mockCallable, server1Name, 'server1Name__tool-on-server1', 'd1', {}, 'tool-on-server1');
+            const mcpTool2 = new DiscoveredMCPTool(mockCallable, server2Name, 'server2Name__tool-on-server2', 'd2', {}, 'tool-on-server2');
+            const nonMcpTool = new MockTool('regular-tool');
+            toolRegistry.registerTool(mcpTool1);
+            toolRegistry.registerTool(mcpTool2);
+            toolRegistry.registerTool(nonMcpTool);
+            const toolsFromServer1 = toolRegistry.getToolsByServer(server1Name);
+            expect(toolsFromServer1).toHaveLength(1);
+            expect(toolsFromServer1[0].name).toBe(mcpTool1.name);
+            const toolsFromServer2 = toolRegistry.getToolsByServer(server2Name);
+            expect(toolsFromServer2).toHaveLength(1);
+            expect(toolsFromServer2[0].name).toBe(mcpTool2.name);
+        });
+    });
+    describe('discoverTools', () => {
+        it('should sanitize tool parameters during discovery from command', async () => {
+            const discoveryCommand = 'my-discovery-command';
+            mockConfigGetToolDiscoveryCommand.mockReturnValue(discoveryCommand);
+            const unsanitizedToolDeclaration = {
+                name: 'tool-with-bad-format',
+                description: 'A tool with an invalid format property',
+                parameters: {
+                    type: Type.OBJECT,
+                    properties: {
+                        some_string: {
+                            type: Type.STRING,
+                            format: 'uuid', // This is an unsupported format
+                        },
+                    },
+                },
+            };
+            const mockSpawn = vi.mocked(spawn);
+            const mockChildProcess = {
+                stdout: { on: vi.fn() },
+                stderr: { on: vi.fn() },
+                on: vi.fn(),
+            };
+            mockSpawn.mockReturnValue(mockChildProcess);
+            // Simulate stdout data
+            mockChildProcess.stdout.on.mockImplementation((event, callback) => {
+                if (event === 'data') {
+                    callback(Buffer.from(JSON.stringify([
+                        { function_declarations: [unsanitizedToolDeclaration] },
+                    ])));
+                }
+                return mockChildProcess;
+            });
+            // Simulate process close
+            mockChildProcess.on.mockImplementation((event, callback) => {
+                if (event === 'close') {
+                    callback(0);
+                }
+                return mockChildProcess;
+            });
+            await toolRegistry.discoverTools();
+            const discoveredTool = toolRegistry.getTool('tool-with-bad-format');
+            expect(discoveredTool).toBeDefined();
+            const registeredParams = discoveredTool.schema
+                .parameters;
+            expect(registeredParams.properties?.['some_string']).toBeDefined();
+            expect(registeredParams.properties?.['some_string']).toHaveProperty('format', undefined);
+        });
+        it('should discover tools using MCP servers defined in getMcpServers', async () => {
+            mockConfigGetToolDiscoveryCommand.mockReturnValue(undefined);
+            vi.spyOn(config, 'getMcpServerCommand').mockReturnValue(undefined);
+            const mcpServerConfigVal = {
+                'my-mcp-server': {
+                    command: 'mcp-server-cmd',
+                    args: ['--port', '1234'],
+                    trust: true,
+                },
+            };
+            vi.spyOn(config, 'getMcpServers').mockReturnValue(mcpServerConfigVal);
+            await toolRegistry.discoverTools();
+            expect(mockDiscoverMcpTools).toHaveBeenCalledWith(mcpServerConfigVal, undefined, toolRegistry, false);
+        });
+        it('should discover tools using MCP servers defined in getMcpServers', async () => {
+            mockConfigGetToolDiscoveryCommand.mockReturnValue(undefined);
+            vi.spyOn(config, 'getMcpServerCommand').mockReturnValue(undefined);
+            const mcpServerConfigVal = {
+                'my-mcp-server': {
+                    command: 'mcp-server-cmd',
+                    args: ['--port', '1234'],
+                    trust: true,
+                },
+            };
+            vi.spyOn(config, 'getMcpServers').mockReturnValue(mcpServerConfigVal);
+            await toolRegistry.discoverTools();
+            expect(mockDiscoverMcpTools).toHaveBeenCalledWith(mcpServerConfigVal, undefined, toolRegistry, false);
+        });
+    });
+});
+describe('sanitizeParameters', () => {
+    it('should remove default when anyOf is present', () => {
+        const schema = {
+            anyOf: [{ type: Type.STRING }, { type: Type.NUMBER }],
+            default: 'hello',
+        };
+        sanitizeParameters(schema);
+        expect(schema.default).toBeUndefined();
+    });
+    it('should recursively sanitize items in anyOf', () => {
+        const schema = {
+            anyOf: [
+                {
+                    anyOf: [{ type: Type.STRING }],
+                    default: 'world',
+                },
+                { type: Type.NUMBER },
+            ],
+        };
+        sanitizeParameters(schema);
+        expect(schema.anyOf[0].default).toBeUndefined();
+    });
+    it('should recursively sanitize items in items', () => {
+        const schema = {
+            items: {
+                anyOf: [{ type: Type.STRING }],
+                default: 'world',
+            },
+        };
+        sanitizeParameters(schema);
+        expect(schema.items.default).toBeUndefined();
+    });
+    it('should recursively sanitize items in properties', () => {
+        const schema = {
+            properties: {
+                prop1: {
+                    anyOf: [{ type: Type.STRING }],
+                    default: 'world',
+                },
+            },
+        };
+        sanitizeParameters(schema);
+        expect(schema.properties.prop1.default).toBeUndefined();
+    });
+    it('should handle complex nested schemas', () => {
+        const schema = {
+            properties: {
+                prop1: {
+                    items: {
+                        anyOf: [{ type: Type.STRING }],
+                        default: 'world',
+                    },
+                },
+                prop2: {
+                    anyOf: [
+                        {
+                            properties: {
+                                nestedProp: {
+                                    anyOf: [{ type: Type.NUMBER }],
+                                    default: 123,
+                                },
+                            },
+                        },
+                    ],
+                },
+            },
+        };
+        sanitizeParameters(schema);
+        expect(schema.properties.prop1.items.default).toBeUndefined();
+        const nestedProp = schema.properties.prop2.anyOf[0].properties.nestedProp;
+        expect(nestedProp?.default).toBeUndefined();
+    });
+    it('should remove unsupported format from a simple string property', () => {
+        const schema = {
+            type: Type.OBJECT,
+            properties: {
+                name: { type: Type.STRING },
+                id: { type: Type.STRING, format: 'uuid' },
+            },
+        };
+        sanitizeParameters(schema);
+        expect(schema.properties?.['id']).toHaveProperty('format', undefined);
+        expect(schema.properties?.['name']).not.toHaveProperty('format');
+    });
+    it('should NOT remove supported format values', () => {
+        const schema = {
+            type: Type.OBJECT,
+            properties: {
+                date: { type: Type.STRING, format: 'date-time' },
+                role: {
+                    type: Type.STRING,
+                    format: 'enum',
+                    enum: ['admin', 'user'],
+                },
+            },
+        };
+        const originalSchema = JSON.parse(JSON.stringify(schema));
+        sanitizeParameters(schema);
+        expect(schema).toEqual(originalSchema);
+    });
+    it('should handle arrays of objects', () => {
+        const schema = {
+            type: Type.OBJECT,
+            properties: {
+                items: {
+                    type: Type.ARRAY,
+                    items: {
+                        type: Type.OBJECT,
+                        properties: {
+                            itemId: { type: Type.STRING, format: 'uuid' },
+                        },
+                    },
+                },
+            },
+        };
+        sanitizeParameters(schema);
+        expect(schema.properties?.['items']?.items?.properties?.['itemId']).toHaveProperty('format', undefined);
+    });
+    it('should handle schemas with no properties to sanitize', () => {
+        const schema = {
+            type: Type.OBJECT,
+            properties: {
+                count: { type: Type.NUMBER },
+                isActive: { type: Type.BOOLEAN },
+            },
+        };
+        const originalSchema = JSON.parse(JSON.stringify(schema));
+        sanitizeParameters(schema);
+        expect(schema).toEqual(originalSchema);
+    });
+    it('should not crash on an empty or undefined schema', () => {
+        expect(() => sanitizeParameters({})).not.toThrow();
+        expect(() => sanitizeParameters(undefined)).not.toThrow();
+    });
+    it('should handle complex nested schemas with cycles', () => {
+        const userNode = {
+            type: Type.OBJECT,
+            properties: {
+                id: { type: Type.STRING, format: 'uuid' },
+                name: { type: Type.STRING },
+                manager: {
+                    type: Type.OBJECT,
+                    properties: {
+                        id: { type: Type.STRING, format: 'uuid' },
+                    },
+                },
+            },
+        };
+        userNode.properties.reports = {
+            type: Type.ARRAY,
+            items: userNode,
+        };
+        const schema = {
+            type: Type.OBJECT,
+            properties: {
+                ceo: userNode,
+            },
+        };
+        expect(() => sanitizeParameters(schema)).not.toThrow();
+        expect(schema.properties?.['ceo']?.properties?.['id']).toHaveProperty('format', undefined);
+        expect(schema.properties?.['ceo']?.properties?.['manager']?.properties?.['id']).toHaveProperty('format', undefined);
+    });
+});
+//# sourceMappingURL=tool-registry.test.js.map

package/dist/src/tools/tool-registry.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tool-registry.test.js","sourceRoot":"","sources":["../../../src/tools/tool-registry.test.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,uDAAuD;AACvD,OAAO,EACL,QAAQ,EACR,EAAE,EACF,MAAM,EACN,EAAE,EACF,UAAU,EACV,SAAS,GAEV,MAAM,QAAQ,CAAC;AAChB,OAAO,EACL,YAAY,EAEZ,kBAAkB,GACnB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EAAE,MAAM,EAAoB,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAC7E,OAAO,EAAE,QAAQ,EAAc,MAAM,YAAY,CAAC;AAClD,OAAO,EAGL,SAAS,EACT,IAAI,GAEL,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAE3C,sFAAsF;AACtF,MAAM,oBAAoB,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;AAEvD,0EAA0E;AAC1E,EAAE,CAAC,IAAI,CAAC,iBAAiB,EAAE,GAAG,EAAE,CAAC,CAAC;IAChC,gBAAgB,EAAE,oBAAoB;CACvC,CAAC,CAAC,CAAC;AAEJ,0BAA0B;AAC1B,EAAE,CAAC,IAAI,CAAC,oBAAoB,EAAE,KAAK,IAAI,EAAE;IACvC,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,YAAY,CAAC,oBAAoB,CAAC,CAAC;IAC3D,OAAO;QACL,GAAG,MAAM;QACT,QAAQ,EAAE,EAAE,CAAC,EAAE,EAAE;QACjB,KAAK,EAAE,EAAE,CAAC,EAAE,EAAE;KACf,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,qCAAqC;AACrC,MAAM,oBAAoB,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;AACrC,MAAM,oBAAoB,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;AACrC,MAAM,uBAAuB,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;AACxC,MAAM,qBAAqB,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;AAEtC,EAAE,CAAC,IAAI,CAAC,2CAA2C,EAAE,GAAG,EAAE;IACxD,MAAM,UAAU,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,CAAC;QACnD,OAAO,EAAE,oBAAoB;QAC7B,IAAI,OAAO,CAAC,OAAY;YACtB,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAChC,CAAC;KACF,CAAC,CAAC,CAAC;IACJ,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;AAChC,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,IAAI,CAAC,2CAA2C,EAAE,GAAG,EAAE;IACxD,MAAM,wBAAwB,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,CAAC;QACjE,MAAM,EAAE;YACN,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE;SACZ;QACD,KAAK,EAAE,uBAAuB;KAC/B,CAAC,CAAC,CAAC;IACJ,OAAO,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,CAAC;AAC5D,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,IAAI,CAAC,yCAAyC,EAAE,GAAG,EAAE;IACtD,MAAM,sBAAsB,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,CAAC;QAC/D,KAAK,EAAE,qBAAqB;KAC7B,CAAC,CAAC,CAAC;IACJ,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,CAAC;AACxD,CAAC,CAAC,CAAC;AAEH,+BAA+B;AAC/B,EAAE,CAAC,IAAI,CAAC,eAAe,EAAE,KAAK,IAAI,EAAE;IAClC,MAAM,WAAW,GACf,MAAM,EAAE,CAAC,YAAY,CAAiC,eAAe,CAAC,CAAC;IACzE,OAAO;QACL,GAAG,WAAW;QACd,SAAS,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,CAAC;YAC3C,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,oBAAoB,EAAE,EAAE,EAAE,CAAC;YAC7D,QAAQ,EAAE,EAAE,CAAC,EAAE,EAAE;SAClB,CAAC,CAAC;KACJ,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,+DAA+D;AAC/D,MAAM,sBAAsB,GAAG,CAC7B,gBAAuC,EACjB,EAAE,CAAC,CAAC;IAC1B,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,CAAC;IAC3E,QAAQ,EAAE,EAAE,CAAC,EAAE,EAAE;CAClB,CAAC,CAAC;AAEH,MAAM,QAAS,SAAQ,QAAuC;IAC5D,YAAY,IAAI,GAAG,WAAW,EAAE,WAAW,GAAG,aAAa;QACzD,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE;YAC7B,IAAI,EAAE,IAAI,CAAC,MAAM;YACjB,UAAU,EAAE;gBACV,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE;aAC7B;YACD,QAAQ,EAAE,CAAC,OAAO,CAAC;SACpB,CAAC,CAAC;IACL,CAAC;IACD,KAAK,CAAC,OAAO,CAAC,MAAyB;QACrC,OAAO;YACL,UAAU,EAAE,iBAAiB,MAAM,CAAC,KAAK,EAAE;YAC3C,aAAa,EAAE,iBAAiB,MAAM,CAAC,KAAK,EAAE;SAC/C,CAAC;IACJ,CAAC;CACF;AAED,MAAM,gBAAgB,GAAqB;IACzC,GAAG,EAAE,MAAM;IACX,KAAK,EAAE,YAAY;IACnB,cAAc,EAAE,sBAAsB;IACtC,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;IACtB,SAAS,EAAE,KAAK;IAChB,UAAU,EAAE,EAAE;IACd,iBAAiB,EAAE,CAAC;IACpB,YAAY,EAAE,YAAY,CAAC,OAAO;IAClC,SAAS,EAAE,iBAAiB;CAC7B,CAAC;AAEF,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,IAAI,MAAc,CAAC;IACnB,IAAI,YAA0B,CAAC;IAC/B,IAAI,iCAA8D,CAAC;IAEnE,UAAU,CAAC,GAAG,EAAE;QACd,MAAM,GAAG,IAAI,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACtC,YAAY,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC;QACxC,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QACvD,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QACxD,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QACxD,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QAEtD,oBAAoB,CAAC,SAAS,EAAE,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAC9D,uBAAuB,CAAC,SAAS,EAAE,CAAC;QACpC,qBAAqB,CAAC,SAAS,EAAE,CAAC;QAClC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,CAAC;QACjC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,sBAAsB,CAAC,EAAE,CAAC,CAAC,CAAC;QAEjE,iCAAiC,GAAG,EAAE,CAAC,KAAK,CAC1C,MAAM,EACN,yBAAyB,CAC1B,CAAC;QACF,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;QAClC,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;QACxC,oBAAoB,CAAC,SAAS,EAAE,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,eAAe,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC5B,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;YACpC,MAAM,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC5B,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;YAChC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;YACxE,YAAY,CAAC,YAAY,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC;YAC1C,MAAM,CAAC,YAAY,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACtE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;YACjE,MAAM,WAAW,GAAG,gBAAgB,CAAC;YACrC,MAAM,WAAW,GAAG,gBAAgB,CAAC;YACrC,MAAM,YAAY,GAAG,EAAkB,CAAC;YACxC,MAAM,QAAQ,GAAG,IAAI,iBAAiB,CACpC,YAAY,EACZ,WAAW,EACX,8BAA8B,EAC9B,IAAI,EACJ,EAAE,EACF,iBAAiB,CAClB,CAAC;YACF,MAAM,QAAQ,GAAG,IAAI,iBAAiB,CACpC,YAAY,EACZ,WAAW,EACX,8BAA8B,EAC9B,IAAI,EACJ,EAAE,EACF,iBAAiB,CAClB,CAAC;YACF,MAAM,UAAU,GAAG,IAAI,QAAQ,CAAC,cAAc,CAAC,CAAC;YAEhD,YAAY,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YACpC,YAAY,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YACpC,YAAY,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;YAEtC,MAAM,gBAAgB,GAAG,YAAY,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;YACpE,MAAM,CAAC,gBAAgB,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACzC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAErD,MAAM,gBAAgB,GAAG,YAAY,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;YACpE,MAAM,CAAC,gBAAgB,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACzC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC7B,EAAE,CAAC,+DAA+D,EAAE,KAAK,IAAI,EAAE;YAC7E,MAAM,gBAAgB,GAAG,sBAAsB,CAAC;YAChD,iCAAiC,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;YAEpE,MAAM,0BAA0B,GAAwB;gBACtD,IAAI,EAAE,sBAAsB;gBAC5B,WAAW,EAAE,wCAAwC;gBACrD,UAAU,EAAE;oBACV,IAAI,EAAE,IAAI,CAAC,MAAM;oBACjB,UAAU,EAAE;wBACV,WAAW,EAAE;4BACX,IAAI,EAAE,IAAI,CAAC,MAAM;4BACjB,MAAM,EAAE,MAAM,EAAE,gCAAgC;yBACjD;qBACF;iBACF;aACF,CAAC;YAEF,MAAM,SAAS,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACnC,MAAM,gBAAgB,GAAG;gBACvB,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE;gBACvB,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE;gBACvB,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE;aACZ,CAAC;YACF,SAAS,CAAC,eAAe,CAAC,gBAAuB,CAAC,CAAC;YAEnD,uBAAuB;YACvB,gBAAgB,CAAC,MAAM,CAAC,EAAE,CAAC,kBAAkB,CAAC,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;gBAChE,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;oBACrB,QAAQ,CACN,MAAM,CAAC,IAAI,CACT,IAAI,CAAC,SAAS,CAAC;wBACb,EAAE,qBAAqB,EAAE,CAAC,0BAA0B,CAAC,EAAE;qBACxD,CAAC,CACH,CACF,CAAC;gBACJ,CAAC;gBACD,OAAO,gBAAuB,CAAC;YACjC,CAAC,CAAC,CAAC;YAEH,yBAAyB;YACzB,gBAAgB,CAAC,EAAE,CAAC,kBAAkB,CAAC,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;gBACzD,IAAI,KAAK,KAAK,OAAO,EAAE,CAAC;oBACtB,QAAQ,CAAC,CAAC,CAAC,CAAC;gBACd,CAAC;gBACD,OAAO,gBAAuB,CAAC;YACjC,CAAC,CAAC,CAAC;YAEH,MAAM,YAAY,CAAC,aAAa,EAAE,CAAC;YAEnC,MAAM,cAAc,GAAG,YAAY,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;YACpE,MAAM,CAAC,cAAc,CAAC,CAAC,WAAW,EAAE,CAAC;YAErC,MAAM,gBAAgB,GAAI,cAAiC,CAAC,MAAM;iBAC/D,UAAoB,CAAC;YACxB,MAAM,CAAC,gBAAgB,CAAC,UAAU,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;YACnE,MAAM,CAAC,gBAAgB,CAAC,UAAU,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,cAAc,CACjE,QAAQ,EACR,SAAS,CACV,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kEAAkE,EAAE,KAAK,IAAI,EAAE;YAChF,iCAAiC,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;YAC7D,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;YACnE,MAAM,kBAAkB,GAAG;gBACzB,eAAe,EAAE;oBACf,OAAO,EAAE,gBAAgB;oBACzB,IAAI,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC;oBACxB,KAAK,EAAE,IAAI;iBACZ;aACF,CAAC;YACF,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC;YAEtE,MAAM,YAAY,CAAC,aAAa,EAAE,CAAC;YAEnC,MAAM,CAAC,oBAAoB,CAAC,CAAC,oBAAoB,CAC/C,kBAAkB,EAClB,SAAS,EACT,YAAY,EACZ,KAAK,CACN,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kEAAkE,EAAE,KAAK,IAAI,EAAE;YAChF,iCAAiC,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;YAC7D,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;YACnE,MAAM,kBAAkB,GAAG;gBACzB,eAAe,EAAE;oBACf,OAAO,EAAE,gBAAgB;oBACzB,IAAI,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC;oBACxB,KAAK,EAAE,IAAI;iBACZ;aACF,CAAC;YACF,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC;YAEtE,MAAM,YAAY,CAAC,aAAa,EAAE,CAAC;YAEnC,MAAM,CAAC,oBAAoB,CAAC,CAAC,oBAAoB,CAC/C,kBAAkB,EAClB,SAAS,EACT,YAAY,EACZ,KAAK,CACN,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,MAAM,MAAM,GAAW;YACrB,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;YACrD,OAAO,EAAE,OAAO;SACjB,CAAC;QACF,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC3B,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QACpD,MAAM,MAAM,GAAW;YACrB,KAAK,EAAE;gBACL;oBACE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;oBAC9B,OAAO,EAAE,OAAO;iBACjB;gBACD,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE;aACtB;SACF,CAAC;QACF,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC3B,MAAM,CAAC,MAAM,CAAC,KAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QACpD,MAAM,MAAM,GAAW;YACrB,KAAK,EAAE;gBACL,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;gBAC9B,OAAO,EAAE,OAAO;aACjB;SACF,CAAC;QACF,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC3B,MAAM,CAAC,MAAM,CAAC,KAAM,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,CAAC;IAChD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,MAAM,MAAM,GAAW;YACrB,UAAU,EAAE;gBACV,KAAK,EAAE;oBACL,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;oBAC9B,OAAO,EAAE,OAAO;iBACjB;aACF;SACF,CAAC;QACF,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC3B,MAAM,CAAC,MAAM,CAAC,UAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,MAAM,GAAW;YACrB,UAAU,EAAE;gBACV,KAAK,EAAE;oBACL,KAAK,EAAE;wBACL,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;wBAC9B,OAAO,EAAE,OAAO;qBACjB;iBACF;gBACD,KAAK,EAAE;oBACL,KAAK,EAAE;wBACL;4BACE,UAAU,EAAE;gCACV,UAAU,EAAE;oCACV,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;oCAC9B,OAAO,EAAE,GAAG;iCACb;6BACF;yBACF;qBACF;iBACF;aACF;SACF,CAAC;QACF,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC3B,MAAM,CAAC,MAAM,CAAC,UAAW,CAAC,KAAK,CAAC,KAAM,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,CAAC;QAChE,MAAM,UAAU,GACd,MAAM,CAAC,UAAW,CAAC,KAAK,CAAC,KAAM,CAAC,CAAC,CAAC,CAAC,UAAW,CAAC,UAAU,CAAC;QAC5D,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,aAAa,EAAE,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,MAAM,MAAM,GAAW;YACrB,IAAI,EAAE,IAAI,CAAC,MAAM;YACjB,UAAU,EAAE;gBACV,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE;gBAC3B,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE;aAC1C;SACF,CAAC;QACF,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC3B,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QACtE,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,MAAM,GAAW;YACrB,IAAI,EAAE,IAAI,CAAC,MAAM;YACjB,UAAU,EAAE;gBACV,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE;gBAChD,IAAI,EAAE;oBACJ,IAAI,EAAE,IAAI,CAAC,MAAM;oBACjB,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC;iBACxB;aACF;SACF,CAAC;QACF,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1D,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC3B,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;QACzC,MAAM,MAAM,GAAW;YACrB,IAAI,EAAE,IAAI,CAAC,MAAM;YACjB,UAAU,EAAE;gBACV,KAAK,EAAE;oBACL,IAAI,EAAE,IAAI,CAAC,KAAK;oBAChB,KAAK,EAAE;wBACL,IAAI,EAAE,IAAI,CAAC,MAAM;wBACjB,UAAU,EAAE;4BACV,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE;yBAC9C;qBACF;iBACF;aACF;SACF,CAAC;QACF,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC3B,MAAM,CACH,MAAM,CAAC,UAAU,EAAE,CAAC,OAAO,CAAC,EAAE,KAAgB,EAAE,UAAU,EAAE,CAAC,QAAQ,CAAC,CACxE,CAAC,cAAc,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,MAAM,MAAM,GAAW;YACrB,IAAI,EAAE,IAAI,CAAC,MAAM;YACjB,UAAU,EAAE;gBACV,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE;gBAC5B,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE;aACjC;SACF,CAAC;QACF,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1D,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC3B,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;QAC1D,MAAM,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACnD,MAAM,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;QAC1D,MAAM,QAAQ,GAAQ;YACpB,IAAI,EAAE,IAAI,CAAC,MAAM;YACjB,UAAU,EAAE;gBACV,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE;gBACzC,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE;gBAC3B,OAAO,EAAE;oBACP,IAAI,EAAE,IAAI,CAAC,MAAM;oBACjB,UAAU,EAAE;wBACV,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE;qBAC1C;iBACF;aACF;SACF,CAAC;QACF,QAAQ,CAAC,UAAU,CAAC,OAAO,GAAG;YAC5B,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,KAAK,EAAE,QAAQ;SAChB,CAAC;QAEF,MAAM,MAAM,GAAW;YACrB,IAAI,EAAE,IAAI,CAAC,MAAM;YACjB,UAAU,EAAE;gBACV,GAAG,EAAE,QAAQ;aACd;SACF,CAAC;QAEF,MAAM,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACvD,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc,CACnE,QAAQ,EACR,SAAS,CACV,CAAC;QACF,MAAM,CACJ,MAAM,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,CAAC,SAAS,CAAC,EAAE,UAAU,EAAE,CAAC,IAAI,CAAC,CACxE,CAAC,cAAc,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/src/tools/tools.d.ts

@@ -0,0 +1,184 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { FunctionDeclaration, PartListUnion, Schema } from '@google/genai';
+/**
+ * Interface representing the base Tool functionality
+ */
+export interface Tool<TParams = unknown, TResult extends ToolResult = ToolResult> {
+    /**
+     * The internal name of the tool (used for API calls)
+     */
+    name: string;
+    /**
+     * The user-friendly display name of the tool
+     */
+    displayName: string;
+    /**
+     * Description of what the tool does
+     */
+    description: string;
+    /**
+     * Function declaration schema from @google/genai
+     */
+    schema: FunctionDeclaration;
+    /**
+     * Whether the tool's output should be rendered as markdown
+     */
+    isOutputMarkdown: boolean;
+    /**
+     * Whether the tool supports live (streaming) output
+     */
+    canUpdateOutput: boolean;
+    /**
+     * Validates the parameters for the tool
+     * Should be called from both `shouldConfirmExecute` and `execute`
+     * `shouldConfirmExecute` should return false immediately if invalid
+     * @param params Parameters to validate
+     * @returns An error message string if invalid, null otherwise
+     */
+    validateToolParams(params: TParams): string | null;
+    /**
+     * Gets a pre-execution description of the tool operation
+     * @param params Parameters for the tool execution
+     * @returns A markdown string describing what the tool will do
+     * Optional for backward compatibility
+     */
+    getDescription(params: TParams): string;
+    /**
+     * Determines if the tool should prompt for confirmation before execution
+     * @param params Parameters for the tool execution
+     * @returns Whether execute should be confirmed.
+     */
+    shouldConfirmExecute(params: TParams, abortSignal: AbortSignal): Promise<ToolCallConfirmationDetails | false>;
+    /**
+     * Executes the tool with the given parameters
+     * @param params Parameters for the tool execution
+     * @returns Result of the tool execution
+     */
+    execute(params: TParams, signal: AbortSignal, updateOutput?: (output: string) => void): Promise<TResult>;
+}
+/**
+ * Base implementation for tools with common functionality
+ */
+export declare abstract class BaseTool<TParams = unknown, TResult extends ToolResult = ToolResult> implements Tool<TParams, TResult> {
+    readonly name: string;
+    readonly displayName: string;
+    readonly description: string;
+    readonly parameterSchema: Schema;
+    readonly isOutputMarkdown: boolean;
+    readonly canUpdateOutput: boolean;
+    /**
+     * Creates a new instance of BaseTool
+     * @param name Internal name of the tool (used for API calls)
+     * @param displayName User-friendly display name of the tool
+     * @param description Description of what the tool does
+     * @param isOutputMarkdown Whether the tool's output should be rendered as markdown
+     * @param canUpdateOutput Whether the tool supports live (streaming) output
+     * @param parameterSchema JSON Schema defining the parameters
+     */
+    constructor(name: string, displayName: string, description: string, parameterSchema: Schema, isOutputMarkdown?: boolean, canUpdateOutput?: boolean);
+    /**
+     * Function declaration schema computed from name, description, and parameterSchema
+     */
+    get schema(): FunctionDeclaration;
+    /**
+     * Validates the parameters for the tool
+     * This is a placeholder implementation and should be overridden
+     * Should be called from both `shouldConfirmExecute` and `execute`
+     * `shouldConfirmExecute` should return false immediately if invalid
+     * @param params Parameters to validate
+     * @returns An error message string if invalid, null otherwise
+     */
+    validateToolParams(params: TParams): string | null;
+    /**
+     * Gets a pre-execution description of the tool operation
+     * Default implementation that should be overridden by derived classes
+     * @param params Parameters for the tool execution
+     * @returns A markdown string describing what the tool will do
+     */
+    getDescription(params: TParams): string;
+    /**
+     * Determines if the tool should prompt for confirmation before execution
+     * @param params Parameters for the tool execution
+     * @returns Whether or not execute should be confirmed by the user.
+     */
+    shouldConfirmExecute(params: TParams, abortSignal: AbortSignal): Promise<ToolCallConfirmationDetails | false>;
+    /**
+     * Abstract method to execute the tool with the given parameters
+     * Must be implemented by derived classes
+     * @param params Parameters for the tool execution
+     * @param signal AbortSignal for tool cancellation
+     * @returns Result of the tool execution
+     */
+    abstract execute(params: TParams, signal: AbortSignal, updateOutput?: (output: string) => void): Promise<TResult>;
+}
+export interface ToolResult {
+    /**
+     * A short, one-line summary of the tool's action and result.
+     * e.g., "Read 5 files", "Wrote 256 bytes to foo.txt"
+     */
+    summary?: string;
+    /**
+     * Content meant to be included in LLM history.
+     * This should represent the factual outcome of the tool execution.
+     */
+    llmContent: PartListUnion;
+    /**
+     * Markdown string for user display.
+     * This provides a user-friendly summary or visualization of the result.
+     * NOTE: This might also be considered UI-specific and could potentially be
+     * removed or modified in a further refactor if the server becomes purely API-driven.
+     * For now, we keep it as the core logic in ReadFileTool currently produces it.
+     */
+    returnDisplay: ToolResultDisplay;
+}
+export type ToolResultDisplay = string | FileDiff;
+export interface FileDiff {
+    fileDiff: string;
+    fileName: string;
+}
+export interface ToolEditConfirmationDetails {
+    type: 'edit';
+    title: string;
+    onConfirm: (outcome: ToolConfirmationOutcome, payload?: ToolConfirmationPayload) => Promise<void>;
+    fileName: string;
+    fileDiff: string;
+    isModifying?: boolean;
+}
+export interface ToolConfirmationPayload {
+    newContent: string;
+}
+export interface ToolExecuteConfirmationDetails {
+    type: 'exec';
+    title: string;
+    onConfirm: (outcome: ToolConfirmationOutcome) => Promise<void>;
+    command: string;
+    rootCommand: string;
+}
+export interface ToolMcpConfirmationDetails {
+    type: 'mcp';
+    title: string;
+    serverName: string;
+    toolName: string;
+    toolDisplayName: string;
+    onConfirm: (outcome: ToolConfirmationOutcome) => Promise<void>;
+}
+export interface ToolInfoConfirmationDetails {
+    type: 'info';
+    title: string;
+    onConfirm: (outcome: ToolConfirmationOutcome) => Promise<void>;
+    prompt: string;
+    urls?: string[];
+}
+export type ToolCallConfirmationDetails = ToolEditConfirmationDetails | ToolExecuteConfirmationDetails | ToolMcpConfirmationDetails | ToolInfoConfirmationDetails;
+export declare enum ToolConfirmationOutcome {
+    ProceedOnce = "proceed_once",
+    ProceedAlways = "proceed_always",
+    ProceedAlwaysServer = "proceed_always_server",
+    ProceedAlwaysTool = "proceed_always_tool",
+    ModifyWithEditor = "modify_with_editor",
+    Cancel = "cancel"
+}