@google/gemini-cli-core 0.0.1

package/dist/src/tools/tools.js

@@ -0,0 +1,257 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ToolErrorType } from './tool-error.js';
+import { SchemaValidator } from '../utils/schemaValidator.js';
+/**
+ * A convenience base class for ToolInvocation.
+ */
+export class BaseToolInvocation {
+    params;
+    constructor(params) {
+        this.params = params;
+    }
+    toolLocations() {
+        return [];
+    }
+    shouldConfirmExecute(_abortSignal) {
+        return Promise.resolve(false);
+    }
+}
+/**
+ * New base class for tools that separates validation from execution.
+ * New tools should extend this class.
+ */
+export class DeclarativeTool {
+    name;
+    displayName;
+    description;
+    kind;
+    parameterSchema;
+    isOutputMarkdown;
+    canUpdateOutput;
+    constructor(name, displayName, description, kind, parameterSchema, isOutputMarkdown = true, canUpdateOutput = false) {
+        this.name = name;
+        this.displayName = displayName;
+        this.description = description;
+        this.kind = kind;
+        this.parameterSchema = parameterSchema;
+        this.isOutputMarkdown = isOutputMarkdown;
+        this.canUpdateOutput = canUpdateOutput;
+    }
+    get schema() {
+        return {
+            name: this.name,
+            description: this.description,
+            parametersJsonSchema: this.parameterSchema,
+        };
+    }
+    /**
+     * Validates the raw tool parameters.
+     * Subclasses should override this to add custom validation logic
+     * beyond the JSON schema check.
+     * @param params The raw parameters from the model.
+     * @returns An error message string if invalid, null otherwise.
+     */
+    validateToolParams(_params) {
+        // Base implementation can be extended by subclasses.
+        return null;
+    }
+    /**
+     * A convenience method that builds and executes the tool in one step.
+     * Throws an error if validation fails.
+     * @param params The raw, untrusted parameters from the model.
+     * @param signal AbortSignal for tool cancellation.
+     * @param updateOutput Optional callback to stream output.
+     * @returns The result of the tool execution.
+     */
+    async buildAndExecute(params, signal, updateOutput, shellExecutionConfig) {
+        const invocation = this.build(params);
+        return invocation.execute(signal, updateOutput, shellExecutionConfig);
+    }
+    /**
+     * Similar to `build` but never throws.
+     * @param params The raw, untrusted parameters from the model.
+     * @returns A `ToolInvocation` instance.
+     */
+    silentBuild(params) {
+        try {
+            return this.build(params);
+        }
+        catch (e) {
+            if (e instanceof Error) {
+                return e;
+            }
+            return new Error(String(e));
+        }
+    }
+    /**
+     * A convenience method that builds and executes the tool in one step.
+     * Never throws.
+     * @param params The raw, untrusted parameters from the model.
+     * @params abortSignal a signal to abort.
+     * @returns The result of the tool execution.
+     */
+    async validateBuildAndExecute(params, abortSignal) {
+        const invocationOrError = this.silentBuild(params);
+        if (invocationOrError instanceof Error) {
+            const errorMessage = invocationOrError.message;
+            return {
+                llmContent: `Error: Invalid parameters provided. Reason: ${errorMessage}`,
+                returnDisplay: errorMessage,
+                error: {
+                    message: errorMessage,
+                    type: ToolErrorType.INVALID_TOOL_PARAMS,
+                },
+            };
+        }
+        try {
+            return await invocationOrError.execute(abortSignal);
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : String(error);
+            return {
+                llmContent: `Error: Tool call execution failed. Reason: ${errorMessage}`,
+                returnDisplay: errorMessage,
+                error: {
+                    message: errorMessage,
+                    type: ToolErrorType.EXECUTION_FAILED,
+                },
+            };
+        }
+    }
+}
+/**
+ * New base class for declarative tools that separates validation from execution.
+ * New tools should extend this class, which provides a `build` method that
+ * validates parameters before deferring to a `createInvocation` method for
+ * the final `ToolInvocation` object instantiation.
+ */
+export class BaseDeclarativeTool extends DeclarativeTool {
+    build(params) {
+        const validationError = this.validateToolParams(params);
+        if (validationError) {
+            throw new Error(validationError);
+        }
+        return this.createInvocation(params);
+    }
+    validateToolParams(params) {
+        const errors = SchemaValidator.validate(this.schema.parametersJsonSchema, params);
+        if (errors) {
+            return errors;
+        }
+        return this.validateToolParamValues(params);
+    }
+    validateToolParamValues(_params) {
+        // Base implementation can be extended by subclasses.
+        return null;
+    }
+}
+/**
+ * Type guard to check if an object is a Tool.
+ * @param obj The object to check.
+ * @returns True if the object is a Tool, false otherwise.
+ */
+export function isTool(obj) {
+    return (typeof obj === 'object' &&
+        obj !== null &&
+        'name' in obj &&
+        'build' in obj &&
+        typeof obj.build === 'function');
+}
+/**
+ * Detects cycles in a JSON schemas due to `$ref`s.
+ * @param schema The root of the JSON schema.
+ * @returns `true` if a cycle is detected, `false` otherwise.
+ */
+export function hasCycleInSchema(schema) {
+    function resolveRef(ref) {
+        if (!ref.startsWith('#/')) {
+            return null;
+        }
+        const path = ref.substring(2).split('/');
+        let current = schema;
+        for (const segment of path) {
+            if (typeof current !== 'object' ||
+                current === null ||
+                !Object.prototype.hasOwnProperty.call(current, segment)) {
+                return null;
+            }
+            current = current[segment];
+        }
+        return current;
+    }
+    function traverse(node, visitedRefs, pathRefs) {
+        if (typeof node !== 'object' || node === null) {
+            return false;
+        }
+        if (Array.isArray(node)) {
+            for (const item of node) {
+                if (traverse(item, visitedRefs, pathRefs)) {
+                    return true;
+                }
+            }
+            return false;
+        }
+        if ('$ref' in node && typeof node.$ref === 'string') {
+            const ref = node.$ref;
+            if (ref === '#/' || pathRefs.has(ref)) {
+                // A ref to just '#/' is always a cycle.
+                return true; // Cycle detected!
+            }
+            if (visitedRefs.has(ref)) {
+                return false; // Bail early, we have checked this ref before.
+            }
+            const resolvedNode = resolveRef(ref);
+            if (resolvedNode) {
+                // Add it to both visited and the current path
+                visitedRefs.add(ref);
+                pathRefs.add(ref);
+                const hasCycle = traverse(resolvedNode, visitedRefs, pathRefs);
+                pathRefs.delete(ref); // Backtrack, leaving it in visited
+                return hasCycle;
+            }
+        }
+        // Crawl all the properties of node
+        for (const key in node) {
+            if (Object.prototype.hasOwnProperty.call(node, key)) {
+                if (traverse(node[key], visitedRefs, pathRefs)) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+    return traverse(schema, new Set(), new Set());
+}
+export var ToolConfirmationOutcome;
+(function (ToolConfirmationOutcome) {
+    ToolConfirmationOutcome["ProceedOnce"] = "proceed_once";
+    ToolConfirmationOutcome["ProceedAlways"] = "proceed_always";
+    ToolConfirmationOutcome["ProceedAlwaysServer"] = "proceed_always_server";
+    ToolConfirmationOutcome["ProceedAlwaysTool"] = "proceed_always_tool";
+    ToolConfirmationOutcome["ModifyWithEditor"] = "modify_with_editor";
+    ToolConfirmationOutcome["Cancel"] = "cancel";
+})(ToolConfirmationOutcome || (ToolConfirmationOutcome = {}));
+export var Kind;
+(function (Kind) {
+    Kind["Read"] = "read";
+    Kind["Edit"] = "edit";
+    Kind["Delete"] = "delete";
+    Kind["Move"] = "move";
+    Kind["Search"] = "search";
+    Kind["Execute"] = "execute";
+    Kind["Think"] = "think";
+    Kind["Fetch"] = "fetch";
+    Kind["Other"] = "other";
+})(Kind || (Kind = {}));
+// Function kinds that have side effects
+export const MUTATOR_KINDS = [
+    Kind.Edit,
+    Kind.Delete,
+    Kind.Move,
+    Kind.Execute,
+];
+//# sourceMappingURL=tools.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tools.js","sourceRoot":"","sources":["../../../src/tools/tools.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGhD,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAkD9D;;GAEG;AACH,MAAM,OAAgB,kBAAkB;IAKjB;IAArB,YAAqB,MAAe;QAAf,WAAM,GAAN,MAAM,CAAS;IAAG,CAAC;IAIxC,aAAa;QACX,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,oBAAoB,CAClB,YAAyB;QAEzB,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;CAOF;AAyDD;;;GAGG;AACH,MAAM,OAAgB,eAAe;IAMxB;IACA;IACA;IACA;IACA;IACA;IACA;IAPX,YACW,IAAY,EACZ,WAAmB,EACnB,WAAmB,EACnB,IAAU,EACV,eAAwB,EACxB,mBAA4B,IAAI,EAChC,kBAA2B,KAAK;QANhC,SAAI,GAAJ,IAAI,CAAQ;QACZ,gBAAW,GAAX,WAAW,CAAQ;QACnB,gBAAW,GAAX,WAAW,CAAQ;QACnB,SAAI,GAAJ,IAAI,CAAM;QACV,oBAAe,GAAf,eAAe,CAAS;QACxB,qBAAgB,GAAhB,gBAAgB,CAAgB;QAChC,oBAAe,GAAf,eAAe,CAAiB;IACxC,CAAC;IAEJ,IAAI,MAAM;QACR,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,oBAAoB,EAAE,IAAI,CAAC,eAAe;SAC3C,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,kBAAkB,CAAC,OAAgB;QACjC,qDAAqD;QACrD,OAAO,IAAI,CAAC;IACd,CAAC;IAWD;;;;;;;OAOG;IACH,KAAK,CAAC,eAAe,CACnB,MAAe,EACf,MAAmB,EACnB,YAAoD,EACpD,oBAA2C;QAE3C,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,UAAU,CAAC,OAAO,CAAC,MAAM,EAAE,YAAY,EAAE,oBAAoB,CAAC,CAAC;IACxE,CAAC;IAED;;;;OAIG;IACK,WAAW,CACjB,MAAe;QAEf,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC5B,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,YAAY,KAAK,EAAE,CAAC;gBACvB,OAAO,CAAC,CAAC;YACX,CAAC;YACD,OAAO,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,uBAAuB,CAC3B,MAAe,EACf,WAAwB;QAExB,MAAM,iBAAiB,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QACnD,IAAI,iBAAiB,YAAY,KAAK,EAAE,CAAC;YACvC,MAAM,YAAY,GAAG,iBAAiB,CAAC,OAAO,CAAC;YAC/C,OAAO;gBACL,UAAU,EAAE,+CAA+C,YAAY,EAAE;gBACzE,aAAa,EAAE,YAAY;gBAC3B,KAAK,EAAE;oBACL,OAAO,EAAE,YAAY;oBACrB,IAAI,EAAE,aAAa,CAAC,mBAAmB;iBACxC;aACF,CAAC;QACJ,CAAC;QAED,IAAI,CAAC;YACH,OAAO,MAAM,iBAAiB,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACtD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,YAAY,GAChB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACzD,OAAO;gBACL,UAAU,EAAE,8CAA8C,YAAY,EAAE;gBACxE,aAAa,EAAE,YAAY;gBAC3B,KAAK,EAAE;oBACL,OAAO,EAAE,YAAY;oBACrB,IAAI,EAAE,aAAa,CAAC,gBAAgB;iBACrC;aACF,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAgB,mBAGpB,SAAQ,eAAiC;IACzC,KAAK,CAAC,MAAe;QACnB,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACxD,IAAI,eAAe,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;QACnC,CAAC;QACD,OAAO,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC;IAEQ,kBAAkB,CAAC,MAAe;QACzC,MAAM,MAAM,GAAG,eAAe,CAAC,QAAQ,CACrC,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAChC,MAAM,CACP,CAAC;QAEF,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,OAAO,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;IAES,uBAAuB,CAAC,OAAgB;QAChD,qDAAqD;QACrD,OAAO,IAAI,CAAC;IACd,CAAC;CAKF;AAOD;;;;GAIG;AACH,MAAM,UAAU,MAAM,CAAC,GAAY;IACjC,OAAO,CACL,OAAO,GAAG,KAAK,QAAQ;QACvB,GAAG,KAAK,IAAI;QACZ,MAAM,IAAI,GAAG;QACb,OAAO,IAAI,GAAG;QACd,OAAQ,GAA0B,CAAC,KAAK,KAAK,UAAU,CACxD,CAAC;AACJ,CAAC;AA2BD;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAc;IAC7C,SAAS,UAAU,CAAC,GAAW;QAC7B,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,IAAI,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACzC,IAAI,OAAO,GAAY,MAAM,CAAC;QAC9B,KAAK,MAAM,OAAO,IAAI,IAAI,EAAE,CAAC;YAC3B,IACE,OAAO,OAAO,KAAK,QAAQ;gBAC3B,OAAO,KAAK,IAAI;gBAChB,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,EACvD,CAAC;gBACD,OAAO,IAAI,CAAC;YACd,CAAC;YACD,OAAO,GAAI,OAAmC,CAAC,OAAO,CAAC,CAAC;QAC1D,CAAC;QACD,OAAO,OAAiB,CAAC;IAC3B,CAAC;IAED,SAAS,QAAQ,CACf,IAAa,EACb,WAAwB,EACxB,QAAqB;QAErB,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YAC9C,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,QAAQ,CAAC,IAAI,EAAE,WAAW,EAAE,QAAQ,CAAC,EAAE,CAAC;oBAC1C,OAAO,IAAI,CAAC;gBACd,CAAC;YACH,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,MAAM,IAAI,IAAI,IAAI,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACpD,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC;YACtB,IAAI,GAAG,KAAK,IAAI,IAAI,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBACtC,wCAAwC;gBACxC,OAAO,IAAI,CAAC,CAAC,kBAAkB;YACjC,CAAC;YACD,IAAI,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBACzB,OAAO,KAAK,CAAC,CAAC,+CAA+C;YAC/D,CAAC;YAED,MAAM,YAAY,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;YACrC,IAAI,YAAY,EAAE,CAAC;gBACjB,8CAA8C;gBAC9C,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBACrB,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBAClB,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;gBAC/D,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,mCAAmC;gBACzD,OAAO,QAAQ,CAAC;YAClB,CAAC;QACH,CAAC;QAED,mCAAmC;QACnC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;gBACpD,IACE,QAAQ,CACL,IAAgC,CAAC,GAAG,CAAC,EACtC,WAAW,EACX,QAAQ,CACT,EACD,CAAC;oBACD,OAAO,IAAI,CAAC;gBACd,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,QAAQ,CAAC,MAAM,EAAE,IAAI,GAAG,EAAU,EAAE,IAAI,GAAG,EAAU,CAAC,CAAC;AAChE,CAAC;AA4ED,MAAM,CAAN,IAAY,uBAOX;AAPD,WAAY,uBAAuB;IACjC,uDAA4B,CAAA;IAC5B,2DAAgC,CAAA;IAChC,wEAA6C,CAAA;IAC7C,oEAAyC,CAAA;IACzC,kEAAuC,CAAA;IACvC,4CAAiB,CAAA;AACnB,CAAC,EAPW,uBAAuB,KAAvB,uBAAuB,QAOlC;AAED,MAAM,CAAN,IAAY,IAUX;AAVD,WAAY,IAAI;IACd,qBAAa,CAAA;IACb,qBAAa,CAAA;IACb,yBAAiB,CAAA;IACjB,qBAAa,CAAA;IACb,yBAAiB,CAAA;IACjB,2BAAmB,CAAA;IACnB,uBAAe,CAAA;IACf,uBAAe,CAAA;IACf,uBAAe,CAAA;AACjB,CAAC,EAVW,IAAI,KAAJ,IAAI,QAUf;AAED,wCAAwC;AACxC,MAAM,CAAC,MAAM,aAAa,GAAW;IACnC,IAAI,CAAC,IAAI;IACT,IAAI,CAAC,MAAM;IACX,IAAI,CAAC,IAAI;IACT,IAAI,CAAC,OAAO;CACJ,CAAC"}

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

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

package/dist/src/tools/tools.test.js

@@ -0,0 +1,205 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { describe, it, expect, vi } from 'vitest';
+import { DeclarativeTool, hasCycleInSchema, Kind } from './tools.js';
+import { ToolErrorType } from './tool-error.js';
+class TestToolInvocation {
+    params;
+    executeFn;
+    constructor(params, executeFn) {
+        this.params = params;
+        this.executeFn = executeFn;
+    }
+    getDescription() {
+        return 'A test invocation';
+    }
+    toolLocations() {
+        return [];
+    }
+    shouldConfirmExecute() {
+        return Promise.resolve(false);
+    }
+    execute() {
+        return this.executeFn();
+    }
+}
+class TestTool extends DeclarativeTool {
+    buildFn;
+    constructor(buildFn) {
+        super('test-tool', 'Test Tool', 'A tool for testing', Kind.Other, {});
+        this.buildFn = buildFn;
+    }
+    build(params) {
+        return this.buildFn(params);
+    }
+}
+describe('DeclarativeTool', () => {
+    describe('validateBuildAndExecute', () => {
+        const abortSignal = new AbortController().signal;
+        it('should return INVALID_TOOL_PARAMS error if build fails', async () => {
+            const buildError = new Error('Invalid build parameters');
+            const buildFn = vi.fn().mockImplementation(() => {
+                throw buildError;
+            });
+            const tool = new TestTool(buildFn);
+            const params = { foo: 'bar' };
+            const result = await tool.validateBuildAndExecute(params, abortSignal);
+            expect(buildFn).toHaveBeenCalledWith(params);
+            expect(result).toEqual({
+                llmContent: `Error: Invalid parameters provided. Reason: ${buildError.message}`,
+                returnDisplay: buildError.message,
+                error: {
+                    message: buildError.message,
+                    type: ToolErrorType.INVALID_TOOL_PARAMS,
+                },
+            });
+        });
+        it('should return EXECUTION_FAILED error if execute fails', async () => {
+            const executeError = new Error('Execution failed');
+            const executeFn = vi.fn().mockRejectedValue(executeError);
+            const invocation = new TestToolInvocation({}, executeFn);
+            const buildFn = vi.fn().mockReturnValue(invocation);
+            const tool = new TestTool(buildFn);
+            const params = { foo: 'bar' };
+            const result = await tool.validateBuildAndExecute(params, abortSignal);
+            expect(buildFn).toHaveBeenCalledWith(params);
+            expect(executeFn).toHaveBeenCalled();
+            expect(result).toEqual({
+                llmContent: `Error: Tool call execution failed. Reason: ${executeError.message}`,
+                returnDisplay: executeError.message,
+                error: {
+                    message: executeError.message,
+                    type: ToolErrorType.EXECUTION_FAILED,
+                },
+            });
+        });
+        it('should return the result of execute on success', async () => {
+            const successResult = {
+                llmContent: 'Success!',
+                returnDisplay: 'Success!',
+            };
+            const executeFn = vi.fn().mockResolvedValue(successResult);
+            const invocation = new TestToolInvocation({}, executeFn);
+            const buildFn = vi.fn().mockReturnValue(invocation);
+            const tool = new TestTool(buildFn);
+            const params = { foo: 'bar' };
+            const result = await tool.validateBuildAndExecute(params, abortSignal);
+            expect(buildFn).toHaveBeenCalledWith(params);
+            expect(executeFn).toHaveBeenCalled();
+            expect(result).toEqual(successResult);
+        });
+    });
+});
+describe('hasCycleInSchema', () => {
+    it('should detect a simple direct cycle', () => {
+        const schema = {
+            properties: {
+                data: {
+                    $ref: '#/properties/data',
+                },
+            },
+        };
+        expect(hasCycleInSchema(schema)).toBe(true);
+    });
+    it('should detect a cycle from object properties referencing parent properties', () => {
+        const schema = {
+            type: 'object',
+            properties: {
+                data: {
+                    type: 'object',
+                    properties: {
+                        child: { $ref: '#/properties/data' },
+                    },
+                },
+            },
+        };
+        expect(hasCycleInSchema(schema)).toBe(true);
+    });
+    it('should detect a cycle from array items referencing parent properties', () => {
+        const schema = {
+            type: 'object',
+            properties: {
+                data: {
+                    type: 'array',
+                    items: {
+                        type: 'object',
+                        properties: {
+                            child: { $ref: '#/properties/data/items' },
+                        },
+                    },
+                },
+            },
+        };
+        expect(hasCycleInSchema(schema)).toBe(true);
+    });
+    it('should detect a cycle between sibling properties', () => {
+        const schema = {
+            type: 'object',
+            properties: {
+                a: {
+                    type: 'object',
+                    properties: {
+                        child: { $ref: '#/properties/b' },
+                    },
+                },
+                b: {
+                    type: 'object',
+                    properties: {
+                        child: { $ref: '#/properties/a' },
+                    },
+                },
+            },
+        };
+        expect(hasCycleInSchema(schema)).toBe(true);
+    });
+    it('should not detect a cycle in a valid schema', () => {
+        const schema = {
+            type: 'object',
+            properties: {
+                name: { type: 'string' },
+                address: { $ref: '#/definitions/address' },
+            },
+            definitions: {
+                address: {
+                    type: 'object',
+                    properties: {
+                        street: { type: 'string' },
+                        city: { type: 'string' },
+                    },
+                },
+            },
+        };
+        expect(hasCycleInSchema(schema)).toBe(false);
+    });
+    it('should handle non-cyclic sibling refs', () => {
+        const schema = {
+            properties: {
+                a: { $ref: '#/definitions/stringDef' },
+                b: { $ref: '#/definitions/stringDef' },
+            },
+            definitions: {
+                stringDef: { type: 'string' },
+            },
+        };
+        expect(hasCycleInSchema(schema)).toBe(false);
+    });
+    it('should handle nested but not cyclic refs', () => {
+        const schema = {
+            properties: {
+                a: { $ref: '#/definitions/defA' },
+            },
+            definitions: {
+                defA: { properties: { b: { $ref: '#/definitions/defB' } } },
+                defB: { type: 'string' },
+            },
+        };
+        expect(hasCycleInSchema(schema)).toBe(false);
+    });
+    it('should return false for an empty schema', () => {
+        expect(hasCycleInSchema({})).toBe(false);
+    });
+});
+//# sourceMappingURL=tools.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tools.test.js","sourceRoot":"","sources":["../../../src/tools/tools.test.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAElD,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,MAAM,kBAAkB;IAEX;IACQ;IAFnB,YACW,MAAc,EACN,SAAoC;QAD5C,WAAM,GAAN,MAAM,CAAQ;QACN,cAAS,GAAT,SAAS,CAA2B;IACpD,CAAC;IAEJ,cAAc;QACZ,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IAED,aAAa;QACX,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,oBAAoB;QAClB,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;IAED,OAAO;QACL,OAAO,IAAI,CAAC,SAAS,EAAE,CAAC;IAC1B,CAAC;CACF;AAED,MAAM,QAAS,SAAQ,eAAmC;IACvC,OAAO,CAAyC;IAEjE,YAAY,OAA+C;QACzD,KAAK,CAAC,WAAW,EAAE,WAAW,EAAE,oBAAoB,EAAE,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACtE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,MAAc;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9B,CAAC;CACF;AAED,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;QACvC,MAAM,WAAW,GAAG,IAAI,eAAe,EAAE,CAAC,MAAM,CAAC;QAEjD,EAAE,CAAC,wDAAwD,EAAE,KAAK,IAAI,EAAE;YACtE,MAAM,UAAU,GAAG,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;YACzD,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,GAAG,EAAE;gBAC9C,MAAM,UAAU,CAAC;YACnB,CAAC,CAAC,CAAC;YACH,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC;YACnC,MAAM,MAAM,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;YAE9B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;YAEvE,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;YAC7C,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;gBACrB,UAAU,EAAE,+CAA+C,UAAU,CAAC,OAAO,EAAE;gBAC/E,aAAa,EAAE,UAAU,CAAC,OAAO;gBACjC,KAAK,EAAE;oBACL,OAAO,EAAE,UAAU,CAAC,OAAO;oBAC3B,IAAI,EAAE,aAAa,CAAC,mBAAmB;iBACxC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;YACrE,MAAM,YAAY,GAAG,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;YACnD,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;YAC1D,MAAM,UAAU,GAAG,IAAI,kBAAkB,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;YACzD,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;YACpD,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC;YACnC,MAAM,MAAM,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;YAE9B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;YAEvE,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;YAC7C,MAAM,CAAC,SAAS,CAAC,CAAC,gBAAgB,EAAE,CAAC;YACrC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;gBACrB,UAAU,EAAE,8CAA8C,YAAY,CAAC,OAAO,EAAE;gBAChF,aAAa,EAAE,YAAY,CAAC,OAAO;gBACnC,KAAK,EAAE;oBACL,OAAO,EAAE,YAAY,CAAC,OAAO;oBAC7B,IAAI,EAAE,aAAa,CAAC,gBAAgB;iBACrC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;YAC9D,MAAM,aAAa,GAAe;gBAChC,UAAU,EAAE,UAAU;gBACtB,aAAa,EAAE,UAAU;aAC1B,CAAC;YACF,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;YAC3D,MAAM,UAAU,GAAG,IAAI,kBAAkB,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;YACzD,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;YACpD,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC;YACnC,MAAM,MAAM,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;YAE9B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;YAEvE,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;YAC7C,MAAM,CAAC,SAAS,CAAC,CAAC,gBAAgB,EAAE,CAAC;YACrC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,MAAM,MAAM,GAAG;YACb,UAAU,EAAE;gBACV,IAAI,EAAE;oBACJ,IAAI,EAAE,mBAAmB;iBAC1B;aACF;SACF,CAAC;QACF,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4EAA4E,EAAE,GAAG,EAAE;QACpF,MAAM,MAAM,GAAG;YACb,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,IAAI,EAAE;oBACJ,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE;wBACV,KAAK,EAAE,EAAE,IAAI,EAAE,mBAAmB,EAAE;qBACrC;iBACF;aACF;SACF,CAAC;QACF,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sEAAsE,EAAE,GAAG,EAAE;QAC9E,MAAM,MAAM,GAAG;YACb,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,IAAI,EAAE;oBACJ,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACV,KAAK,EAAE,EAAE,IAAI,EAAE,yBAAyB,EAAE;yBAC3C;qBACF;iBACF;aACF;SACF,CAAC;QACF,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;QAC1D,MAAM,MAAM,GAAG;YACb,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,CAAC,EAAE;oBACD,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE;wBACV,KAAK,EAAE,EAAE,IAAI,EAAE,gBAAgB,EAAE;qBAClC;iBACF;gBACD,CAAC,EAAE;oBACD,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE;wBACV,KAAK,EAAE,EAAE,IAAI,EAAE,gBAAgB,EAAE;qBAClC;iBACF;aACF;SACF,CAAC;QACF,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,MAAM,MAAM,GAAG;YACb,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBACxB,OAAO,EAAE,EAAE,IAAI,EAAE,uBAAuB,EAAE;aAC3C;YACD,WAAW,EAAE;gBACX,OAAO,EAAE;oBACP,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE;wBACV,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;wBAC1B,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;qBACzB;iBACF;aACF;SACF,CAAC;QACF,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,MAAM,GAAG;YACb,UAAU,EAAE;gBACV,CAAC,EAAE,EAAE,IAAI,EAAE,yBAAyB,EAAE;gBACtC,CAAC,EAAE,EAAE,IAAI,EAAE,yBAAyB,EAAE;aACvC;YACD,WAAW,EAAE;gBACX,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;aAC9B;SACF,CAAC;QACF,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,MAAM,GAAG;YACb,UAAU,EAAE;gBACV,CAAC,EAAE,EAAE,IAAI,EAAE,oBAAoB,EAAE;aAClC;YACD,WAAW,EAAE;gBACX,IAAI,EAAE,EAAE,UAAU,EAAE,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,oBAAoB,EAAE,EAAE,EAAE;gBAC3D,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;aACzB;SACF,CAAC;QACF,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QACjD,MAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/src/tools/web-fetch.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { ToolInvocation, ToolResult } from './tools.js';
+import { BaseDeclarativeTool } from './tools.js';
+import type { Config } from '../config/config.js';
+/**
+ * Parameters for the WebFetch tool
+ */
+export interface WebFetchToolParams {
+    /**
+     * The prompt containing URL(s) (up to 20) and instructions for processing their content.
+     */
+    prompt: string;
+}
+/**
+ * Implementation of the WebFetch tool logic
+ */
+export declare class WebFetchTool extends BaseDeclarativeTool<WebFetchToolParams, ToolResult> {
+    private readonly config;
+    static readonly Name: string;
+    constructor(config: Config);
+    protected validateToolParamValues(params: WebFetchToolParams): string | null;
+    protected createInvocation(params: WebFetchToolParams): ToolInvocation<WebFetchToolParams, ToolResult>;
+}