Improve apply_diff tool description with examples#9424
Closed
daniel-lxs wants to merge 1 commit intomainfrom
Closed
Improve apply_diff tool description with examples#9424daniel-lxs wants to merge 1 commit intomainfrom
daniel-lxs wants to merge 1 commit intomainfrom
Conversation
- Add explicit format documentation showing structure directly - Include concrete examples (single and multiple edits) - Simplify structure explanation (removed verbose 'then this, then that') - Add critical warning about single '=======' separator - Clarify start_line uses actual numbers in examples This addresses agent confusion similar to read_file improvements.
Contributor
Review completed. No issues found - the changes are documentation improvements that enhance clarity without introducing bugs or functional problems. Mention @roomote in a comment to request specific changes to this pull request or fix all unresolved issues. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Enhances the native
apply_difftool definition by adding concrete examples and clearer documentation to reduce agent confusion when using the tool.Changes
{ path: 'src/utils.ts', diff: '<<<<<<< SEARCH\\n:start_line:5\\n-------\\nfunction add(a, b) {...' }:start_line:5, not:start_line:[5])Motivation
The native tool definition was missing concrete examples that the XML version had, which likely caused agents to:
:start_line:[5]instead of actual numbersThis brings the native version closer to the clarity of the XML version without changing the schema structure.
Testing
Related
Important
Enhances
apply_difftool documentation with examples and clearer instructions to reduce user confusion.apply_difftool description.apply_diff.:start_line:5).This description was created by
for 74bed82. You can customize this summary. It will automatically update as commits are pushed.