Mcp Neovim Server

What is Mcp Neovim Server about?

Mcp Neovim Server enables a Model Context Protocol client (e.g., Claude Desktop) to interact directly with a running Neovim instance. It leverages Neovim's native commands and workflows, exposing them as MCP tools so that AI models can read, edit, search, and manage buffers, windows, tabs, and more.

How to use Mcp Neovim Server?

1. Start Neovim with a Unix socket, e.g. nvim --listen /tmp/nvim.
2. Install the server (DXT package or npm) and launch it via the MCP configuration.
3. Configure the MCP client (Claude Desktop) to connect to the server.
4. Use the provided MCP tools (vim_buffer, vim_edit, vim_search, etc.) to issue commands and receive responses.

Key Features

• Socket‑based connection to any Neovim session.
• Full buffer inspection, switching, and saving.
• Cursor, mode, marks, registers, visual selections, and LSP status retrieval.
• Execution of arbitrary Vim commands and optional shell commands (! prefix).
• Line‑based editing with insert, replace, and replaceAll modes.
• Regex‑enabled search, replace, and project‑wide grep with quickfix integration.
• Comprehensive window, tab, and fold management.
• Macro recording/playback, jump list navigation, and health diagnostics.
• Robust error handling with custom error classes.

Use Cases

• AI‑driven code completion or refactoring directly inside the developer's editor.
• Context‑aware documentation generation or comment insertion.
• Automated project‑wide search‑and‑replace operations guided by an LLM.
• Real‑time assistance for Vim/Neovim power users via conversational agents.
• Batch processing of files (open, edit, save) without leaving the editor.

FAQ

Q: Does the server work with regular Vim? A: No, it requires Neovim because it uses the neovim/node-client API.

Q: Are shell commands safe? A: Shell execution is disabled by default. Set ALLOW_SHELL_COMMANDS=true in the environment to enable, understanding the security implications.

Q: What if my Neovim configuration has many plugins? A: The server works best with standard setups; complex plugin interactions may cause unexpected behavior.

Q: How is the server installed? A: Preferred method is the DXT package (drag‑and‑drop into Claude Desktop). Manual installation can be done via npm using npx as shown in the configuration example.

Q: How do I change the socket path? A: Set NVIM_SOCKET_PATH to the desired Unix socket file; defaults to /tmp/nvim.

Neovim MCP Server

Connect Claude Desktop (or any Model Context Protocol client) to Neovim using MCP and the official neovim/node-client JavaScript library. This server leverages Vim's native text editing commands and workflows, which Claude already understands, to create a lightweight code or general purpose AI text assistance layer.

Version 0.5.3 - Now with a DXT package!

Features

• Connects to your nvim instance if you expose a socket file, for example --listen /tmp/nvim, when starting nvim
• Views your current buffers and manages buffer switching
• Gets cursor location, mode, file name, marks, registers, and visual selections
• Runs vim commands and optionally shell commands through vim
• Can make edits using insert, replace, or replaceAll modes
• Search and replace functionality with regex support
• Project-wide grep search with quickfix integration
• Comprehensive window management
• Health monitoring and connection diagnostics

API

Resources

• nvim://session: Current neovim text editor session
• nvim://buffers: List of all open buffers in the current Neovim session with metadata including modified status, syntax, and window IDs

Tools

Core Tools

• vim_buffer
  • Get buffer contents with line numbers (supports filename parameter)
  • Input filename (string, optional) - Get specific buffer by filename
  • Returns numbered lines with buffer content
• vim_command
  • Send a command to VIM for navigation, spot editing, and line deletion
  • Input command (string)
  • Runs vim commands with nvim.replaceTermcodes. Multiple commands work with newlines
  • Shell commands supported with ! prefix when ALLOW_SHELL_COMMANDS=true
  • On error, 'nvim:errmsg' contents are returned
• vim_status
  • Get comprehensive Neovim status
  • Returns cursor position, mode, filename, visual selection, window layout, current tab, marks, registers, working directory, LSP client info, and plugin detection
