MCP Server Wsl Filesystem

🚀 WSLファイルシステムMCPサーバー

Node.jsサーバーによって実装されたモデルコンテキストプロトコル（MCP）で、Windows Subsystem for Linux (WSL)環境に特化して設計されています。このプロジェクトは、元のファイルシステムMCPサーバーのブランチで、パフォーマンス向上とLinuxコマンドのサポートに向けて最適化されています。

🚀 クイックスタート

重要な注意事項

⚠️ 重要提示

元のプロジェクトでは、ネットワークパスを通じてWSLファイルにアクセスすることができます。例えば：

node dist/index.js '\\.\pipe\windows-to-ubuntu'

また、以下のようなサンプル設定も提供されています：

{
  "mcpServers": {
    "filesystem": {
      "command": "node",
      "args": ["dist/index.js", "\\\\.", "pipe", "windows-to-ubuntu"]
    }
  }
}

プロジェクト概要

このプロジェクトはWSL向けに最適化されたブランチで、主な機能は以下の通りです。

1. 元のプロジェクトの直接的なNode.jsファイルシステム呼び出しを、WSLコマンドの実行に置き換えます。
2. 特定のWSLディストリビューションのサポートを追加します。
3. WindowsとLinuxのパス変換を実装します。
4. ファイル内容の処理におけるクロスプラットフォーム互換性を向上させます。
5. WSL管理に特化した機能を追加します。

✨ 主な機能

核心機能

• クロスプラットフォームファイル操作：WSLコマンドの実行を通じて、WindowsとLinux間のファイル操作の相互運用性を実現します。
• ディストリビューションサポート：指定したWSLディストリビューション（例：Ubuntu-20.04）を選択するか、デフォルトのディストリビューションを使用できます。
• パス変換：WindowsとLinux形式のパス変換を自動的に処理します。
• パフォーマンス最適化：WSL環境に特化した最適化を行い、ファイル操作の効率を向上させます。

ツールセット

このプロジェクトでは、以下の機能ツールが提供されています。

基本的なファイル操作

• ファイル内容の読み取り
• ファイル内容の書き込み
• ディレクトリの作成
• ディレクトリの削除
• ファイル/ディレクトリの移動
• ファイル/ディレクトリのコピー

高度な機能

• ファイルの検索と探索：複雑な条件でのファイル検索をサポートします。
• ファイル属性の照会：ファイルの詳細情報とメタデータを取得します。
• 権限管理：ファイルの権限を設定および変更します。
• 圧縮と解凍：一般的なアーカイブ形式（zip、tar.gzなど）をサポートします。
• ログ記録：詳細な操作ログを提供します。

📦 インストール

一般的なインストール手順

1. プロジェクトリポジトリをクローンします：

   git clone https://github.com/yourusername/mcp-server-wsl-filesystem.git
   

2. プロジェクトディレクトリに移動します：

   cd mcp-server-wsl-filesystem
   

3. 依存関係をインストールします：

   npm install
   

4. TypeScriptプロジェクトをビルドします：

   npm run build
   

開発環境の設定

1. Node.js（v14.0.0以上）をインストールしてください。
2. インストール後、バージョンを確認します：

   node --version
   npm --version
   

💻 使用例

サーバーの起動

サーバーを起動する前に、TypeScriptプロジェクトをビルドする必要があります：

npm install
npm run build

その後、使用するWSLディストリビューション（オプション）と公開するディレクトリを指定してサーバーを起動します：

node dist/index.js [--distro=distribution_name] <allowed_directory> [additional_directories...]

• ディストリビューションを指定しない場合、システムのデフォルトディストリビューションが使用されます。
• 複数のディレクトリを指定することができます。

具体的な使用例

Ubuntu-20.04ディストリビューションにアクセスする場合：

node dist/index.js --distro=Ubuntu-20.04 /home/user/documents

デフォルトディストリビューションを使用する場合：

node dist/index.js /home/user/documents

📚 ドキュメント

Claude Desktopとの統合

claude_desktop_config.jsonに以下の設定を追加します：

方案1：特定のWSLディストリビューションを指定する

{
  "mcpServers": {
    "wsl-filesystem": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-server-wsl-filesystem",
        "--distro=Ubuntu-20.04",
        "/home/user/documents"
      ]
    }
  }
}

方案2：デフォルトのWSLディストリビューションを使用する

{
  "mcpServers": {
    "wsl-filesystem": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-server-wsl-filesystem",
        "/home/user/documents"
      ]
    }
  }
}

2つ目の方案では、システムが自動的にデフォルトのWSLディストリビューションを使用し、追加の設定は必要ありません。

元のプロジェクトとの主な違い

このブランチはWSL環境に向けて以下の最適化を行っています：

1. コマンド実行の置き換え：元のプロジェクトの直接的なNode.js呼び出しをWSLコマンドの実行に置き換えました。
2. ディストリビューションサポート：指定したWSLディストリビューションのサポートを追加しました。
3. パス変換機能：WindowsとLinuxのパスの自動変換を実現しました。
4. パフォーマンス改善：WSL環境に特化した最適化を行いました。

📄 ライセンス

このプロジェクトはMITライセンスに準拠しており、詳細なライセンス内容はLICENSEファイルを参照してください。

貢献ガイド

コミュニティからの貢献を歓迎します！何か問題を発見した場合や改善提案がある場合は、以下のリポジトリにIssuesまたはPull Requestを提出してください：

GitHub リポジトリアドレス