Merge pull request #4 from bigcodegen/develop

feat: allow configurable Neovim socket path and update lib version

Author: bigcodegen

README.md

@@ -1,15 +1,15 @@
 # Neovim MCP Server
 
-A proof of concept integration between Claude Desktop and Neovim using Model Context Protocol (MCP) and the official neovim/node-client JavaScript library. This demo leverages Vim's native text editing commands and workflows, which Claude already understands, to create a lightweight code assistance layer.
+A proof of concept integration between Claude Desktop (or any client) and Neovim using Model Context Protocol (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.
 
 <a href="https://glama.ai/mcp/servers/s0fywdwp87"><img width="380" height="200" src="https://glama.ai/mcp/servers/s0fywdwp87/badge" alt="mcp-neovim-server MCP server" /></a>
 
 ## Features
 
-- Connects to your nvim instance if you expose `--listen /tmp/nvim` when starting nvim
-- Views your current buffer
+- Connects to your nvim instance if you expose a socket file, for example `--listen /tmp/nvim`, when starting nvim
+- Views your current buffers
 - Gets cursor location, mode, file name
-- Runs vim commands
+- Runs vim commands and optionally shell commands through vim
 - Can make edits using insert or replacement
 
 ## API
@@ -67,6 +67,7 @@ Using this simple set of tools, Claude can peer into your neovim session to answ
 ### 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.
 
 ## Usage with Claude Desktop
 Add this to your `claude_desktop_config.json`:
@@ -80,7 +81,8 @@ Add this to your `claude_desktop_config.json`:
         "mcp-neovim-server"
       ],
       "env": {
-        "ALLOW_SHELL_COMMANDS": "true"
+        "ALLOW_SHELL_COMMANDS": "true",
+        "NVIM_SOCKET_PATH": "/tmp/nvim"
       }
     }
   }