Secure Filesystem

🚀 文件系统 MCP サーバ

Node.js を使用して実装された、ファイルシステム操作のモデルコンテキストプロトコル (MCP) サーバです。このサーバは、ファイルやディレクトリの操作を効率的に行うことができます。

✨ 主な機能

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

⚠️ 重要提示

このサーバは、args で指定されたディレクトリ内での操作のみを許可しています。

📚 ドキュメント

🔍 リソース

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

🛠️ ツール

• read_file

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

• read_multiple_files

  • 複数のファイルを同時に読み取ります。
  • 入力：paths（文字列配列）
  • 読み取りに失敗した場合でも、全体の操作は停止しません。

• write_file

  • 新しいファイルを作成するか、既存のファイルを上書きします（この機能は慎重に使用してください）。
  • 入力：
    • path（文字列）：ファイルパス
    • content（文字列）：ファイル内容

• edit_file

  • 高度なパターンマッチングとフォーマットを使用して選択的に編集します。
  • 機能：
    • 行ベースの複数行内容のマッチング
    • 行間の空白を標準化し、インデントを保持
    • 曖昧なマッチングを行い、信頼度スコアを提供
    • 複数の編集を同時に実行し、正しく位置を特定
    • インデントスタイルを検出して保持
    • Git スタイルのコンテキスト差分出力を提供
    • 試行モードを使用して変更をプレビュー
    • 信頼度スコアを通じて失敗したマッチングをデバッグ
  • 入力：
    • path（文字列）：編集するファイル
    • edits（配列）：編集操作のリスト
      • oldText（文字列）：検索するテキスト（部分文字列でも可）
      • newText（文字列）：置換するテキスト
    • dryRun（ブール値）：変更を適用せずにプレビュー（デフォルト：false）
    • options（オブジェクト）：オプションのフォーマット設定
      • preserveIndentation（ブール値）：既存のインデントを保持（デフォルト：true）
      • normalizeWhitespace（ブール値）：構造を保持しながら空白を標準化（デフォルト：true）
      • partialMatch（ブール値）：曖昧なマッチングを有効にする（デフォルト：true）
  • 試行時には詳細な差分とマッチング情報を返し、それ以外の場合は変更を適用します。
  • ベストプラクティス：常に試行モードで変更をプレビューしてから適用してください。

• create_directory

  • 新しいディレクトリを作成するか、既に存在する場合は何もしません。
  • 入力：path（文字列）
  • 必要に応じて親ディレクトリを作成します。
  • ディレクトリが既に存在する場合は、無事に成功します。

• list_directory

  • ディレクトリの内容を [FILE] または [DIR] の接頭辞付きで一覧表示します。
  • 入力：path（文字列）

• move_file

  • ファイルやディレクトリを移動またはリネームします。
  • 入力：
    • source（文字列）
    • destination（文字列）
  • 目標パスが存在する場合は、上書きされます。

• search_files

  • 指定されたディレクトリ内で指定された内容を含むファイルを検索します。
  • 入力：
    • directory（文字列）：検索するディレクトリ
    • content（文字列）：検索する内容
  • すべての一致するファイルのリストを返します。

• delete_file

  • 指定されたパスのファイルを削除します。
  • 入力：path（文字列）

💻 使用例

基本的な使用法

Docker ビルド

docker build -t mcp/filesystem -f src/filesystem/Dockerfile .

高度な使用法

Docker デプロイ例

# これはDockerfileの内容と仮定します
FROM node:16

WORKDIR /app

COPY package*.json ./

RUN npm install

COPY . .

CMD ["node", "index.js"]

MCP サーバの設定

// これは設定ファイルと仮定します
const config = {
  port: 3000,
  allowedDirectories: ['/path/to/directory1', '/path/to/directory2'],
  logging: true,
  maxFileSize: '1MB'
};

📄 ライセンス

この MCP サーバは MIT ライセンスの下で公開されています。これにより、ソフトウェアを自由に使用、変更、配布することができますが、MIT ライセンスの条項と条件に従う必要があります。詳細については、プロジェクトリポジトリ内の LICENSE ファイルを参照してください。