Filesystem MCP Server SSE

🚀 文件系統 MCP 服務端 SSE

本項目是基於 Node.js 的文件系統 SSE 服務端，實現了模型上下文協議（MCP），可用於文件系統操作，為文件管理提供了便捷的解決方案。

🚀 快速開始

本地運行示例

1. 安裝依賴：

npm install

2. 啟動服務：

node index.js

3. 使用 curl 測試接口：

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

✨ 主要特性

• 讀取/寫入文件
• 創建/列出/刪除目錄
• 移動文件/目錄
• 搜索文件
• 獲取文件元數據

⚠️ 重要提示

服務器僅允許在通過 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 和匹配信息（ dryRun 模式），否則應用更改
• 最佳實踐：始終使用幹運行模式預覽更改，確認無誤後再執行

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）：是否遞歸遍歷子目錄
• 返回結果為包含文件和目錄信息的數組

📄 許可證

本項目遵循 MIT 許可證協議。更多信息請查看項目倉庫中的 LICENSE 文件。

⚠️ 重要提示

• 所有文件操作均需處理可能的異常情況，例如權限不足、文件不存在等
• 默認情況下，服務器會對所有請求進行基本的身份驗證和授權檢查
• 支持設置最大上傳文件大小限制和併發連接數限制