Secure Filesystem

🚀 文件系統 MCP 服務器

本項目是一個使用 Node.js 實現的文件系統操作模型上下文協議 (MCP) 的服務器，可實現文件的讀寫、目錄的管理等多種操作。

🚀 快速開始

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'
};

✨ 主要特性

• 支持讀取/寫入文件。
• 可創建/列出/刪除目錄。
• 能夠移動文件/目錄。
• 可以搜索文件。
• 能獲取文件元數據。

⚠️ 重要提示

該服務器僅允許在通過 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（字符串）。

📄 許可證

此 MCP 服務器根據 MIT 許可證發佈。這意味著您可以自由使用、修改和分發軟件，但需遵守 MIT 許可證的條款和條件。有關更多詳細信息，請參閱項目存儲庫中的 LICENSE 文件。