Merge branch 'feature/specify-encoding' into develop

Author: tumf

Makefile

@@ -24,4 +24,4 @@ typecheck:
 # Run all checks required before pushing
 check:  lint typecheck test
 fix: check format
-all: format check
+all: format check coverage

README.md

@@ -47,6 +47,7 @@ MCP Text Editor Server is designed to facilitate safe and efficient line-based t
 - Read multiple ranges from multiple files in a single operation
 - Line-based patch application with correct handling of line number shifts
 - Edit text file contents with conflict detection
+- Flexible character encoding support (utf-8, shift_jis, latin1, etc.)
 - Support for multiple file operations
 - Proper handling of concurrent edits with hash-based validation
 - Memory-efficient processing of large files
@@ -143,6 +144,7 @@ Parameters:
 - `file_path`: Path to the text file
 - `line_start`/`start`: Line number to start from (1-based)
 - `line_end`/`end`: Line number to end at (inclusive, null for end of file)
+- `encoding`: File encoding (default: "utf-8"). Specify the encoding of the text file (e.g., "shift_jis", "latin1")
 
 **Single Range Response:**
 
@@ -238,6 +240,7 @@ Important Notes:
 3. Patches must not overlap within the same file
 4. Line numbers are 1-based
 5. If original content ends with newline, ensure patch content also ends with newline
+6. File encoding must match the encoding used in get_text_file_contents
 
 **Success Response:**
 
@@ -295,6 +298,7 @@ result = await edit_text_file_contents({
         {
             "path": "file.txt",
             "hash": contents["file.txt"][0]["hash"],
+            "encoding": "utf-8",  # Optional, defaults to "utf-8"
             "patches": [
                 {
                     "line_start": 5,
@@ -325,6 +329,7 @@ The server handles various error cases:
 - Hash mismatches (concurrent edit detection)
 - Invalid patch ranges
 - Overlapping patches
+- Encoding errors (when file cannot be decoded with specified encoding)
 - Line number out of bounds
 
 ## Security Considerations

src/mcp_text_editor/server.py

@@ -67,7 +67,12 @@ def get_tool_description(self) -> Tool:
                             },
                             "required": ["file_path", "ranges"],
                         },
-                    }
+                    },
+                    "encoding": {
+                        "type": "string",
+                        "description": "Text encoding (default: 'utf-8')",
+                        "default": "utf-8",
+                    },
                 },
                 "required": ["files"],
             },
@@ -81,7 +86,10 @@ async def run_tool(self, arguments: Dict[str, Any]) -> Sequence[TextContent]:
                 raise RuntimeError("Missing required argument: 'files'")
 
             # Handle request
-            result = await self.editor.read_multiple_ranges(arguments["files"])
+            encoding = arguments.get("encoding", "utf-8")
+            result = await self.editor.read_multiple_ranges(
+                arguments["files"], encoding=encoding
+            )
             response = result
 
             return [TextContent(type="text", text=json.dumps(response, indent=2))]
@@ -130,14 +138,23 @@ def get_tool_description(self) -> Tool:
                                                 "default": None,
                                             },
                                             "contents": {"type": "string"},
+                                            "range_hash": {
+                                                "type": "string",
+                                                "description": "Hash of the content being replaced (required except for new files and append operations)",
+                                            },
                                         },
                                         "required": ["contents"],
                                     },
                                 },
                             },
                             "required": ["path", "file_hash", "patches"],
                         },
-                    }
+                    },
+                    "encoding": {
+                        "type": "string",
+                        "description": "Text encoding (default: 'utf-8')",
+                        "default": "utf-8",
+                    },
                 },
                 "required": ["files"],
             },
@@ -189,8 +206,9 @@ async def run_tool(self, arguments: Dict[str, Any]) -> Sequence[TextContent]:
                         }
                         continue
 
+                    encoding = arguments.get("encoding", "utf-8")
                     result = await self.editor.edit_file_contents(
-                        file_path, file_hash, patches
+                        file_path, file_hash, patches, encoding=encoding
                     )
                     results[file_path] = result
                 except Exception as e: