MCP Server Filesystem

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

このプロジェクトの MCP ファイルシステムサーバは、ファイル操作を行うための強力なツールです。開発環境への統合が容易で、様々なファイル操作をサポートしています。

🚀 クイックスタート

Windows での開発環境のセットアップ

REM リポジトリをクローンする
git clone https://github.com/MarcusJellinghaus/mcp_server_filesystem.git
cd mcp-server-filesystem

REM 仮想環境を作成してアクティブ化する
python -m venv .venv
.venv\Scripts\activate

REM 依存関係をインストールする
pip install -e .

REM 開発用の依存関係をインストールする
pip install -e ".[dev]"

設定の説明

このサーバを VSCode や他の Cline 対応ツールと統合するには、以下の手順で設定してください。

1. VSCode との統合：
   • VSCode を開き、Cline 拡張をインストールします。
   • プロジェクトのルートディレクトリに mcp-config.json ファイルを作成し、以下の内容を追加します。

{
  "mcp": {
    "servers": [
      {
        "id": "filesystem",
        "class": "mcp_server_filesystem.FileSystemServer",
        "args": {
          "project_dir": "."
        }
      }
    ]
  }
}

2. サーバの起動：
   • VSCode 内でターミナルを開き、以下のコマンドを実行します。

python src/server.py

✨ 主な機能

このサーバは以下の MCP ツールを提供しています。

ツールの詳細

ディレクトリのリスト

• ファイルとディレクトリ名のリストを返します。
• デフォルトでは、結果は .gitignore パターンに従ってフィルタリングされ、.git フォルダは除外されます。

ファイルの読み取り

• パラメータ：file_path（文字列）：読み取るファイルのパス（プロジェクトディレクトリに対する相対パス）
• ファイルの内容を文字列として返します。

ファイルの保存

• パラメータ：
  • file_path（文字列）：書き込むファイルのパス
  • content（文字列）：書き込む内容
• 操作が成功したかどうかを示すブール値を返します。

ファイルの追加

• パラメータ：
  • file_path（文字列）：追加するファイルのパス
  • content（文字列）：追加する内容
• 操作が成功したかどうかを示すブール値を返します。
• 注意：ファイルはすでに存在している必要があります。新しいファイルを作成するには save_file を使用してください。

ファイルの削除

• パラメータ：file_path（文字列）：削除するファイルのパス
• 操作が成功したかどうかを示すブール値を返します。
• 注意：この操作は元に戻せません。ファイルは永久に削除されます。

ファイルの編集

• パラメータ：
  • file_path（文字列）：編集するファイル
  • edits（配列）：編集操作のリスト。各操作には以下が含まれます。
    • old_text（文字列）：置き換えるテキスト
    • new_text（文字列）：新しい置き換えテキスト
  • dry_run（ブール値、オプション）：変更を適用せずにプレビューする
  • options（オブジェクト、オプション）：フォーマット設定
• 機能：
  • 行範囲とファイルパスのパターンマッチングをサポートします。
  • 複数の置き換えを同時にサポートします。

🔧 技術詳細

セキュリティ機能

• ファイルアクセス制御：

  • 読み取り、書き込み、追加操作のみが許可され、削除操作は厳格に禁止されています。
  • すべての変更は明示的な確認が必要で、誤った変更を防ぎます。

• ディレクトリ構造の保護：

  • ルートディレクトリとそのサブディレクトリの構造は保護されており、誤った削除や名前の変更が防止されます。

開発に関する説明

• コード構造：

  • プロジェクトは標準的な Python パッケージ構造で組織されています。
  • 主なモジュールには server.py と filesystem_server.py が含まれます。

• ログとデバッグ：

  • サーバは詳細なログ出力を提供し、デバッグや実行状態の監視が容易です。
  • 設定ファイルを通じてログレベルと出力形式を調整できます。

💻 使用例

基本的な使用法

基本テスト

1. サーバを起動します。

python src/server.py

2. VSCode の Cline ツールを使用して対話型テストを行います。
   • Cline ツールを開きます。
   • filesystem サーバを選択してセッションを開始します。

高度な使用法

ユニットテスト

• プロジェクトのルートディレクトリで以下のコマンドを実行します。

python -m pytest tests/

📄 ライセンス

このプロジェクトは MIT ライセンスに従っており、自由な使用、変更、配布が許可されています。詳細なライセンス内容は LICENSE ファイルを参照してください。

以上の設定と説明を通じて、MCP ファイルシステムサーバを開発環境にスムーズに統合し、その強力なファイル操作機能を利用して効率的な開発を行うことができます。