diff options
| author | Taylor Mullen <[email protected]> | 2025-04-17 17:25:01 -0400 |
|---|---|---|
| committer | Taylor Mullen <[email protected]> | 2025-04-17 17:25:01 -0400 |
| commit | d970882428a264d122b2f60fc91a4d72da912a93 (patch) | |
| tree | f3eadc5ac3bd990e9986ab4afa4781ab8c1f1201 /packages/cli/src/tools/Tool.ts | |
| parent | ece8630c3327588f291a165599d44fade2c63425 (diff) | |
Fix build break (tool -> tools).
- Without this we'd get a TS1261 about the name "tool" only differeing from "Tool" (the class) by case.
Diffstat (limited to 'packages/cli/src/tools/Tool.ts')
| -rw-r--r-- | packages/cli/src/tools/Tool.ts | 147 |
1 files changed, 0 insertions, 147 deletions
diff --git a/packages/cli/src/tools/Tool.ts b/packages/cli/src/tools/Tool.ts deleted file mode 100644 index 21dd88d5..00000000 --- a/packages/cli/src/tools/Tool.ts +++ /dev/null @@ -1,147 +0,0 @@ -import { FunctionDeclaration, Schema } from "@google/genai"; -import { ToolCallConfirmationDetails } from "../ui/types.js"; - -/** - * 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; - - /** - * Validates the parameters for the tool - * @param params Parameters to validate - * @returns An error message string if invalid, null otherwise - */ - invalidParams(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): 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): Promise<TResult>; -} - - -/** - * Base implementation for tools with common functionality - */ -export abstract class BaseTool<TParams = unknown, TResult extends ToolResult = ToolResult> implements Tool<TParams, TResult> { - /** - * 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 parameterSchema JSON Schema defining the parameters - */ - constructor( - public readonly name: string, - public readonly displayName: string, - public readonly description: string, - public readonly parameterSchema: Record<string, unknown> - ) {} - - /** - * Function declaration schema computed from name, description, and parameterSchema - */ - get schema(): FunctionDeclaration { - return { - name: this.name, - description: this.description, - parameters: this.parameterSchema as Schema - }; - } - - /** - * Validates the parameters for the tool - * This is a placeholder implementation and should be overridden - * @param params Parameters to validate - * @returns An error message string if invalid, null otherwise - */ - invalidParams(params: TParams): string | null { - // Implementation would typically use a JSON Schema validator - // This is a placeholder that should be implemented by derived classes - return 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 { - return JSON.stringify(params); - } - - /** - * 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): Promise<ToolCallConfirmationDetails | false> { - return Promise.resolve(false); - } - - /** - * Abstract method to execute the tool with the given parameters - * Must be implemented by derived classes - * @param params Parameters for the tool execution - * @returns Result of the tool execution - */ - abstract execute(params: TParams): Promise<TResult>; -} - - -export interface ToolResult { - /** - * Content meant to be included in LLM history. - * This should represent the factual outcome of the tool execution. - */ - llmContent: string; - - /** - * Markdown string for user display. - * This provides a user-friendly summary or visualization of the result. - */ - returnDisplay: ToolResultDisplay; -} - -export type ToolResultDisplay = string | FileDiff; - -export interface FileDiff { - fileDiff: string -} |
