chore: unify 'path' param name to 'file_path' for Text Editor API

Changes:
- Change parameter name from 'path' to 'file_path' in all APIs
- Update corresponding error messages
- Update test cases for consistency
- Fix input schema requirements

Author: Yoshihiro Takahara

src/mcp_text_editor/__init__.py

@@ -29,7 +29,7 @@ async def get_text_file_contents(
 async def insert_text_file_contents(request: Dict[str, Any]) -> Dict[str, Any]:
     """Insert text content before or after a specific line in a file."""
     return await _text_editor.insert_text_file_contents(
-        file_path=request["path"],
+        file_path=request["file_path"],
         file_hash=request["file_hash"],
         after=request.get("after"),
         before=request.get("before"),

src/mcp_text_editor/handlers/append_text_file_contents.py

@@ -52,14 +52,14 @@ def get_tool_description(self) -> Tool:
     async def run_tool(self, arguments: Dict[str, Any]) -> Sequence[TextContent]:
         """Execute the tool with given arguments."""
         try:
-            if "path" not in arguments:
-                raise RuntimeError("Missing required argument: path")
+            if "file_path" not in arguments:
+                raise RuntimeError("Missing required argument: file_path")
             if "contents" not in arguments:
                 raise RuntimeError("Missing required argument: contents")
             if "file_hash" not in arguments:
                 raise RuntimeError("Missing required argument: file_hash")
 
-            file_path = arguments["path"]
+            file_path = arguments["file_path"]
             if not os.path.isabs(file_path):
                 raise RuntimeError(f"File path must be absolute: {file_path}")
 

src/mcp_text_editor/handlers/create_text_file.py

@@ -29,7 +29,7 @@ def get_tool_description(self) -> Tool:
             inputSchema={
                 "type": "object",
                 "properties": {
-                    "path": {
+                    "file_path": {
                         "type": "string",
                         "description": "Path to the text file. File path must be absolute.",
                     },
@@ -50,12 +50,12 @@ def get_tool_description(self) -> Tool:
     async def run_tool(self, arguments: Dict[str, Any]) -> Sequence[TextContent]:
         """Execute the tool with given arguments."""
         try:
-            if "path" not in arguments:
-                raise RuntimeError("Missing required argument: path")
+            if "file_path" not in arguments:
+                raise RuntimeError("Missing required argument: file_path")
             if "contents" not in arguments:
                 raise RuntimeError("Missing required argument: contents")
 
-            file_path = arguments["path"]
+            file_path = arguments["file_path"]
             if not os.path.isabs(file_path):
                 raise RuntimeError(f"File path must be absolute: {file_path}")
 

src/mcp_text_editor/handlers/insert_text_file_contents.py

@@ -27,7 +27,7 @@ def get_tool_description(self) -> Tool:
             inputSchema={
                 "type": "object",
                 "properties": {
-                    "path": {
+                    "file_path": {
                         "type": "string",
                         "description": "Path to the text file. File path must be absolute.",
                     },
@@ -53,21 +53,21 @@ def get_tool_description(self) -> Tool:
                         "default": "utf-8",
                     },
                 },
-                "required": ["path", "file_hash", "contents"],
+                "required": ["file_path", "file_hash", "contents"],
             },
         )
 
     async def run_tool(self, arguments: Dict[str, Any]) -> Sequence[TextContent]:
         """Execute the tool with given arguments."""
         try:
-            if "path" not in arguments:
-                raise RuntimeError("Missing required argument: path")
+            if "file_path" not in arguments:
+                raise RuntimeError("Missing required argument: file_path")
             if "file_hash" not in arguments:
                 raise RuntimeError("Missing required argument: file_hash")
             if "contents" not in arguments:
                 raise RuntimeError("Missing required argument: contents")
 
-            file_path = arguments["path"]
+            file_path = arguments["file_path"]
             if not os.path.isabs(file_path):
                 raise RuntimeError(f"File path must be absolute: {file_path}")
 

tests/test_append_text_file.py

@@ -42,7 +42,7 @@ async def test_append_text_file_success(test_dir: str, cleanup_files: None) -> N
 
     # Append content using handler
     arguments: Dict[str, Any] = {
-        "path": test_file,
+        "file_path": test_file,
         "contents": append_content,
         "file_hash": file_hash,
     }
@@ -66,7 +66,7 @@ async def test_append_text_file_not_exists(test_dir: str, cleanup_files: None) -
 
     # Try to append to non-existent file
     arguments: Dict[str, Any] = {
-        "path": test_file,
+        "file_path": test_file,
         "contents": "Some content\n",
         "file_hash": "dummy_hash",
     }
@@ -91,7 +91,7 @@ async def test_append_text_file_hash_mismatch(
 
     # Try to append with incorrect hash
     arguments: Dict[str, Any] = {
-        "path": test_file,
+        "file_path": test_file,
         "contents": "New content\n",
         "file_hash": "incorrect_hash",
     }
@@ -108,7 +108,7 @@ async def test_append_text_file_relative_path(
 ) -> None:
     """Test attempting to append using a relative path."""
     arguments: Dict[str, Any] = {
-        "path": "relative_path.txt",
+        "file_path": "relative_path.txt",
         "contents": "Some content\n",
         "file_hash": "dummy_hash",
     }
@@ -125,19 +125,19 @@ async def test_append_text_file_missing_args() -> None:
     # Test missing path
     with pytest.raises(RuntimeError) as exc_info:
         await append_handler.run_tool({"contents": "content\n", "file_hash": "hash"})
-    assert "Missing required argument: path" in str(exc_info.value)
+    assert "Missing required argument: file_path" in str(exc_info.value)
 
     # Test missing contents
     with pytest.raises(RuntimeError) as exc_info:
         await append_handler.run_tool(
-            {"path": "/absolute/path.txt", "file_hash": "hash"}
+            {"file_path": "/absolute/path.txt", "file_hash": "hash"}
         )
     assert "Missing required argument: contents" in str(exc_info.value)
 
     # Test missing file_hash
     with pytest.raises(RuntimeError) as exc_info:
         await append_handler.run_tool(
-            {"path": "/absolute/path.txt", "contents": "content\n"}
+            {"file_path": "/absolute/path.txt", "contents": "content\n"}
         )
     assert "Missing required argument: file_hash" in str(exc_info.value)
 
@@ -163,7 +163,7 @@ async def test_append_text_file_custom_encoding(
 
     # Append content using handler with specified encoding
     arguments: Dict[str, Any] = {
-        "path": test_file,
+        "file_path": test_file,
         "contents": append_content,
         "file_hash": file_hash,
         "encoding": "utf-8",

tests/test_create_text_file.py

@@ -32,7 +32,7 @@ async def test_create_text_file_success(test_dir: str, cleanup_files: None) -> N
 
     # Create file using handler
     arguments: Dict[str, Any] = {
-        "path": test_file,
+        "file_path": test_file,
         "contents": content,
     }
     response = await create_file_handler.run_tool(arguments)
@@ -59,7 +59,7 @@ async def test_create_text_file_exists(test_dir: str, cleanup_files: None) -> No
 
     # Try to create file using handler
     arguments: Dict[str, Any] = {
-        "path": test_file,
+        "file_path": test_file,
         "contents": "New content\n",
     }
 
@@ -75,7 +75,7 @@ async def test_create_text_file_relative_path(
     """Test attempting to create a file with a relative path."""
     # Try to create file using relative path
     arguments: Dict[str, Any] = {
-        "path": "relative_path.txt",
+        "file_path": "relative_path.txt",
         "contents": "Some content\n",
     }
 
@@ -91,11 +91,11 @@ async def test_create_text_file_missing_args() -> None:
     # Test missing path
     with pytest.raises(RuntimeError) as exc_info:
         await create_file_handler.run_tool({"contents": "content\n"})
-    assert "Missing required argument: path" in str(exc_info.value)
+    assert "Missing required argument: file_path" in str(exc_info.value)
 
     # Test missing contents
     with pytest.raises(RuntimeError) as exc_info:
-        await create_file_handler.run_tool({"path": "/absolute/path.txt"})
+        await create_file_handler.run_tool({"file_path": "/absolute/path.txt"})
     assert "Missing required argument: contents" in str(exc_info.value)
 
 
@@ -109,7 +109,7 @@ async def test_create_text_file_custom_encoding(
 
     # Create file using handler with specified encoding
     arguments: Dict[str, Any] = {
-        "path": test_file,
+        "file_path": test_file,
         "contents": content,
         "encoding": "utf-8",
     }

tests/test_insert_text_file.py

@@ -23,7 +23,7 @@ async def test_insert_after_line(tmp_path: Path) -> None:
     # Insert text after line 2
     result = await insert_text_file_contents(
         {
-            "path": str(test_file),
+            "file_path": str(test_file),
             "file_hash": file_hash,
             "after": 2,
             "contents": "new_line\n",
@@ -54,7 +54,7 @@ async def test_insert_before_line(tmp_path: Path) -> None:
     # Insert text before line 2
     result = await insert_text_file_contents(
         {
-            "path": str(test_file),
+            "file_path": str(test_file),
             "file_hash": file_hash,
             "before": 2,
             "contents": "new_line\n",
@@ -85,7 +85,7 @@ async def test_insert_beyond_file_end(tmp_path: Path) -> None:
     # Try to insert text after line 10 (file has only 3 lines)
     result = await insert_text_file_contents(
         {
-            "path": str(test_file),
+            "file_path": str(test_file),
             "file_hash": file_hash,
             "after": 10,
             "contents": "new_line\n",
@@ -102,7 +102,7 @@ async def test_file_not_found(tmp_path: Path) -> None:
     # Try to insert text into a non-existent file
     result = await insert_text_file_contents(
         {
-            "path": str(tmp_path / "nonexistent.txt"),
+            "file_path": str(tmp_path / "nonexistent.txt"),
             "file_hash": "any_hash",
             "after": 1,
             "contents": "new_line\n",
@@ -123,7 +123,7 @@ async def test_hash_mismatch(tmp_path: Path) -> None:
     # Try to insert text with incorrect hash
     result = await insert_text_file_contents(
         {
-            "path": str(test_file),
+            "file_path": str(test_file),
             "file_hash": "incorrect_hash",
             "after": 1,
             "contents": "new_line\n",

tests/test_insert_text_file_handler.py

@@ -19,23 +19,23 @@ def handler():
 
 @pytest.mark.asyncio
 async def test_missing_path(handler):
-    """Test handling of missing path argument."""
-    with pytest.raises(RuntimeError, match="Missing required argument: path"):
+    """Test handling of missing file_path argument."""
+    with pytest.raises(RuntimeError, match="Missing required argument: file_path"):
         await handler.run_tool({"file_hash": "hash", "contents": "content"})
 
 
 @pytest.mark.asyncio
 async def test_missing_hash(handler):
     """Test handling of missing file_hash argument."""
     with pytest.raises(RuntimeError, match="Missing required argument: file_hash"):
-        await handler.run_tool({"path": "/tmp/test.txt", "contents": "content"})
+        await handler.run_tool({"file_path": "/tmp/test.txt", "contents": "content"})
 
 
 @pytest.mark.asyncio
 async def test_missing_contents(handler):
     """Test handling of missing contents argument."""
     with pytest.raises(RuntimeError, match="Missing required argument: contents"):
-        await handler.run_tool({"path": "/tmp/test.txt", "file_hash": "hash"})
+        await handler.run_tool({"file_path": "/tmp/test.txt", "file_hash": "hash"})
 
 
 @pytest.mark.asyncio
@@ -44,7 +44,7 @@ async def test_relative_path(handler):
     with pytest.raises(RuntimeError, match="File path must be absolute"):
         await handler.run_tool(
             {
-                "path": "relative/path.txt",
+                "file_path": "relative/path.txt",
                 "file_hash": "hash",
                 "contents": "content",
                 "before": 1,
@@ -59,7 +59,7 @@ async def test_neither_before_nor_after(handler):
         RuntimeError, match="Exactly one of 'before' or 'after' must be specified"
     ):
         await handler.run_tool(
-            {"path": "/tmp/test.txt", "file_hash": "hash", "contents": "content"}
+            {"file_path": "/tmp/test.txt", "file_hash": "hash", "contents": "content"}
         )
 
 
@@ -71,7 +71,7 @@ async def test_both_before_and_after(handler):
     ):
         await handler.run_tool(
             {
-                "path": "/tmp/test.txt",
+                "file_path": "/tmp/test.txt",
                 "file_hash": "hash",
                 "contents": "content",
                 "before": 1,
@@ -95,7 +95,7 @@ async def test_successful_insert_before(handler, tmp_path):
 
     result = await handler.run_tool(
         {
-            "path": file_path,
+            "file_path": file_path,
             "file_hash": init_hash,
             "contents": "new_line\n",
             "before": 2,