editor mcp
A Python-based text editor server built with FastMCP that provides tools for file operations. This server enables reading, editing, and managing text files through a standardized API following a multi-step process.
A Python-based text editor server built with FastMCP that provides tools for file operations. This server enables reading, editing, and managing text files through a standardized API following a multi-step process.
A Python-based text editor server built with FastMCP that provides powerful tools for file operations. This server enables reading, editing, and managing text files through a standardized API with a unique multi-step approach that significantly improves code editing accuracy and reliability for LLMs and AI assistants.
skim
read
find_line
find_function
listdir
run_tests
The editor-mcp includes powerful capabilities that come with certain security considerations:
To mitigate these risks:
PROTECTED_PATHS
environment variable to restrict access to sensitive files and directories.This text editor's unique design solves critical problems that typically affect LLM code editing:
Prevents Loss of Context - Traditional approaches often lead to LLMs losing overview of the codebase after a few edits. This implementation maintains context through the multi-step process.
Avoids Resource-Intensive Rewrites - LLMs typically default to replacing entire files when confused, which is costly, slow, and inefficient. This editor enforces selective edits.
Provides Visual Feedback - The diff preview system allows the LLM to actually see and verify changes before committing them, dramatically reducing errors.
Enforces Syntax Checking - Automatic validation for Python and JavaScript/React ensures that broken code isn't committed.
Improves Edit Reasoning - The multi-step approach gives the LLM time to reason between steps, reducing haphazard token production.
The editor implements several safeguards to ensure system stability and prevent resource exhaustion:
This MCP was developed and tested with Claude Desktop. You can download Claude Desktop on any platform. For Claude Desktop on Linux, you can use an unofficial installation script (uses the official file), recommended repository: https://github.com/emsi/claude-desktop/tree/main
Once you have Claude Desktop installed, follow the instructions below to install this specific MCP:
The easiest way to install the Editor MCP is using the provided installation script:
# Clone the repository
git clone https://github.com/danielpodrazka/editor-mcp.git
cd editor-mcp
# Run the installation script
chmod +x install.sh
./install.sh
This script will:
1. Check if UVX is installed and install it if necessary
2. Install the Editor MCP in development mode
3. Make the editor-mcp
command available in your PATH
# Install directly from GitHub
uvx install git+https://github.com/danielpodrazka/mcp-text-editor.git
# Or install from a local clone
git clone https://github.com/danielpodrazka/mcp-text-editor.git
cd mcp-text-editor
uvx install -e .
pip install git+https://github.com/danielpodrazka/mcp-text-editor.git
# Or from a local clone
git clone https://github.com/danielpodrazka/mcp-text-editor.git
cd mcp-text-editor
pip install -e .
Install from the lock file:
uv pip install -r uv.lock
uv pip compile requirements.in -o uv.lock
After installation, you can start the Editor MCP server using one of these methods:
# Using the installed script
editor-mcp
# Or using the Python module
python -m text_editor.server
You can add the Editor MCP to your MCP configuration file:
{
"mcpServers": {
"text-editor": {
"command": "editor-mcp",
"env": {
"MAX_SELECT_LINES": "100",
"ENABLE_JS_SYNTAX_CHECK": "0",
"FAIL_ON_PYTHON_SYNTAX_ERROR": "1",
"FAIL_ON_JS_SYNTAX_ERROR": "0",
"PROTECTED_PATHS": "*.env,.env*,config*.json,*secret*,/etc/passwd,/home/user/.ssh/id_rsa"
}
}
}
}
The Editor MCP supports several environment variables to customize its behavior:
MAX_SELECT_LINES: "100" - Maximum number of lines that can be edited in a single operation (default is 50)
ENABLE_JS_SYNTAX_CHECK: "0" - Enable/disable JavaScript and JSX syntax checking (default is "1" - enabled)
FAIL_ON_PYTHON_SYNTAX_ERROR: "1" - When enabled, Python syntax errors will automatically cancel the overwrite operation (default is enabled)
FAIL_ON_JS_SYNTAX_ERROR: "0" - When enabled, JavaScript/JSX syntax errors will automatically cancel the overwrite operation (default is disabled)
PROTECTED_PATHS: Comma-separated list of file patterns or paths that cannot be accessed, supporting wildcards (e.g., ".env,.env,/etc/passwd")
{
"mcpServers": {
"text-editor": {
"command": "/home/daniel/pp/venvs/editor-mcp/bin/python",
"args": ["/home/daniel/pp/editor-mcp/src/text_editor/server.py"],
"env": {
"MAX_SELECT_LINES": "100",
"ENABLE_JS_SYNTAX_CHECK": "0",
"FAIL_ON_PYTHON_SYNTAX_ERROR": "1",
"FAIL_ON_JS_SYNTAX_ERROR": "0",
"PROTECTED_PATHS": "*.env,.env*,config*.json,*secret*,/etc/passwd,/home/user/.ssh/id_rsa"
}
}
}
}
The Editor MCP provides 13 powerful tools for file manipulation, editing, and testing:
set_file
Sets the current file to work with.
Parameters:
- filepath
(str): Absolute path to the file
Returns: - Confirmation message with the file path
skim
Reads full text from the current file. Each line is prefixed with its line number.
Returns: - Dictionary containing lines with their line numbers, total number of lines, and the max edit lines setting
Example output:
{
"lines": [
[1, "def hello():"],
[2, " print("Hello, world!")"],
[3, ""],
[4, "hello()"]
],
"total_lines": 4,
"max_select_lines": 50
}
read
Reads text from the current file from start line to end line.
Parameters:
- start
(int): Start line number (1-based indexing)
- end
(int): End line number (1-based indexing)
Returns: - Dictionary containing lines with their line numbers as keys, along with start and end line information
Example output:
{
"lines": [
[1, "def hello():"],
[2, " print("Hello, world!")"],
[3, ""],
[4, "hello()"]
],
"start_line": 1,
"end_line": 4
}
select
Select a range of lines from the current file for subsequent overwrite operation.
Parameters:
- start
(int): Start line number (1-based)
- end
(int): End line number (1-based)
Returns: - Dictionary containing the selected lines, line range, and ID for verification
Note: - This tool validates the selection against max_select_lines - The selection details are stored for use in the overwrite tool - This must be used before calling the overwrite tool
overwrite
Prepare to overwrite a range of lines in the current file with new text.
Parameters:
- new_lines
(list): List of new lines to overwrite the selected range
Returns: - Diff preview showing the proposed changes
Note:
- This is the first step in a two-step process:
1. First call overwrite() to generate a diff preview
2. Then call confirm() to apply or cancel() to discard the pending changes
- This tool allows replacing the previously selected lines with new content
- The number of new lines can differ from the original selection
- For Python files (.py extension), syntax checking is performed before writing
- For JavaScript/React files (.js, .jsx extensions), syntax checking is optional and can be disabled via the ENABLE_JS_SYNTAX_CHECK
environment variable
confirm
Apply pending changes from the overwrite operation.
Returns: - Operation result with status and message
Note: - This is one of the two possible actions in the second step of the editing process - The selection is removed upon successful application of changes
cancel
Discard pending changes from the overwrite operation.
Returns: - Operation result with status and message
Note: - This is one of the two possible actions in the second step of the editing process - The selection remains intact when changes are cancelled
delete_file
Delete the currently set file.
Returns: - Operation result with status and message
new_file
Creates a new file.
Parameters:
- absolute_file_path
(str): Path of the new file
Returns: - Operation result with status and id of the content if applicable
Note: - This tool will fail if the current file exists and is not empty
find_line
Find lines that match provided text in the current file.
Parameters:
- search_text
(str): Text to search for in the file
Returns: - Dictionary containing matching lines with their line numbers and total matches
Example output:
{
"status": "success",
"matches": [
[2, " print("Hello, world!")"]
],
"total_matches": 1
}
Note: - Returns an error if no file path is set - Searches for exact text matches within each line - The id can be used for subsequent edit operations
find_function
Find a function or method definition in the current Python or JavaScript/JSX file.
Parameters:
- function_name
(str): Name of the function or method to find
Returns: - Dictionary containing the function lines with their line numbers, start_line, and end_line
Example output:
{
"status": "success",
"lines": [
[10, "def hello():"],
[11, " print("Hello, world!")"],
[12, " return True"]
],
"start_line": 10,
"end_line": 12
}
Note: - For Python files, this tool uses Python's AST and tokenize modules to accurately identify function boundaries including decorators and docstrings - For JavaScript/JSX files, this tool uses a combination of approaches: - Primary method: Babel AST parsing when available (requires Node.js and Babel packages) - Fallback method: Regex pattern matching for function declarations when Babel is unavailable - Supports various JavaScript function types including standard functions, async functions, arrow functions, and React hooks - Returns an error if no file path is set or if the function is not found
listdir
Lists the contents of a directory.
Parameters:
- dirpath
(str): Path to the directory to list
Returns: - Dictionary containing list of filenames and the path queried
run_tests
and set_python_path
Tools for running Python tests with pytest and configuring the Python environment.
- Set to "0", "false", or "no" to disable JavaScript syntax checking
- Useful if you don't have Babel and related dependencies installed
- FAIL_ON_PYTHON_SYNTAX_ERROR
: Controls whether Python syntax errors automatically cancel the overwrite operation (default: 1)
- When enabled, syntax errors in Python files will cause the overwrite action to be automatically cancelled
- The lines will remain selected so you can fix the error and try again
- FAIL_ON_JS_SYNTAX_ERROR
: Controls whether JavaScript/JSX syntax errors automatically cancel the overwrite operation (default: 0)
- When enabled, syntax errors in JavaScript/JSX files will cause the overwrite action to be automatically cancelled
- The lines will remain selected so you can fix the error and try again
- DUCKDB_USAGE_STATS
: Controls whether usage statistics are collected in a DuckDB database (default: 0)
- Set to "1", "true", or "yes" to enable collection of tool usage statistics
- When enabled, records information about each tool call including timestamps and arguments
- STATS_DB_PATH
: Path where the DuckDB database for statistics will be stored (default: "text_editor_stats.duckdb")
- Only used when DUCKDB_USAGE_STATS
is enabled
- PROTECTED_PATHS
: Comma-separated list of file patterns or absolute paths that will be denied access
- Example: *.env,.env*,config*.json,*secret*,/etc/passwd,/home/user/credentials.txt
- Supports both exact file paths and flexible glob patterns with wildcards in any position:
- *.env
- matches files ending with .env, like .env
, dev.env
, prod.env
- .env*
- matches files starting with .env, like .env
, .env.local
, .env.production
- *secret*
- matches any file containing 'secret' in the name
- Provides protection against accidentally exposing sensitive configuration files and credentials
- The lines will remain selected so you can fix the error and try again
The editor-mcp requires: - Python 3.7+ - FastMCP package - black (for Python code formatting checks) - Babel (for JavaScript/JSX syntax checks if working with those files)
Install development dependencies:
# Using pip
pip install pytest pytest-asyncio pytest-cov
# Using uv
uv pip install pytest pytest-asyncio pytest-cov
For JavaScript/JSX syntax validation, you need Node.js and Babel. The text editor uses npx babel
to check JS/JSX syntax when editing these file types:
# Required for JavaScript/JSX syntax checking
npm install --save-dev @babel/core @babel/cli @babel/preset-env @babel/preset-react
# You can also install these globally if you prefer
# npm install -g @babel/core @babel/cli @babel/preset-env @babel/preset-react
The editor requires:
- @babel/core
and @babel/cli
- Core Babel packages for syntax checking
- @babel/preset-env
- For standard JavaScript (.js) files
- @babel/preset-react
- For React JSX (.jsx) files
# Run tests
pytest -v
# Run tests with coverage
pytest -v --cov=text_editor
The test suite covers:
Setting non-existent files
read tool
Invalid range handling
select tool
Selection storage for subsequent operations
overwrite tool
Generation of diff preview for changes
confirm and cancel tools
Two-step verification process
delete_file tool
File deletion validation
new_file tool
Handling existing files
find_line tool
Unlike traditional code editing approaches where LLMs simply search for lines to edit and make replacements (often leading to confusion after multiple edits), this editor implements a structured multi-step workflow that dramatically improves editing accuracy:
This structured workflow forces the LLM to reason carefully about each edit and prevents common errors like accidentally overwriting entire files. By seeing previews of changes before committing them, the LLM can verify its edits are correct.
The server uses FastMCP to expose text editing capabilities through a well-defined API. The ID verification system ensures data integrity by verifying that the content hasn't changed between reading and modifying operations.
The ID mechanism uses SHA-256 to generate a unique identifier of the file content or selected line ranges. For line-specific operations, the ID includes a prefix indicating the line range (e.g., "L10-15-[hash]"). This helps ensure that edits are being applied to the expected content.
The main TextEditorServer
class:
max_select_lines
limit (default: 50) from environment variablesset_file
: Validates and sets the current file pathskim
: Reads the entire content of a file, returning a dictionary of line numbers to line textread
: Reads lines from specified line range, returning a structured dictionary of line contentselect
: Selects lines for subsequent overwrite operationoverwrite
: Takes a list of new lines and prepares diff preview for changing contentconfirm
: Applies pending changes from the overwrite operationcancel
: Discards pending changes from the overwrite operationdelete_file
: Deletes the current filenew_file
: Creates a new filefind_line
: Finds lines containing specific textfind_function
: Finds function or method definitions in Python and JavaScript/JSX fileslistdir
: Lists contents of a directoryrun_tests
and set_python_path
: Tools for running Python testsThe server runs using FastMCP's stdio transport by default, making it easy to integrate with various clients.
For optimal results with AI assistants, it's recommended to use the system prompt (see system_prompt.md) that helps guide the AI in making manageable, safe edits.
This system prompt helps the AI assistant:
By incorporating this system prompt when working with AI assistants, you'll get more reliable editing behavior and avoid common pitfalls in automated code editing.
The text editor MCP can collect usage statistics when enabled, providing insights into how the editing tools are being used:
DUCKDB_USAGE_STATS
is enabledSTATS_DB_PATH
The collected statistics can help understand usage patterns, identify common workflows, and optimize the editor for most frequent operations.
You can query the database using standard SQL via any DuckDB client to analyze usage patterns.
If you encounter issues:
Inspired by a similar project: https://github.com/tumf/mcp-text-editor, which at first I forked, however I decided to rewrite the whole codebase from scratch so only the general idea stayed the same.