shumengya/sproutclaw
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix(coding-agent): built-in tools work like extension tools

Browse Source 
Export readToolDefinition / createReadToolDefinition and the equivalent built-in ToolDefinition APIs from @mariozechner/pi-coding-agent.
This commit is contained in:
Mario Zechner
2026-03-22 04:20:28 +01:00
parent 80f527ec22
commit 235b247f1f
32 changed files with 2594 additions and 1408 deletions
Download Patch File Download Diff File Expand all files Collapse all files

151
packages/coding-agent/src/core/tools/edit.ts
View File

@@ -1,9 +1,15 @@
import type { AgentTool } from "@mariozechner/pi-agent-core";
import { Container, Text } from "@mariozechner/pi-tui";
import { type Static, Type } from "@sinclair/typebox";
import { constants } from "fs";
import { access as fsAccess, readFile as fsReadFile, writeFile as fsWriteFile } from "fs/promises";
import { renderDiff } from "../../modes/interactive/components/diff.js";
import type { ToolDefinition } from "../extensions/types.js";
import {
computeEditDiff,
detectLineEnding,
type EditDiffError,
type EditDiffResult,
fuzzyFindText,
generateDiffString,
normalizeForFuzzyMatch,
@@ -13,6 +19,13 @@ import {
} from "./edit-diff.js";
import { withFileMutationQueue } from "./file-mutation-queue.js";
import { resolveToCwd } from "./path-utils.js";
import { invalidArgText, shortenPath, str } from "./render-utils.js";
import { wrapToolDefinition } from "./tool-definition-wrapper.js";
type EditRenderState = {
argsKey?: string;
preview?: EditDiffResult | EditDiffError;
};
const editSchema = Type.Object({
path: Type.String({ description: "Path to the file to edit (relative or absolute)" }),
@@ -31,7 +44,7 @@ export interface EditToolDetails {
/**
* Pluggable operations for the edit tool.
* Override these to delegate file editing to remote systems (e.g., SSH).
* Override these to delegate file editing to remote systems (for example SSH).
*/
export interface EditOperations {
/** Read file contents as a Buffer */
@@ -53,20 +66,75 @@ export interface EditToolOptions {
operations?: EditOperations;
}
export function createEditTool(cwd: string, options?: EditToolOptions): AgentTool<typeof editSchema> {
const ops = options?.operations ?? defaultEditOperations;
function formatEditCall(
args: { path?: string; file_path?: string; oldText?: string; newText?: string } | undefined,
state: EditRenderState,
theme: typeof import("../../modes/interactive/theme/theme.js").theme,
): string {
const invalidArg = invalidArgText(theme);
const rawPath = str(args?.file_path ?? args?.path);
const path = rawPath !== null ? shortenPath(rawPath) : null;
const pathDisplay = path === null ? invalidArg : path ? theme.fg("accent", path) : theme.fg("toolOutput", "...");
let text = `${theme.fg("toolTitle", theme.bold("edit"))} ${pathDisplay}`;
if (state.preview) {
if ("error" in state.preview) {
text += `\n\n${theme.fg("error", state.preview.error)}`;
} else if (state.preview.diff) {
text += `\n\n${renderDiff(state.preview.diff, { filePath: rawPath ?? undefined })}`;
}
}
return text;
}
function formatEditResult(
args: { path?: string; file_path?: string; oldText?: string; newText?: string } | undefined,
state: EditRenderState,
result: {
content: Array<{ type: string; text?: string; data?: string; mimeType?: string }>;
details?: EditToolDetails;
},
theme: typeof import("../../modes/interactive/theme/theme.js").theme,
isError: boolean,
): string | undefined {
const rawPath = str(args?.file_path ?? args?.path);
if (isError) {
const errorText = result.content
.filter((c) => c.type === "text")
.map((c) => c.text || "")
.join("\n");
return errorText ? `\n${theme.fg("error", errorText)}` : undefined;
}
const previewDiff = state.preview && !("error" in state.preview) ? state.preview.diff : undefined;
const resultDiff = result.details?.diff;
if (!resultDiff || resultDiff === previewDiff) {
return undefined;
}
return `\n${renderDiff(resultDiff, { filePath: rawPath ?? undefined })}`;
}
export function createEditToolDefinition(
cwd: string,
options?: EditToolOptions,
): ToolDefinition<typeof editSchema, EditToolDetails | undefined, EditRenderState> {
const ops = options?.operations ?? defaultEditOperations;
return {
name: "edit",
label: "edit",
description:
"Edit a file by replacing exact text. The oldText must match exactly (including whitespace). Use this for precise, surgical edits.",
promptSnippet: "Make surgical edits to files (find exact text and replace)",
promptGuidelines: ["Use edit for precise changes (old text must match exactly)."],
parameters: editSchema,
execute: async (
_toolCallId: string,
async execute(
_toolCallId,
{ path, oldText, newText }: { path: string; oldText: string; newText: string },
signal?: AbortSignal,
) => {
_onUpdate?,
_ctx?,
) {
const absolutePath = resolveToCwd(path, cwd);
return withFileMutationQueue(
@@ -76,7 +144,7 @@ export function createEditTool(cwd: string, options?: EditToolOptions): AgentToo
content: Array<{ type: "text"; text: string }>;
details: EditToolDetails | undefined;
}>((resolve, reject) => {
// Check if already aborted
// Check if already aborted.
if (signal?.aborted) {
reject(new Error("Operation aborted"));
return;
@@ -84,7 +152,7 @@ export function createEditTool(cwd: string, options?: EditToolOptions): AgentToo
let aborted = false;
// Set up abort handler
// Set up abort handler.
const onAbort = () => {
aborted = true;
reject(new Error("Operation aborted"));
@@ -94,10 +162,10 @@ export function createEditTool(cwd: string, options?: EditToolOptions): AgentToo
signal.addEventListener("abort", onAbort, { once: true });
}
// Perform the edit operation
// Perform the edit operation.
(async () => {
try {
// Check if file exists
// Check if file exists.
try {
await ops.access(absolutePath);
} catch {
@@ -108,21 +176,21 @@ export function createEditTool(cwd: string, options?: EditToolOptions): AgentToo
return;
}
// Check if aborted before reading
// Check if aborted before reading.
if (aborted) {
return;
}
// Read the file
// Read the file.
const buffer = await ops.readFile(absolutePath);
const rawContent = buffer.toString("utf-8");
// Check if aborted after reading
// Check if aborted after reading.
if (aborted) {
return;
}
// Strip BOM before matching (LLM won't include invisible BOM in oldText)
// Strip BOM before matching. The model will not include an invisible BOM in oldText.
const { bom, text: content } = stripBom(rawContent);
const originalEnding = detectLineEnding(content);
@@ -130,7 +198,7 @@ export function createEditTool(cwd: string, options?: EditToolOptions): AgentToo
const normalizedOldText = normalizeToLF(oldText);
const normalizedNewText = normalizeToLF(newText);
// Find the old text using fuzzy matching (tries exact match first, then fuzzy)
// Find the old text using fuzzy matching. This tries exact match first, then a normalized fallback.
const matchResult = fuzzyFindText(normalizedContent, normalizedOldText);
if (!matchResult.found) {
@@ -145,7 +213,7 @@ export function createEditTool(cwd: string, options?: EditToolOptions): AgentToo
return;
}
// Count occurrences using fuzzy-normalized content for consistency
// Count occurrences using fuzzy-normalized content for consistency with the matcher.
const fuzzyContent = normalizeForFuzzyMatch(normalizedContent);
const fuzzyOldText = normalizeForFuzzyMatch(normalizedOldText);
const occurrences = fuzzyContent.split(fuzzyOldText).length - 1;
@@ -162,20 +230,20 @@ export function createEditTool(cwd: string, options?: EditToolOptions): AgentToo
return;
}
// Check if aborted before writing
// Check if aborted before writing.
if (aborted) {
return;
}
// Perform replacement using the matched text position
// When fuzzy matching was used, contentForReplacement is the normalized version
// Perform replacement using the matched text position.
// When fuzzy matching was used, contentForReplacement is the normalized version.
const baseContent = matchResult.contentForReplacement;
const newContent =
baseContent.substring(0, matchResult.index) +
normalizedNewText +
baseContent.substring(matchResult.index + matchResult.matchLength);
// Verify the replacement actually changed something
// Verify the replacement actually changed something.
if (baseContent === newContent) {
if (signal) {
signal.removeEventListener("abort", onAbort);
@@ -191,12 +259,12 @@ export function createEditTool(cwd: string, options?: EditToolOptions): AgentToo
const finalContent = bom + restoreLineEndings(newContent, originalEnding);
await ops.writeFile(absolutePath, finalContent);
// Check if aborted after writing
// Check if aborted after writing.
if (aborted) {
return;
}
// Clean up abort handler
// Clean up abort handler.
if (signal) {
signal.removeEventListener("abort", onAbort);
}
@@ -212,7 +280,7 @@ export function createEditTool(cwd: string, options?: EditToolOptions): AgentToo
details: { diff: diffResult.diff, firstChangedLine: diffResult.firstChangedLine },
});
} catch (error: any) {
// Clean up abort handler
// Clean up abort handler.
if (signal) {
signal.removeEventListener("abort", onAbort);
}
@@ -225,8 +293,43 @@ export function createEditTool(cwd: string, options?: EditToolOptions): AgentToo
}),
);
},
renderCall(args, theme, context) {
const isSingleMode =
typeof args?.path === "string" && typeof args?.oldText === "string" && typeof args?.newText === "string";
if (context.argsComplete && isSingleMode) {
const argsKey = JSON.stringify({ path: args.path, oldText: args.oldText, newText: args.newText });
if (context.state.argsKey !== argsKey) {
context.state.argsKey = argsKey;
computeEditDiff(args.path!, args.oldText!, args.newText!, context.cwd).then((preview) => {
if (context.state.argsKey === argsKey) {
context.state.preview = preview;
context.invalidate();
}
});
}
}
const text = (context.lastComponent as Text | undefined) ?? new Text("", 0, 0);
text.setText(formatEditCall(args, context.state, theme));
return text;
},
renderResult(result, _options, theme, context) {
const output = formatEditResult(context.args, context.state, result as any, theme, context.isError);
if (!output) {
const component = (context.lastComponent as Container | undefined) ?? new Container();
component.clear();
return component;
}
const text = (context.lastComponent as Text | undefined) ?? new Text("", 0, 0);
text.setText(output);
return text;
},
};
}
/** Default edit tool using process.cwd() - for backwards compatibility */
export function createEditTool(cwd: string, options?: EditToolOptions): AgentTool<typeof editSchema> {
return wrapToolDefinition(createEditToolDefinition(cwd, options));
}
/** Default edit tool using process.cwd() for backwards compatibility. */
export const editToolDefinition = createEditToolDefinition(process.cwd());
export const editTool = createEditTool(process.cwd());