File Edit Check MCP Server logo

File Edit Check MCP Server

by punkpeye

An MCP server that enforces pre-read checks and detailed commit documentation. It prevents blind modifications to files by requiring explicit read operations before any writes or diffs can be applied.

View on GitHub

Last updated: N/A

What is File Edit Check MCP Server?

This is an MCP server designed to enhance file modification safety and clarity by enforcing pre-read checks before any write or diff operations. It ensures that modifications are made with full awareness of the current file state and requires detailed commit messages.

How to use File Edit Check MCP Server?

To use this server, install it using npm install and npm run build. Then, add it to your MCP settings file, specifying the path to the built index.js file. Configure the command, args, disabled, and alwaysAllow properties as needed.

Key features of File Edit Check MCP Server

  • Enforces pre-read verification before file modifications

  • Prevents blind writes and diffs

  • Provides detailed commit message guidance

  • TypeScript implementation with proper error handling

Use cases of File Edit Check MCP Server

  • Preventing accidental overwrites of important files

  • Ensuring developers are aware of the latest file state before making changes

  • Improving the quality and detail of commit messages

  • Auditing file modifications for compliance purposes

FAQ from File Edit Check MCP Server

What is a pre-read check?

A pre-read check requires a file to be explicitly read before any modifications (writes or diffs) can be applied to it. This ensures the user is aware of the current file state.

Why is this server useful?

It helps prevent accidental overwrites, ensures developers are aware of the latest file state, improves commit message quality, and aids in auditing file modifications.

What tools does this server provide?

This server provides tools such as checked_read_file, checked_write_to_file, checked_apply_diff, and list_my_tools.

How do I install this server?

You can install this server by running npm install followed by npm run build in the server's directory.

How do I configure this server?

Configure the server by adding it to your MCP settings file, specifying the path to the built index.js file and configuring the command, args, disabled, and alwaysAllow properties.