MCP Filesystem

🚀 MCP 文件系統服務器

MCP 文件系統服務器是一個功能強大且安全的文件管理系統，支持文件和目錄操作、元數據訪問、命令執行等功能，還具備 Docker 支持，方便部署。

🚀 快速開始

# 安裝
npm install mcp-filesystem -g

# 啟動服務器
mcp-filesystem start --port 3000

# 創建配置文件
mcp-filesystem --create-config config.json

# 根據需要編輯 config.json 並重新啟動服務器

📦 安裝指南

要使用 MCP 文件系統服務器，請按照以下步驟操作：

安裝 Node.js 和 npm/yarn

確保您的系統已安裝 Node.js（版本 14 或更高）和 npm 或 yarn。

安裝 MCP 文件系統服務器

使用 npm 或 yarn 進行安裝：

npm install mcp-filesystem -g
# 或者
yarn global add mcp-filesystem

💻 使用示例

基礎用法

# 啟動服務器
mcp-filesystem start --port 3000

將 3000 替換為您所需的端口號。

高級用法

# 創建配置文件
mcp-filesystem --create-config config.json

✨ 主要特性

核心功能

• 文件操作：讀取、寫入、編輯和移動文件。
• 目錄操作：創建、列出、獲取樹視圖和搜索目錄。
• 元數據訪問：查看文件和目錄信息。
• 命令執行：安全地執行系統命令。
• Docker 支持：通過 Docker 和 Docker Compose 方便部署。

新功能（v0.3.0）

• 結構化日誌記錄：詳細日誌，包括調試、信息、警告和錯誤級別。
• 性能指標：跟蹤操作計數、錯誤和執行時間。
• 配置管理：支持 JSON 配置文件。
• 路徑緩存：提升頻繁訪問路徑的性能。
• 改進錯誤處理：專用錯誤類型，包含結構化信息。
• 文件大小驗證：防止加載過大文件。
• CLI 改進：幫助命令、版本信息和配置生成。

📚 詳細文檔

創建配置文件後，您可以根據需要進行調整。以下是一個示例：

{
  "allowedDirectories": ["/path/to/allowed/dir1", "/path/to/allowed/dir2"],
  "logLevel": "info",
  "logFile": "/path/to/logs/mcp-filesystem.log",
  "serverName": "secure-filesystem-server",
  "serverVersion": "0.3.0",
  "cache": {
    "enabled": true,
    "maxSize": 1000,
    "ttlMs": 60000
  },
  "metrics": {
    "enabled": true,
    "reportIntervalMs": 60000
  },
  "security": {
    "maxFileSize": 10485760,
    "allowSymlinks": true,
    "validateRealPath": true
  }
}

🔧 技術細節

安全注意事項

• 允許目錄：僅添加可信路徑以防止未經授權的訪問。
• 文件大小限制：根據需求設置 maxFileSize，默認為10MB。
• 符號鏈接：根據安全策略選擇是否允許符號鏈接。

文檔擴展

如需更詳細的文檔或遇到問題，請參考官方文檔或其他資源。

開發者信息

MCP 文件系統服務器由 [開發者姓名] 開發，旨在提供一個功能強大且安全的文件管理系統。