fix(filesystem): add guidance for failed edit matches#4501
Open
Joosboy wants to merge 1 commit into
Open
Conversation
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.
Description
Improves the filesystem server's
edit_filefailure message when an edit cannot be matched. The error now keeps the original failedoldTextcontext and adds a short hint to inspect the current file contents withread_filebefore retrying.Server Details
edit_fileerror handling and unit testsMotivation and Context
When
oldTextdoes not match the current file contents, the previous error only reported that no exact match was found. Issue #2034 describes this as difficult to recover from when the mismatch is caused by whitespace, indentation, or line-ending differences.This keeps the edit behavior unchanged and makes the failure easier to act on.
Refs #2034.
How Has This Been Tested?
npm test --workspace @modelcontextprotocol/server-filesystem -- __tests__/lib.test.tsnpm run build --workspace @modelcontextprotocol/server-filesystemBreaking Changes
No breaking changes.
Types of changes
Checklist
Additional context
The README and environment-variable checklist items are not applicable because this only changes an existing runtime error message and its test coverage.