ZIm/crates/assistant_tools/src/edit_files_tool/description.md
Agus Zubiaga 408e157d0f
assistant edit tool: Reliability improvements (#27431)
- Add instructions in description to read before editing
- Add instructions in edit prefix to explicitly ask for reads
- Fix `connection error: delay between messages too long` by processing
chunks off a channel

Release Notes:

- N/A
2025-03-25 12:34:01 -03:00

949 B

Edit files in the current project by specifying instructions in natural language.

When using this tool, you should suggest one coherent edit that can be made to the codebase.

When the set of edits you want to make is large or complex, feel free to invoke this tool multiple times, each time focusing on a specific change you wanna make.

You should use this tool when you want to edit a subset of a file's contents, but not the entire file. You should not use this tool when you want to replace the entire contents of a file with completely different contents, and you absolutely must never use this tool to create new files from scratch. If you ever consider using this tool to create a new file from scratch, for any reason, instead you must reconsider and choose a different approach.

DO NOT call this tool until the code to be edited appears in the conversation! You must use the read-files tool or ask the user to add it to context first.