Filesystem MCP Server SSE

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

Node.js をベースとしたファイルシステム SSE サーバーで、モデルコンテキストプロトコル（MCP）を実装し、ファイルシステム操作を行います。

✨ 主な機能

• ファイルの読み取り/書き込み
• ディレクトリの作成/一覧表示/削除
• ファイル/ディレクトリの移動
• ファイルの検索
• ファイルのメタデータの取得

⚠️ 重要提示

サーバーは args パラメータで指定されたディレクトリ内での操作のみを許可します。

📄 API ドキュメント

リソースパス

• file://system：ファイルシステム操作インターフェース

ツールメソッド

read_file

• ファイルの全内容を読み取ります。
• 入力パラメータ：path（文字列）
• UTF-8 エンコーディングでファイル全体の内容を読み取ります。

read_multiple_files

• 複数のファイルを同時に読み取ります。
• 入力パラメータ：paths（文字列配列）
• 読み取りに失敗しても、全体の操作は中止されません。

write_file

• 新しいファイルを作成するか、既存のファイルを上書きします（使用時は注意が必要です）。
• 入力パラメータ：
  • path（文字列）：ファイルパス
  • content（文字列）：ファイル内容

edit_file

• 高度なパターンマッチングとフォーマットを使用して選択的に編集します。
• 機能特性：
  • 行レベルおよび複数行の内容マッチング
  • インデントを自動検出し、インデントスタイルを保持
  • 複数の編集操作を同時に実行し、正しく位置を特定
  • コンテキスト付きの Git スタイルの diff 出力を自動生成
  • ドライランモードで変更をプレビューできます（デフォルト：false）
• 入力パラメータ：
  • path（文字列）：編集するファイルのパス
  • edits（配列）：編集操作のリスト
    • oldText（文字列）：検索するテキスト（部分文字列でも可）
    • newText（文字列）：置換するテキスト
  • dryRun（ブール値）：変更を実際に適用せずにプレビュー（デフォルト：false）
• ドライランモードでは詳細な diff とマッチング情報を返し、それ以外の場合は変更を適用します。
• ベストプラクティス：常にドライランモードで変更をプレビューし、問題がないことを確認してから実行してください。

create_directory

• 新しいディレクトリを作成するか、ディレクトリが存在することを確認します。
• 入力パラメータ：path（文字列）
• 必要に応じて親ディレクトリを自動的に作成します。
• ディレクトリが既に存在する場合は、無事に成功します。

list_directory

• ディレクトリの内容を一覧表示します。ファイルは [FILE] で、ディレクトリは [DIR] でプレフィックス付きで表示されます。
• 入力パラメータ：path（文字列）

move_file

• ファイルやディレクトリを移動またはリネームします。
• 入力パラメータ：
  • source（文字列）：ソースパス
  • destination（文字列）：宛先パス
• 宛先が既に存在する場合は、操作は失敗します。

search_files

• ファイル/ディレクトリを再帰的に検索します。
• 入力パラメータ：
  • path（文字列）：検索を開始するディレクトリ
  • pattern（文字列）：検索パターン
  • excludePatterns（文字列配列）：除外するパターンのリスト（glob 形式をサポート）
• 大文字小文字を区別せずにマッチングします。
• 完全なマッチングファイルパスを返します。

get_file_info

• ファイル/ディレクトリの詳細なメタデータを取得します。
• 入力パラメータ：path（文字列）
• 返される結果には以下が含まれます：
  • name（文字列）：名前
  • type（文字列）："file" または "directory"
  • size（数値）：サイズ（バイト）
  • mtime（タイムスタンプ）：最終更新時間
  • ctime（タイムスタンプ）：作成時間

get_file_list

• 指定されたディレクトリ内のすべてのファイルとサブディレクトリを取得します。
• 入力パラメータ：
  • path（文字列）：一覧表示するディレクトリのパス
  • recursive（ブール値、デフォルト：false）：サブディレクトリを再帰的に走査するかどうか
• 返される結果は、ファイルとディレクトリの情報を含む配列です。

💻 使用例

ローカルでの実行例

1. 依存関係のインストール：

npm install

2. サービスの起動：

node index.js

3. curl を使用して API をテスト：

curl -X POST http://localhost:3000/file-system/read-file \
  -H "Content-Type: application/json" \
  -d '{"path": "/test.txt"}'

Docker での実行例

1. イメージのビルド：

docker build -t file-system-mcp .

2. コンテナの起動：

docker run -p 3000:3000 --name file-system-service file-system-mcp

📚 注意事項

• すべてのファイル操作では、権限不足やファイルが存在しないなど、可能な例外を処理する必要があります。
• デフォルトでは、サーバーはすべてのリクエストに対して基本的な認証と承認チェックを行います。
• 最大アップロードファイルサイズ制限と同時接続数制限を設定できます。

📄 ライセンス

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