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狀態。