more consistent confirmations, TODO to improve write confirmations, drop "description" from execution confirmation, add confirmation to new (still dummy) shell tool (#176)
This commit is contained in:
parent
1a64268bb0
commit
7087c0508e
|
@ -60,11 +60,11 @@ export const ToolConfirmationMessage: React.FC<
|
||||||
question = `Apply this change?`;
|
question = `Apply this change?`;
|
||||||
options.push(
|
options.push(
|
||||||
{
|
{
|
||||||
label: 'Yes',
|
label: 'Yes, allow once',
|
||||||
value: ToolConfirmationOutcome.ProceedOnce,
|
value: ToolConfirmationOutcome.ProceedOnce,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: 'Yes (always allow)',
|
label: 'Yes, allow always', // TODO: this is extreme w/o being qualified by file or directory
|
||||||
value: ToolConfirmationOutcome.ProceedAlways,
|
value: ToolConfirmationOutcome.ProceedAlways,
|
||||||
},
|
},
|
||||||
{ label: 'No (esc)', value: ToolConfirmationOutcome.Cancel },
|
{ label: 'No (esc)', value: ToolConfirmationOutcome.Cancel },
|
||||||
|
@ -73,29 +73,22 @@ export const ToolConfirmationMessage: React.FC<
|
||||||
const executionProps =
|
const executionProps =
|
||||||
confirmationDetails as ToolExecuteConfirmationDetails;
|
confirmationDetails as ToolExecuteConfirmationDetails;
|
||||||
|
|
||||||
// For execution, we still need context display and description
|
|
||||||
const commandDisplay = (
|
|
||||||
<Text color={Colors.AccentCyan}>{executionProps.command}</Text>
|
|
||||||
);
|
|
||||||
|
|
||||||
// Combine command and description into bodyContent for layout consistency
|
|
||||||
bodyContent = (
|
bodyContent = (
|
||||||
<Box flexDirection="column">
|
<Box flexDirection="column">
|
||||||
<Box paddingX={1} marginLeft={1}>
|
<Box paddingX={1} marginLeft={1}>
|
||||||
{commandDisplay}
|
<Text color={Colors.AccentCyan}>{executionProps.command}</Text>
|
||||||
</Box>
|
</Box>
|
||||||
</Box>
|
</Box>
|
||||||
);
|
);
|
||||||
|
|
||||||
question = `Allow execution?`;
|
question = `Allow execution?`;
|
||||||
const alwaysLabel = `Yes (always allow '${executionProps.rootCommand}' commands)`;
|
|
||||||
options.push(
|
options.push(
|
||||||
{
|
{
|
||||||
label: 'Yes',
|
label: 'Yes, allow once',
|
||||||
value: ToolConfirmationOutcome.ProceedOnce,
|
value: ToolConfirmationOutcome.ProceedOnce,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: alwaysLabel,
|
label: `Yes, allow always for ${executionProps.rootCommand} ...`,
|
||||||
value: ToolConfirmationOutcome.ProceedAlways,
|
value: ToolConfirmationOutcome.ProceedAlways,
|
||||||
},
|
},
|
||||||
{ label: 'No (esc)', value: ToolConfirmationOutcome.Cancel },
|
{ label: 'No (esc)', value: ToolConfirmationOutcome.Cancel },
|
||||||
|
|
|
@ -147,7 +147,7 @@ function createToolRegistry(config: Config): ToolRegistry {
|
||||||
|
|
||||||
// use ShellTool (next-gen TerminalTool) if environment variable is set
|
// use ShellTool (next-gen TerminalTool) if environment variable is set
|
||||||
if (process.env.SHELL_TOOL) {
|
if (process.env.SHELL_TOOL) {
|
||||||
tools.push(new ShellTool(targetDir, config));
|
tools.push(new ShellTool(config));
|
||||||
} else {
|
} else {
|
||||||
tools.push(new TerminalTool(targetDir, config));
|
tools.push(new TerminalTool(targetDir, config));
|
||||||
}
|
}
|
||||||
|
|
|
@ -4,10 +4,15 @@
|
||||||
* SPDX-License-Identifier: Apache-2.0
|
* SPDX-License-Identifier: Apache-2.0
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import path from 'path';
|
|
||||||
import fs from 'fs';
|
import fs from 'fs';
|
||||||
import { Config } from '../config/config.js';
|
import { Config } from '../config/config.js';
|
||||||
import { BaseTool, ToolResult } from './tools.js';
|
import {
|
||||||
|
BaseTool,
|
||||||
|
ToolResult,
|
||||||
|
ToolCallConfirmationDetails,
|
||||||
|
ToolExecuteConfirmationDetails,
|
||||||
|
ToolConfirmationOutcome,
|
||||||
|
} from './tools.js';
|
||||||
import toolParameterSchema from './shell.json' with { type: 'json' };
|
import toolParameterSchema from './shell.json' with { type: 'json' };
|
||||||
|
|
||||||
export interface ShellToolParams {
|
export interface ShellToolParams {
|
||||||
|
@ -17,10 +22,11 @@ export interface ShellToolParams {
|
||||||
|
|
||||||
export class ShellTool extends BaseTool<ShellToolParams, ToolResult> {
|
export class ShellTool extends BaseTool<ShellToolParams, ToolResult> {
|
||||||
static Name: string = 'execute_bash_command';
|
static Name: string = 'execute_bash_command';
|
||||||
private readonly rootDirectory: string;
|
|
||||||
private readonly config: Config;
|
private readonly config: Config;
|
||||||
|
private cwd: string;
|
||||||
|
private whitelist: Set<string> = new Set();
|
||||||
|
|
||||||
constructor(rootDirectory: string, config: Config) {
|
constructor(config: Config) {
|
||||||
const toolDisplayName = 'Shell';
|
const toolDisplayName = 'Shell';
|
||||||
const descriptionUrl = new URL('shell.md', import.meta.url);
|
const descriptionUrl = new URL('shell.md', import.meta.url);
|
||||||
const toolDescription = fs.readFileSync(descriptionUrl, 'utf-8');
|
const toolDescription = fs.readFileSync(descriptionUrl, 'utf-8');
|
||||||
|
@ -31,7 +37,41 @@ export class ShellTool extends BaseTool<ShellToolParams, ToolResult> {
|
||||||
toolParameterSchema,
|
toolParameterSchema,
|
||||||
);
|
);
|
||||||
this.config = config;
|
this.config = config;
|
||||||
this.rootDirectory = path.resolve(rootDirectory);
|
this.cwd = config.getTargetDir();
|
||||||
|
}
|
||||||
|
|
||||||
|
getDescription(params: ShellToolParams): string {
|
||||||
|
return params.description || `Execute \`${params.command}\` in ${this.cwd}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
validateToolParams(_params: ShellToolParams): string | null {
|
||||||
|
// TODO: validate the command here
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
async shouldConfirmExecute(
|
||||||
|
params: ShellToolParams,
|
||||||
|
): Promise<ToolCallConfirmationDetails | false> {
|
||||||
|
const rootCommand =
|
||||||
|
params.command
|
||||||
|
.trim()
|
||||||
|
.split(/[\s;&&|]+/)[0]
|
||||||
|
?.split(/[/\\]/)
|
||||||
|
.pop() || 'unknown';
|
||||||
|
if (this.whitelist.has(rootCommand)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
const confirmationDetails: ToolExecuteConfirmationDetails = {
|
||||||
|
title: 'Confirm Shell Command',
|
||||||
|
command: params.command,
|
||||||
|
rootCommand,
|
||||||
|
onConfirm: async (outcome: ToolConfirmationOutcome) => {
|
||||||
|
if (outcome === ToolConfirmationOutcome.ProceedAlways) {
|
||||||
|
this.whitelist.add(rootCommand);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
};
|
||||||
|
return confirmationDetails;
|
||||||
}
|
}
|
||||||
|
|
||||||
async execute(_params: ShellToolParams): Promise<ToolResult> {
|
async execute(_params: ShellToolParams): Promise<ToolResult> {
|
||||||
|
|
|
@ -253,12 +253,10 @@ Use this tool for running build steps (\`npm install\`, \`make\`), linters (\`es
|
||||||
if (this.shouldAlwaysExecuteCommands.get(rootCommand)) {
|
if (this.shouldAlwaysExecuteCommands.get(rootCommand)) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
const description = this.getDescription(params);
|
|
||||||
const confirmationDetails: ToolExecuteConfirmationDetails = {
|
const confirmationDetails: ToolExecuteConfirmationDetails = {
|
||||||
title: 'Confirm Shell Command',
|
title: 'Confirm Shell Command',
|
||||||
command: params.command,
|
command: params.command,
|
||||||
rootCommand,
|
rootCommand,
|
||||||
description: `Execute in '${this.currentCwd}':\n${description}`,
|
|
||||||
onConfirm: async (outcome: ToolConfirmationOutcome) => {
|
onConfirm: async (outcome: ToolConfirmationOutcome) => {
|
||||||
if (outcome === ToolConfirmationOutcome.ProceedAlways) {
|
if (outcome === ToolConfirmationOutcome.ProceedAlways) {
|
||||||
this.shouldAlwaysExecuteCommands.set(rootCommand, true);
|
this.shouldAlwaysExecuteCommands.set(rootCommand, true);
|
||||||
|
|
|
@ -181,7 +181,6 @@ export interface ToolExecuteConfirmationDetails
|
||||||
extends ToolCallConfirmationDetails {
|
extends ToolCallConfirmationDetails {
|
||||||
command: string;
|
command: string;
|
||||||
rootCommand: string;
|
rootCommand: string;
|
||||||
description: string;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export enum ToolConfirmationOutcome {
|
export enum ToolConfirmationOutcome {
|
||||||
|
|
Loading…
Reference in New Issue