Vim MCP

🚀 vim-mcp

为Vim和Claude Code提供简单的MCP（模型上下文协议）集成

🚀 快速开始

vim-mcp为Vim和Claude Code提供了简单的MCP集成。通过该插件，Claude Code可以连接到Vim实例，查询Vim状态等。

✨ 主要特性

• 将Claude Code连接到你的Vim实例。
• 查询Vim状态（缓冲区、窗口、光标位置等）。
• 当只有一个Vim实例运行时，自动选择该实例。
• 支持通过选择提示连接多个Vim实例。

📦 安装指南

1. 安装Vim插件

使用你喜欢的插件管理器将以下内容添加到你的 .vimrc 中：

" 使用vim-plug
Plug '~/Project/vim-mcp2/vim-mcp-plugin'

" 或者手动将vim-mcp.vim复制到 ~/.vim/plugin/

2. 安装Node.js依赖项

cd ~/Project/vim-mcp2/vim-mcp-server
npm install

3. 配置Claude Code

将以下内容添加到你的Claude Code MCP设置文件（~/.config/claude-code/mcp-servers.json）中：

{
  "mcpServers": {
    "vim-mcp": {
      "command": "node",
      "args": ["/Users/iirianto/Project/vim-mcp2/vim-mcp-server/index.js"]
    }
  }
}

💻 使用示例

基础用法

Claude Code中的基本命令

1. 连接到Vim：
   • “Connect to Vim” - 连接到一个Vim实例（如果只有一个实例则自动选择）。
   • “List Vim instances” - 显示所有可用的Vim实例。
   • “Select vim instance [id]” - 连接到特定的实例。
2. 查询Vim状态：
   • “How many buffers do I have?”
   • “What buffers are open?”
   • “What is my cursor position?”
   • “Show me the current buffer content”
   • “What windows are open?”

Vim命令

插件会在Vim启动时自动启动。你也可以使用以下命令：

• :VimMCPStatus - 检查插件是否正在运行。
• :VimMCPRestart - 重启MCP连接。
• :VimMCPStop - 停止MCP服务器。

🔧 技术细节

工作原理

1. 每个Vim实例会在 /tmp/vim-mcp-{instance-id}-state.json 创建一个状态文件。
2. Vim会在 /tmp/vim-mcp-registry.json 中注册自己。
3. Vim会持续更新其状态文件（每秒更新一次）。
4. MCP服务器直接读取状态文件以查询Vim状态。
5. Claude Code通过模型上下文协议与MCP服务器通信。

项目结构

vim-mcp2/
├── vim-mcp-plugin/          # Vim插件目录
│   └── vim-mcp.vim         # VimScript插件文件
├── vim-mcp-server/          # Node.js MCP服务器
│   ├── index.js            # 主服务器文件
│   ├── package.json        # Node.js依赖项
│   └── package-lock.json   # 依赖锁定文件
├── docs/                    # 文档
└── README.md               # 本文件

📚 详细文档

要求

• Vim 8+ 或 Neovim 0.5+
• Node.js 18+
• 对 /tmp 目录的文件系统访问权限
• 跨平台兼容（Linux/macOS/Windows）

故障排除

1. 未找到Vim实例：
   • 确保Vim已加载插件并正在运行。
   • 在Vim中检查 :VimMCPStatus。
   • 验证状态文件是否存在：ls /tmp/vim-mcp-*-state.json。
2. 状态读取错误：
   • 检查注册表文件：cat /tmp/vim-mcp-registry.json。
   • 检查状态文件：cat /tmp/vim-mcp-{instance-id}-state.json。
   • 重启Vim插件：:VimMCPRestart。
   • 在Vim中检查错误信息：:messages。
3. 清理陈旧文件：

rm /tmp/vim-mcp-*-state.json
rm /tmp/vim-mcp-registry.json

开发

要直接运行MCP服务器：

cd vim-mcp-server
node index.js

服务器使用标准输入输出进行MCP通信，并读取JSON状态文件以获取Vim状态。