Skip to main content

MCP server for AI-assisted control of Neovim via msgpack-RPC

Project description

nvim-mcp

PyPI

An MCP server that gives AI agents first-class access to your running Neovim session. It connects through Neovim's native msgpack-RPC socket — no plugins required.

Works with Cursor, Claude Code, Codex, OpenCode, and any MCP-compatible client.

Before you connect an agent to Neovim, please read Working safely.

What agents can do

  • See what you see — editor mode, working directory, open buffers, window layout, cursor context, folds, selections, marks, and diagnostics.
  • Edit buffers in memory — find-and-replace or full rewrites with immediate feedback and full undo support. Nothing touches disk until you save.
  • Run any Vim command:w, :e, :vsplit, macros, or anything else you could type at the command line.
  • Send keystrokes — navigate, enter insert mode, trigger mappings.
  • Query LSP diagnostics — errors, warnings, and hints across one buffer or the whole session.
  • Annotate code with highlights and virtual text — colored line highlights and inline/above/below text notes that never touch the buffer's real content.
  • Work with multiple instances — auto-discovers running sessions and connects to the right one. See multiple instances.

Anything you can do in Neovim, the agent can too. See the full tool reference for details.

Demos

Using nvim-mcp across two terminals

Using nvim-mcp with a terminal inside Neovim

Claude and Cursor collaborating in one Neovim instance

Using nvim-mcp in Cursor

Multiple Neovim instances

Quick start

nvim-mcp runs via uv (recommended) or Nix.

Cursor users: A Marketplace plugin is pending review — once available, it installs the MCP server and agent rule together (you can skip to step 4). To activate the rule, start chats with something like "Connect to my Neovim instance" — or set the rule to "Always" in Settings → Rules to apply it on every turn.

  1. Install a launcher.

    uv
    curl -LsSf https://astral.sh/uv/install.sh | sh
    
    Nix

    Install Nix — flakes must be enabled.

  2. Register the MCP server with your client. Example for Cursor (.cursor/mcp.json):

    With uv
    {
      "mcpServers": {
        "nvim-mcp": {
          "command": "uvx",
          "args": ["nvim-mcp"]
        }
      }
    }
    
    With Nix
    {
      "mcpServers": {
        "nvim-mcp": {
          "command": "nix",
          "args": ["run", "github:paulburgess1357/nvim-mcp"]
        }
      }
    }
    

    For Claude Code, Codex, Claude Desktop, OpenCode, and other clients, see the configuration guide.

  3. Add agent rules — do not skip this. Without rules, the agent has the tools but doesn't know when or how to use them, and behavior will be unreliable. See the configuration guide for setup.

  4. Start Neovim — on most Linux systems it listens on a Unix socket automatically and is discovered by nvim-mcp. If auto-discovery doesn't work, see environment variables. Running multiple instances? See multiple instances.

Verify it works

Open a file in Neovim and paste this into your AI agent:

For each step: explain what you're about to do, then do it, then tell me
what happened. Wait for me to say "next" before moving on.

1. What file am I in? Highlight the function my cursor is in.
2. Are there any diagnostics? Highlight any lines with errors or warnings.
3. Add a docstring above the function, then show me the diff.
4. Open a vertical split, write a short test for that function, and save both files.

Working safely

The tools and agent rules are designed to use non-destructive operations — edits happen in memory, undo history is preserved, and the agent is steered toward buffer operations. But LLMs are non-deterministic, have full access to Neovim's API, and you should assume they will make mistakes. Work in a version-controlled directory.

Requirements

  • Linux
  • Python ≥ 3.10
  • Neovim ≥ 0.11 (older versions work with --listen and NVIM_ADDRESS)

License

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nvim_mcp-1.0.0.tar.gz (20.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nvim_mcp-1.0.0-py3-none-any.whl (23.4 kB view details)

Uploaded Python 3

File details

Details for the file nvim_mcp-1.0.0.tar.gz.

File metadata

  • Download URL: nvim_mcp-1.0.0.tar.gz
  • Upload date:
  • Size: 20.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for nvim_mcp-1.0.0.tar.gz
Algorithm Hash digest
SHA256 64747fb01140edb4acbe73a3c64e8833d8710962f8d3511a2c6f3c53d0c35f8a
MD5 08a9d7fdffb3443f41199f99eeea9862
BLAKE2b-256 92c31e8dff3ac33da7986a67beabddf01f9ebc3b33264d035c58bb215153e6f6

See more details on using hashes here.

File details

Details for the file nvim_mcp-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: nvim_mcp-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 23.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for nvim_mcp-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7c2b08cde3ec8bf6789c586fff68f1e494c23a02ef1d18863575e79e60f3cb9c
MD5 a6a97c800edd2fd0f60073d77522268e
BLAKE2b-256 cca8162835aaf5ab2e21a1e0afecfda777773ffa1795cfde4ca3629808fd4646

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page