Skip to content

Commit 800d4de

Browse files
authored
Merge pull request #11 from bigcodegen/develop
enhanced tool descriptions
2 parents 25844e7 + 993caa1 commit 800d4de

File tree

4 files changed

+162
-60
lines changed

4 files changed

+162
-60
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
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.
44

5+
**Version 0.5.2** - Now with comprehensive error handling, improved MCP compliance, and helpful workflow prompts!
6+
57
<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>
68

79
## Features
@@ -61,7 +63,7 @@ Connect Claude Desktop (or any Model Context Protocol client) to Neovim using MC
6163
#### Enhanced Buffer Management
6264
- **vim_buffer_switch**
6365
- Switch between buffers by name or number
64-
- Input `buffer` (string | number) - Buffer name or number
66+
- Input `identifier` (string | number) - Buffer name or number
6567
- **vim_buffer_save**
6668
- Save current buffer or save to specific filename
6769
- Input `filename` (string, optional) - Save to specific file
@@ -72,13 +74,13 @@ Connect Claude Desktop (or any Model Context Protocol client) to Neovim using MC
7274
#### Search and Replace
7375
- **vim_search**
7476
- Search within current buffer with regex support
75-
- Input `pattern` (string), `options` (object, optional) with `backwards`, `wrap`, `ignorecase`
77+
- Input `pattern` (string), `ignoreCase` (boolean, optional), `wholeWord` (boolean, optional)
7678
- **vim_search_replace**
7779
- Find and replace with advanced options
78-
- Input `pattern` (string), `replacement` (string), `options` (object, optional) with `global`, `ignorecase`, `confirm`
80+
- Input `pattern` (string), `replacement` (string), `global` (boolean, optional), `ignoreCase` (boolean, optional), `confirm` (boolean, optional)
7981
- **vim_grep**
8082
- Project-wide search using vimgrep with quickfix list
81-
- Input `pattern` (string), `files` (string, optional) - File pattern to search
83+
- Input `pattern` (string), `filePattern` (string, optional) - File pattern to search
8284

8385
#### Advanced Workflow Tools
8486
- **vim_macro**
@@ -100,15 +102,19 @@ Connect Claude Desktop (or any Model Context Protocol client) to Neovim using MC
100102

101103
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.
102104

105+
### Prompts
106+
107+
- **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.
108+
103109
## Error Handling
104110

105-
The server implements robust error handling with custom error classes:
111+
The server implements comprehensive error handling with custom error classes and consistent error responses:
106112

107113
- **NeovimConnectionError**: Socket connection failures with detailed messages
108114
- **NeovimCommandError**: Command execution failures with command context
109115
- **NeovimValidationError**: Input validation failures
110116

111-
Features include connection health monitoring, graceful error propagation, and actionable error messages to help diagnose issues.
117+
**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.
112118

113119
## Limitations
114120

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "mcp-neovim-server",
3-
"version": "0.5.1",
3+
"version": "0.5.2",
44
"description": "An MCP server for neovim",
55
"type": "module",
66
"bin": {

0 commit comments

Comments
 (0)