MCP Neovim Server

🚀 Neovim MCP 服務器

本項目是一個概念驗證項目，旨在通過 Model Context Protocol (MCP) 實現 Claude Desktop（或其他客戶端）與 Neovim 的集成。它藉助官方的 neovim/node-client JavaScript 庫，構建了一個輕量級的代碼或通用目的 AI 文本輔助層。

✨ 主要特性

• 若在啟動 Neovim 時暴露了套接字文件（如 --listen /tmp/nvim），服務器可連接至 Neovim 實例。
• 支持查看當前打開的緩衝區。
• 能夠獲取光標位置、模式和文件名。
• 可執行 Neovim 命令以及可選的 shell 命令（通過 Neovim）。
• 支持使用插入或替換方式執行編輯操作。

📚 詳細文檔

資源

• nvim://session：當前 Neovim 文本編輯會話。
• nvim://buffers：當前 Neovim 會話中所有打開緩衝區的列表，包含修改狀態、語法和窗口 ID 等元數據。

工具

• vim_buffer：
  • 顯示當前 VIM 文本編輯器緩衝區的內容，並帶有行號。
  • 輸入參數為 filename（字符串）。
  • 若忽略文件名，將返回當前活動緩衝區內容的編號行字符串。
• vim_command：
  • 可向 VIM 發送命令，用於導航、定點編輯和行刪除。
  • 輸入參數為 command（字符串）。
  • 首先通過 nvim.replaceTermcodes 運行一個 Neovim 命令。若輸入包含多個命令，可通過換行符分隔。
  • 出錯時返回 'nvim:errmsg' 內容。
• vim_status：
  • 用於獲取 VIM 編輯器的狀態。
  • 狀態信息包含光標位置、模式、文件名、視覺選擇、窗口布局、當前標籤頁、標記、寄存器和工作目錄。
• vim_edit：
  • 支持使用插入、替換或全替換方式編輯行。
  • 輸入參數為 startLine（數字）、mode（"insert" | "replace" | "replaceAll"）、lines（字符串）。
  • 插入模式會在 startLine 處插入行。
  • 替換模式將從 startLine 開始替換行。
  • 全替換模式會替換整個緩衝區內容。
• vim_window：
  • 可管理 Neovim 窗口（拆分、垂直拆分、僅顯示、關閉）。
  • 輸入參數為 command（字符串： "split"、"vsplit"、"only"、"close"、"wincmd h/j/k/l"）。
  • 允許進行窗口管理操作。
• vim_mark：
  • 可在特定位置設置標記。
  • 輸入參數為 mark（字符串：a - z）、line（數字）、column（數字）。
  • 用於設置指定位置的命名標記。
• vim_register：
  • 可設置寄存器的內容。
  • 輸入參數為 register（字符串：a - z 或 '"'）、content (字符串)。
  • 用於管理寄存器內容。
• vim_visual：
  • 可創建一個視覺選擇。
  • 輸入參數為 startLine（數字）、startColumn（數字）、endLine（數字）、endColumn（數字）。
  • 用於設置視覺選擇範圍。

通過以上工具，用戶可以方便地與 Neovim 進行交互，實現各種編輯和管理功能。

📄 許可證

本項目遵循 MIT 許可證。請查看 LICENSE 文件以獲取詳細信息。

⚠️ 重要提示

本項目旨在提供一個接口，使 Claude 等 AI 工具能夠更自然地與 Neovim 集成。儘管 Neovim 本身已經非常強大，但通過 MCP 協議擴展其功能，可以進一步提升開發效率和用戶體驗。

💡 使用建議

• 在使用過程中，請確保 Neovim 和相關插件已正確安裝並配置。
• 對於高級功能，可能需要額外的配置或腳本支持。
• 如遇到問題，請參考項目文檔或社區資源尋求幫助。

👏 貢獻

歡迎任何貢獻！無論是代碼修復、功能添加還是文檔改進，我們都歡迎你的參與。

請在提出更改前閱讀我們的 CONTRIBUTING.md 文件，瞭解如何有效地為項目做出貢獻。