Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix misleading edit_file functionality docs in filesystem README #589

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

g-votte
Copy link

@g-votte g-votte commented Feb 3, 2025

This PR updates the filesystem README by removing documentation of unsupported features and options.

Description

The following features and options of edit_file are no longer supported. This PR removes them from the README:

  • Fuzzy matching and debugging with confidence score
  • Options named preserveIndentation, normalizeWhitespace, and partialMatch

Server Details

  • Server: filesystem
  • Changes to: documentation (README)

Motivation and Context

The edit_file feature was introduced in #184, but a few functionalities had been dropped during the review process. Specifically the commit b477af5 dropped those functionalities in index.ts. However, the README documentation was left not to be updated.

The current documentation has been causing confusion among filesystem users (see #511). This PR updates the README to accurately reflect the current state of the feature.

How Has This Been Tested?

N/A (the change is only for README)

Breaking Changes

No breaking changes

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have read the MCP Protocol Documentation
  • My changes follows MCP security best practices
  • I have updated the server's README accordingly
  • I have tested this with an LLM client
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have documented all environment variables and configuration options

Additional context

N/A

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant