Readonly Filesystem MCP

🚀 僅讀文件系統 MCP 服務器

本項目是一個基於 Node.js 的服務器，實現了模型上下文協議（MCP），專門用於僅讀文件操作。它從 modelcontextprotocol/server-filesystem 克隆而來，為文件讀取相關操作提供了便捷的解決方案。

🚀 快速開始

在你的 claude_desktop_config.json 中添加以下內容，即可開始使用本服務器。

注意：你可以通過將目錄掛載到 /projects 來為服務器提供受限制的目錄。添加 ro 標誌會使服務器以只讀方式訪問該目錄。

NPX

{
  "mcpServers": {
    "filesystem": {
      "command": "npx",
      "args": [
        "-y",
        "@danielsuguimoto/readonly-server-filesystem",
        "/Users/username/Desktop",
        "/path/to/other/allowed/dir"
      ]
    }
  }
}

✨ 主要特性

• 讀取文件：支持讀取單個文件的完整或部分內容，還能同時讀取多個文件。
• 列出目錄：可列出指定目錄的內容，並帶有 [FILE] 或 [DIR] 前綴。
• 搜索文件：能遞歸搜索文件/目錄，支持不區分大小寫的匹配，還可排除特定模式。
• 獲取文件元數據：可獲取文件/目錄的詳細元數據，如大小、創建時間等。

⚠️ 重要提示

服務器僅允許在通過 args 指定的目錄內執行操作。

📚 詳細文檔

🔌 API 文檔

資源

• file://system：文件系統操作接口

工具

• read_file

  • 功能：讀取文件的完整內容
  • 輸入：
    • path（字符串）：要讀取的文件路徑
    • from（數字）：可選。開始讀取的行號，默認為 0。
    • to（數字）：可選。結束行號。如果不設置，則讀取到文件末尾。
  • 輸出：以 UTF-8 編碼讀取的文件內容（完整或部分）

• read_multiple_files

  • 功能：同時讀取多個文件
  • 輸入：paths（字符串數組）
  • 特點：讀取失敗不會終止整個操作

• list_directory

  • 功能：列出目錄內容，帶有 [FILE] 或 [DIR] 前綴
  • 輸入：path（字符串）

• search_files

  • 功能：遞歸搜索文件/目錄
  • 輸入：
    • path（字符串）：起始目錄
    • pattern（字符串）：搜索模式
    • excludePatterns（字符串數組）：排除任何匹配的模式。支持 glob 格式。
  • 特點：不區分大小寫的匹配，返回完整的匹配路徑

• get_file_info

  • 功能：獲取文件/目錄的詳細元數據
  • 輸入：path（字符串）
  • 輸出：
    • 大小
    • 創建時間
    • 修改時間
    • 訪問時間
    • 類型（文件/目錄）
    • 權限

• list_allowed_directories

  • 功能：列出服務器允許訪問的所有目錄
  • 輸入：無
  • 輸出：該服務器可以讀取/寫入的目錄

📄 許可證

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