MCP Neovim Server

🚀 Neovim MCP サーバー

このプロジェクトは、Claude Desktop（またはその他のクライアント）と Neovim の間で Model Context Protocol (MCP) を介した統合を実現する概念実証プロジェクトです。公式の neovim/node-client JavaScript ライブラリを使用し、軽量なコードまたは汎用の AI テキスト支援レイヤーを構築します。

✨ 主な機能

• Neovim を起動する際にソケットファイルを公開する場合（例: --listen /tmp/nvim）、このサーバーは Neovim インスタンスに接続できます。
• 現在開いているバッファを確認できます。
• カーソル位置、モード、ファイル名を取得できます。
• Neovim コマンドおよびオプションのシェルコマンド（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 と簡単に対話し、様々な編集や管理機能を実行できます。

⚠️ 重要提示

このプロジェクトは、Claude などの AI ツールが Neovim とより自然に統合できるようなインターフェースを提供することを目的としています。Neovim 自体は非常に強力ですが、MCP プロトコルを通じてその機能を拡張することで、開発効率とユーザー体験をさらに向上させることができます。

🔧 注意事項

• 使用する際は、Neovim と関連プラグインが正しくインストールされ、設定されていることを確認してください。
• 高度な機能を使用する場合は、追加の設定またはスクリプトのサポートが必要になる場合があります。
• 問題が発生した場合は、プロジェクトのドキュメントまたはコミュニティリソースを参照して支援を求めてください。

📄 ライセンス

このプロジェクトは MIT ライセンスに準拠しています。詳細については LICENSE ファイルを参照してください。

貢献

どんな貢献も大歓迎です！コードの修正、機能の追加、ドキュメントの改善など、あなたの参加を歓迎します。

変更を提案する前に、CONTRIBUTING.md ファイルを読んで、プロジェクトに効果的に貢献する方法を確認してください。