1059166cb1
- edit tool: add the read-before-edit requirement to the model-facing prompt (with the just-created/edited-this-session exception), matching write's guidance so the model doesn't only learn it via a failed FS_NOT_OBSERVED call. - fsspec-style-fs-seam RFC: correct the acceptance criteria that still claimed a ctx.fileContext service and a fileContext inject — the landed design is the fs/* event gate with the tool injecting fs. - filesystem-tool-schemas RFC: replace the stale "prior full file state" edit requirement with version-freshness wording (any windowed read authorizes a fresh edit; no partial-view flag).
96 lines
4.6 KiB
TypeScript
96 lines
4.6 KiB
TypeScript
/**
|
|
* The model-facing `edit` tool: update an existing UTF-8 text file by replacing
|
|
* literal text, requiring a unique match by default. The tool is the executor:
|
|
* it dispatches the `fs/edit-expectation` waterfall to obtain the optional
|
|
* version guard, calls `ctx.fs.editText` directly, and emits a contained
|
|
* `fs/observed`. The default thunk returns `undefined` (unconditional edit of
|
|
* the current content — the bare provider); a policy plugin
|
|
* (`@deepseek-ai/dsh-file-context`) occupies the single decision slot, returning
|
|
* `{ version: vObserved }` or throwing `FS_NOT_OBSERVED` for an unread file. The
|
|
* tool stats ZERO times either way; a missing target is reported by the provider
|
|
* as `FS_STALE_VERSION`.
|
|
*
|
|
* @module @deepseek-ai/dsh-tool-fs/edit
|
|
*/
|
|
|
|
import type { Context } from 'cordis'
|
|
import { defineTool } from '@deepseek-ai/dsh-tools'
|
|
import type { ContentBlock } from '@deepseek-ai/dsh-llm'
|
|
import type { FsEditOutcome } from '@deepseek-ai/dsh-fs'
|
|
import type {} from '@deepseek-ai/dsh-fs'
|
|
import type {} from '@deepseek-ai/dsh-system-prompt'
|
|
import { emitObserved } from './observe.ts'
|
|
|
|
/** Validated `edit` arguments after defaulting. */
|
|
interface EditInput {
|
|
filePath: string
|
|
oldString: string
|
|
newString: string
|
|
replaceAll: boolean
|
|
}
|
|
|
|
/** Validate value constraints the schema DSL can't express. */
|
|
export function parseEditArgs(args: { file_path: string; old_string: string; new_string: string; replace_all?: boolean }): EditInput {
|
|
if (args.file_path.trim().length === 0) throw new Error('file_path must be a non-empty string')
|
|
if (args.old_string.length === 0) throw new Error('old_string must be a non-empty string')
|
|
if (args.old_string === args.new_string) throw new Error('old_string and new_string must differ')
|
|
return {
|
|
filePath: args.file_path,
|
|
oldString: args.old_string,
|
|
newString: args.new_string,
|
|
replaceAll: args.replace_all ?? false,
|
|
}
|
|
}
|
|
|
|
/** Format an edit outcome as a Claude-style model-facing success message. */
|
|
export function formatEditOutput(displayPath: string, outcome: FsEditOutcome): string {
|
|
return outcome.replaceAll
|
|
? `The file ${displayPath} has been updated. All occurrences were successfully replaced.`
|
|
: `The file ${displayPath} has been updated successfully.`
|
|
}
|
|
|
|
/** Register the `edit` tool and its system-prompt guidance. */
|
|
export function apply(ctx: Context): void {
|
|
ctx.systemPrompt.section({
|
|
name: 'tool:edit',
|
|
order: 102,
|
|
text: 'Use the edit tool for targeted changes to existing UTF-8 text files. It replaces literal old_string with new_string; by default old_string must appear exactly once. If old_string appears multiple times, provide a more specific old_string or set replace_all to true. Read the file first (the default file-context policy requires it), unless you just created or edited it in this session.',
|
|
})
|
|
|
|
ctx.tools.register(defineTool({
|
|
name: 'edit',
|
|
description: 'Edit an existing UTF-8 text file by replacing literal text.',
|
|
parameters: {
|
|
file_path: { type: 'string', required: true, description: 'Path to edit, resolved by the filesystem backend.' },
|
|
old_string: { type: 'string', required: true, description: 'Literal text to replace. Must match exactly.' },
|
|
new_string: { type: 'string', required: true, description: 'Literal replacement text. Use an empty string to delete the match.' },
|
|
replace_all: { type: 'boolean', description: 'Replace all matches. Defaults to false; when false, old_string must appear exactly once.' },
|
|
},
|
|
async execute(args, exec): Promise<ContentBlock[]> {
|
|
const input = parseEditArgs(args)
|
|
const target = await ctx.fs.resolve(input.filePath)
|
|
// Single-slot decision: the policy plugin returns { version: vObserved } or
|
|
// throws FS_NOT_OBSERVED; the bare default is undefined (unconditional edit).
|
|
// No stat — the bare default never manufactures a version basis.
|
|
const expectation = await ctx.waterfall('fs/edit-expectation', target, exec, () => undefined)
|
|
const outcome = await ctx.fs.editText(
|
|
target,
|
|
{ oldString: input.oldString, newString: input.newString, replaceAll: input.replaceAll },
|
|
expectation,
|
|
exec.signal,
|
|
)
|
|
emitObserved(ctx, target, outcome.version, exec)
|
|
return [{ type: 'text', text: formatEditOutput(target.displayPath, outcome) }]
|
|
},
|
|
}))
|
|
}
|
|
|
|
/** Cordis plugin name used by loader diagnostics. */
|
|
export const name = 'fs-edit'
|
|
|
|
/** Services required by the `edit` tool plugin. */
|
|
export const inject = ['tools', 'fs', 'systemPrompt']
|
|
|
|
/** Named helper for direct registration in the root plugin and tests. */
|
|
export const applyEditTool = apply
|