• vim_edit
  • Edit lines using insert, replace, or replaceAll modes
  • Input startLine (number), mode ("insert" | "replace" | "replaceAll"), lines (string)
  • insert: insert lines at startLine
  • replace: replace lines starting at startLine
  • replaceAll: replace entire buffer contents
• vim_window
  • Manipulate Neovim windows (split, vsplit, close, navigate)
  • Input command (string: "split", "vsplit", "only", "close", "wincmd h/j/k/l")
• vim_mark
  • Set named marks at specific positions
  • Input mark (string: a-z), line (number), column (number)
• vim_register
  • Set content of registers
  • Input register (string: a-z or "), content (string)
• vim_visual
  • Create visual mode selections
  • Input startLine (number), startColumn (number), endLine (number), endColumn (number)

Enhanced Buffer Management

• vim_buffer_switch
  • Switch between buffers by name or number
  • Input identifier (string | number) - Buffer name or number
• vim_buffer_save
  • Save current buffer or save to specific filename
  • Input filename (string, optional) - Save to specific file
• vim_file_open
  • Open files into new buffers
  • Input filename (string) - File to open

Search and Replace

• vim_search
  • Search within current buffer with regex support
  • Input pattern (string), ignoreCase (boolean, optional), wholeWord (boolean, optional)
• vim_search_replace
  • Find and replace with advanced options
  • Input pattern (string), replacement (string), global (boolean, optional), ignoreCase (boolean, optional), confirm (boolean, optional)
• vim_grep
  • Project-wide search using vimgrep with quickfix list
  • Input pattern (string), filePattern (string, optional) - File pattern to search

Advanced Workflow Tools

• vim_macro
  • Record, stop, and play Vim macros
  • Input action ("record" | "stop" | "play"), register (string, a-z), count (number, optional)
• vim_tab
  • Complete tab management
  • Input action ("new" | "close" | "next" | "prev" | "first" | "last" | "list"), filename (string, optional)
• vim_fold
  • Code folding operations
  • Input action ("create" | "open" | "close" | "toggle" | "openall" | "closeall" | "delete"), startLine/endLine (numbers, for create)
• vim_jump
  • Jump list navigation
  • Input direction ("back" | "forward" | "list")

System Tools

• vim_health
  • Check Neovim connection health and socket status

Using this comprehensive set of 19 tools, Claude can peer into your neovim session, navigate buffers, perform searches, make edits, record macros, manage tabs and folds, and handle your complete development workflow with standard Neovim features.

Prompts

• neovim_workflow: Get contextual help and guidance for common Neovim workflows including editing, navigation, search, buffer management, window operations, and macro usage. Provides step-by-step instructions for accomplishing tasks with the available MCP tools.

Error Handling

The server implements comprehensive error handling with custom error classes and consistent error responses:

• NeovimConnectionError: Socket connection failures with detailed messages
• NeovimCommandError: Command execution failures with command context
• NeovimValidationError: Input validation failures

New in v0.5.2: All tools now include robust try-catch error handling that returns meaningful error messages in proper MCP format. Features include connection health monitoring, graceful error propagation, and actionable error messages to help diagnose issues.

Limitations

• May not interact well with complex neovim configurations or plugins
• Shell command execution is disabled by default for security
• Socket connection required - won't work with standard vim

Configuration

Environment Variables

• ALLOW_SHELL_COMMANDS: Set to 'true' to enable shell command execution (e.g. !ls). Defaults to false for security.
• NVIM_SOCKET_PATH: Set to the path of your Neovim socket. Defaults to '/tmp/nvim' if not specified.

Installation

Option 1: DXT Package (Recommended)

1. Download the latest .dxt file from Releases
2. Drag the file to Claude Desktop

Option 2: Manual Installation

Add this to your claude_desktop_config.json:

{
  "mcpServers": {
    "MCP Neovim Server": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-neovim-server"
      ],
      "env": {
        "ALLOW_SHELL_COMMANDS": "true",
        "NVIM_SOCKET_PATH": "/tmp/nvim"
      }
    }
  }
}

License

This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.