hanzo-mcp 0.5.1__py3-none-any.whl → 0.6.1__py3-none-any.whl

hanzo_mcp/tools/editor/neovim_command.py

@@ -0,0 +1,272 @@
+"""Execute Neovim commands and macros."""
+
+import os
+import subprocess
+import shutil
+import tempfile
+from typing import Annotated, Optional, TypedDict, Unpack, final, override, List
+
+from mcp.server.fastmcp import Context as MCPContext
+from pydantic import Field
+
+from hanzo_mcp.tools.common.base import BaseTool
+from hanzo_mcp.tools.common.context import create_tool_context
+from hanzo_mcp.tools.common.permissions import PermissionManager
+
+
+Command = Annotated[
+    Optional[str],
+    Field(
+        description="Neovim command to execute (Ex commands like :w, :q, etc.)",
+        default=None,
+    ),
+]
+
+Commands = Annotated[
+    Optional[List[str]],
+    Field(
+        description="List of Neovim commands to execute in sequence",
+        default=None,
+    ),
+]
+
+Macro = Annotated[
+    Optional[str],
+    Field(
+        description="Vim macro to execute (e.g., 'dd' to delete line)",
+        default=None,
+    ),
+]
+
+FilePath = Annotated[
+    Optional[str],
+    Field(
+        description="File to operate on (optional, uses current buffer if not specified)",
+        default=None,
+    ),
+]
+
+SaveAfter = Annotated[
+    bool,
+    Field(
+        description="Save file after executing commands",
+        default=True,
+    ),
+]
+
+ReturnOutput = Annotated[
+    bool,
+    Field(
+        description="Return output/messages from Neovim",
+        default=True,
+    ),
+]
+
+
+class NeovimCommandParams(TypedDict, total=False):
+    """Parameters for Neovim command tool."""
+
+    command: Optional[str]
+    commands: Optional[List[str]]
+    macro: Optional[str]
+    file_path: Optional[str]
+    save_after: bool
+    return_output: bool
+
+
+@final
+class NeovimCommandTool(BaseTool):
+    """Tool for executing Neovim commands and macros."""
+
+    def __init__(self, permission_manager: PermissionManager):
+        """Initialize the Neovim command tool.
+
+        Args:
+            permission_manager: Permission manager for access control
+        """
+        self.permission_manager = permission_manager
+
+    @property
+    @override
+    def name(self) -> str:
+        """Get the tool name."""
+        return "neovim_command"
+
+    @property
+    @override
+    def description(self) -> str:
+        """Get the tool description."""
+        return """Execute Neovim commands and macros programmatically.
+
+Run Ex commands, normal mode commands, or complex macros in Neovim.
+Can operate on files without opening the editor interface.
+
+Examples:
+- neovim_command --command ":set number" --file-path main.py
+- neovim_command --command ":%s/old/new/g" --file-path config.json
+- neovim_command --commands ":set expandtab" ":retab" --file-path script.sh
+- neovim_command --macro "ggVG=" --file-path messy.py  # Format entire file
+- neovim_command --macro "dd10j" --file-path list.txt  # Delete line and go down 10
+
+Common commands:
+- :w - Save file
+- :q - Quit
+- :%s/old/new/g - Replace all occurrences
+- :set number - Show line numbers
+- :set expandtab - Use spaces instead of tabs
+- :retab - Convert tabs to spaces
+
+Common macros:
+- gg - Go to beginning of file
+- G - Go to end of file
+- dd - Delete line
+- yy - Yank (copy) line
+- p - Paste
+- V - Visual line mode
+- = - Format/indent
+
+Note: Requires Neovim to be installed.
+"""
+
+    @override
+    async def call(
+        self,
+        ctx: MCPContext,
+        **params: Unpack[NeovimCommandParams],
+    ) -> str:
+        """Execute Neovim command.
+
+        Args:
+            ctx: MCP context
+            **params: Tool parameters
+
+        Returns:
+            Result of the command execution
+        """
+        tool_ctx = create_tool_context(ctx)
+        await tool_ctx.set_tool_info(self.name)
+
+        # Extract parameters
+        command = params.get("command")
+        commands = params.get("commands")
+        macro = params.get("macro")
+        file_path = params.get("file_path")
+        save_after = params.get("save_after", True)
+        return_output = params.get("return_output", True)
+
+        # Validate inputs
+        if not any([command, commands, macro]):
+            return "Error: Must provide either 'command', 'commands', or 'macro'"
+
+        if sum(bool(x) for x in [command, commands, macro]) > 1:
+            return "Error: Can only use one of 'command', 'commands', or 'macro' at a time"
+
+        # Check if Neovim is available
+        nvim_cmd = shutil.which("nvim")
+        if not nvim_cmd:
+            return "Error: Neovim (nvim) not found. Install it first."
+
+        # Prepare commands list
+        nvim_commands = []
+        
+        if command:
+            nvim_commands.append(command)
+        elif commands:
+            nvim_commands.extend(commands)
+        elif macro:
+            # Convert macro to normal mode command
+            # Escape special characters
+            escaped_macro = macro.replace('"', '\\"')
+            nvim_commands.append(f':normal "{escaped_macro}"')
+        
+        # Add save command if requested
+        if save_after:
+            nvim_commands.append(":w")
+        
+        # Always quit at the end
+        nvim_commands.append(":q")
+
+        # Build Neovim command line
+        cmd = [nvim_cmd, "-n", "-i", "NONE"]  # No swap file, no shada file
+        
+        # Add commands
+        for vim_cmd in nvim_commands:
+            cmd.extend(["-c", vim_cmd])
+        
+        # Add file if specified
+        if file_path:
+            file_path = os.path.abspath(file_path)
+            
+            # Check permissions
+            if not self.permission_manager.has_permission(file_path):
+                return f"Error: No permission to access {file_path}"
+            
+            if not os.path.exists(file_path):
+                return f"Error: File not found: {file_path}"
+            
+            cmd.append(file_path)
+        else:
+            # Create empty buffer
+            cmd.append("-")
+        
+        await tool_ctx.info(f"Executing Neovim commands: {nvim_commands}")
+        
+        try:
+            # Execute Neovim
+            if return_output:
+                # Capture output by redirecting messages
+                output_file = tempfile.NamedTemporaryFile(mode='w+', delete=False)
+                output_file.close()
+                
+                # Add command to redirect messages
+                cmd.insert(3, "-c")
+                cmd.insert(4, f":redir! > {output_file.name}")
+                
+                # Execute
+                result = subprocess.run(
+                    cmd,
+                    capture_output=True,
+                    text=True
+                )
+                
+                # Read output
+                output_content = ""
+                try:
+                    with open(output_file.name, 'r') as f:
+                        output_content = f.read().strip()
+                finally:
+                    os.unlink(output_file.name)
+                
+                if result.returncode == 0:
+                    response = "Commands executed successfully"
+                    if file_path:
+                        response += f" on {os.path.basename(file_path)}"
+                    if output_content:
+                        response += f"\n\nOutput:\n{output_content}"
+                    return response
+                else:
+                    error_msg = "Error executing Neovim commands"
+                    if result.stderr:
+                        error_msg += f"\n\nError:\n{result.stderr}"
+                    if output_content:
+                        error_msg += f"\n\nOutput:\n{output_content}"
+                    return error_msg
+            else:
+                # Just execute without capturing output
+                result = subprocess.run(cmd)
+                
+                if result.returncode == 0:
+                    response = "Commands executed successfully"
+                    if file_path:
+                        response += f" on {os.path.basename(file_path)}"
+                    return response
+                else:
+                    return f"Neovim exited with code {result.returncode}"
+        
+        except Exception as e:
+            await tool_ctx.error(f"Failed to execute Neovim commands: {str(e)}")
+            return f"Error executing Neovim commands: {str(e)}"
+
+    def register(self, mcp_server) -> None:
+        """Register this tool with the MCP server."""
+        pass

hanzo_mcp/tools/editor/neovim_edit.py

@@ -0,0 +1,290 @@
+"""Open files in Neovim editor."""
+
+import os
+import subprocess
+import shutil
+from typing import Annotated, Optional, TypedDict, Unpack, final, override
+from pathlib import Path
+
+from mcp.server.fastmcp import Context as MCPContext
+from pydantic import Field
+
+from hanzo_mcp.tools.common.base import BaseTool
+from hanzo_mcp.tools.common.context import create_tool_context
+from hanzo_mcp.tools.common.permissions import PermissionManager
+
+
+FilePath = Annotated[
+    str,
+    Field(
+        description="Path to the file to open",
+        min_length=1,
+    ),
+]
+
+LineNumber = Annotated[
+    Optional[int],
+    Field(
+        description="Line number to jump to",
+        default=None,
+    ),
+]
+
+ColumnNumber = Annotated[
+    Optional[int],
+    Field(
+        description="Column number to jump to",
+        default=None,
+    ),
+]
+
+ReadOnly = Annotated[
+    bool,
+    Field(
+        description="Open file in read-only mode",
+        default=False,
+    ),
+]
+
+Split = Annotated[
+    Optional[str],
+    Field(
+        description="Split mode: vsplit, split, tab",
+        default=None,
+    ),
+]
+
+Wait = Annotated[
+    bool,
+    Field(
+        description="Wait for Neovim to exit before returning",
+        default=True,
+    ),
+]
+
+InTerminal = Annotated[
+    bool,
+    Field(
+        description="Open in terminal (requires terminal that supports it)",
+        default=True,
+    ),
+]
+
+
+class NeovimEditParams(TypedDict, total=False):
+    """Parameters for Neovim edit tool."""
+
+    file_path: str
+    line_number: Optional[int]
+    column_number: Optional[int]
+    read_only: bool
+    split: Optional[str]
+    wait: bool
+    in_terminal: bool
+
+
+@final
+class NeovimEditTool(BaseTool):
+    """Tool for opening files in Neovim."""
+
+    def __init__(self, permission_manager: PermissionManager):
+        """Initialize the Neovim edit tool.
+
+        Args:
+            permission_manager: Permission manager for access control
+        """
+        self.permission_manager = permission_manager
+
+    @property
+    @override
+    def name(self) -> str:
+        """Get the tool name."""
+        return "neovim_edit"
+
+    @property
+    @override
+    def description(self) -> str:
+        """Get the tool description."""
+        return """Open files in Neovim editor with advanced options.
+
+Open files at specific lines/columns, in different split modes, or read-only.
+Integrates with your existing Neovim configuration.
+
+Examples:
+- neovim_edit --file-path main.py
+- neovim_edit --file-path main.py --line-number 42
+- neovim_edit --file-path main.py --line-number 42 --column-number 10
+- neovim_edit --file-path config.json --read-only
+- neovim_edit --file-path test.py --split vsplit
+- neovim_edit --file-path README.md --split tab
+
+Split modes:
+- vsplit: Open in vertical split
+- split: Open in horizontal split  
+- tab: Open in new tab
+
+Note: Requires Neovim to be installed and available in PATH.
+"""
+
+    @override
+    async def call(
+        self,
+        ctx: MCPContext,
+        **params: Unpack[NeovimEditParams],
+    ) -> str:
+        """Open file in Neovim.
+
+        Args:
+            ctx: MCP context
+            **params: Tool parameters
+
+        Returns:
+            Result of the operation
+        """
+        tool_ctx = create_tool_context(ctx)
+        await tool_ctx.set_tool_info(self.name)
+
+        # Extract parameters
+        file_path = params.get("file_path")
+        if not file_path:
+            return "Error: file_path is required"
+
+        line_number = params.get("line_number")
+        column_number = params.get("column_number")
+        read_only = params.get("read_only", False)
+        split = params.get("split")
+        wait = params.get("wait", True)
+        in_terminal = params.get("in_terminal", True)
+
+        # Check if Neovim is available
+        nvim_cmd = shutil.which("nvim")
+        if not nvim_cmd:
+            # Try common locations
+            common_paths = [
+                "/usr/local/bin/nvim",
+                "/usr/bin/nvim",
+                "/opt/homebrew/bin/nvim",
+                os.path.expanduser("~/.local/bin/nvim"),
+            ]
+            for path in common_paths:
+                if os.path.exists(path):
+                    nvim_cmd = path
+                    break
+            
+            if not nvim_cmd:
+                return """Error: Neovim (nvim) not found. Install it with:
+
+On macOS:
+brew install neovim
+
+On Ubuntu/Debian:
+sudo apt install neovim
+
+On Arch:
+sudo pacman -S neovim
+
+Or visit: https://neovim.io/"""
+
+        # Convert to absolute path
+        file_path = os.path.abspath(file_path)
+        
+        # Check permissions
+        if not self.permission_manager.has_permission(file_path):
+            return f"Error: No permission to access {file_path}"
+
+        # Build Neovim command
+        cmd = [nvim_cmd]
+        
+        # Add read-only flag
+        if read_only:
+            cmd.append("-R")
+        
+        # Add split mode
+        if split:
+            if split == "vsplit":
+                cmd.extend(["-c", "vsplit"])
+            elif split == "split":
+                cmd.extend(["-c", "split"])
+            elif split == "tab":
+                cmd.extend(["-c", "tabnew"])
+            else:
+                return f"Error: Invalid split mode '{split}'. Use 'vsplit', 'split', or 'tab'"
+        
+        # Add file path
+        cmd.append(file_path)
+        
+        # Add line/column positioning
+        if line_number:
+            if column_number:
+                # Go to specific line and column
+                cmd.extend(["+call cursor({}, {})".format(line_number, column_number)])
+            else:
+                # Go to specific line
+                cmd.append(f"+{line_number}")
+        
+        await tool_ctx.info(f"Opening {file_path} in Neovim")
+        
+        try:
+            # Determine how to run Neovim
+            if in_terminal and not wait:
+                # Open in a new terminal window (platform-specific)
+                if os.uname().sysname == "Darwin":  # macOS
+                    # Try to use iTerm2 if available, otherwise Terminal
+                    if shutil.which("osascript"):
+                        # Build AppleScript to open in iTerm2 or Terminal
+                        nvim_cmd_str = " ".join(f'"{arg}"' for arg in cmd)
+                        
+                        # Try iTerm2 first
+                        applescript = f'''tell application "System Events"
+                            if exists application process "iTerm2" then
+                                tell application "iTerm"
+                                    activate
+                                    tell current window
+                                        create tab with default profile
+                                        tell current session
+                                            write text "{nvim_cmd_str}"
+                                        end tell
+                                    end tell
+                                end tell
+                            else
+                                tell application "Terminal"
+                                    activate
+                                    do script "{nvim_cmd_str}"
+                                end tell
+                            end if
+                        end tell'''
+                        
+                        subprocess.run(["osascript", "-e", applescript])
+                        return f"Opened {file_path} in Neovim (new terminal window)"
+                
+                elif shutil.which("gnome-terminal"):
+                    # Linux with GNOME
+                    subprocess.Popen(["gnome-terminal", "--"] + cmd)
+                    return f"Opened {file_path} in Neovim (new terminal window)"
+                
+                elif shutil.which("xterm"):
+                    # Fallback to xterm
+                    subprocess.Popen(["xterm", "-e"] + cmd)
+                    return f"Opened {file_path} in Neovim (new terminal window)"
+                
+                else:
+                    # Can't open in terminal, fall back to subprocess
+                    subprocess.Popen(cmd)
+                    return f"Opened {file_path} in Neovim (background process)"
+            
+            else:
+                # Run and wait for completion
+                result = subprocess.run(cmd)
+                
+                if result.returncode == 0:
+                    return f"Successfully edited {file_path} in Neovim"
+                else:
+                    return f"Neovim exited with code {result.returncode}"
+        
+        except Exception as e:
+            await tool_ctx.error(f"Failed to open Neovim: {str(e)}")
+            return f"Error opening Neovim: {str(e)}"
+
+    def register(self, mcp_server) -> None:
+        """Register this tool with the MCP server."""
+        pass