Local File Reader

🚀 MCP 本地文件閱讀器

MCP 本地文件閱讀器是一個基於 Model Context Protocol (MCP) 的本地文件讀取服務器，它能讓 AI 模型安全地訪問本地文件系統，為 AI 與本地文件交互提供了便利。

🚀 快速開始

安裝

npm install mcp-local-file-reader

作為命令行工具使用

安裝完成後，可直接在命令行中運行以下命令啟動 MCP 節點服務器，監聽 LLM 對話：

npx mcp-local-file-reader

✨ 主要特性

資源（Resources）

• 可列出並訪問本地文件系統中的文件。
• 支持多種文件類型，涵蓋文本文件和二進制文件。
• 能自動檢測文件 MIME 類型，並提供合適的內容處理。

工具（Tools）

• read_file - 讀取指定文件的內容：
  • 對於文本文件，返回完整內容。
  • 對於二進制文件，返回文件信息摘要。
• list_files - 列出指定目錄中的所有文件，返回文件名列表。
• get_file_info - 獲取指定文件的詳細信息，返回文件大小、類型、創建時間等元數據。

📦 安裝指南

npm install mcp-local-file-reader

💻 使用示例

作為命令行工具

npx mcp-local-file-reader

與 AI 工具集成

在 Windsurf 中使用

在 Windsurf 裡，無需手動啟動 mcp-local-file-reader，只需進行配置，Windsurf 會自動啟動它。具體步驟如下：

1. 在 Windsurf 的 mcp_config.json 配置文件中添加以下配置（暫時不需要 FILE_TOOLS_API_KEY）：

本地部署

{
  "servers": {
    "file-tools": {
      "command": "cmd",
      "args": [
        "/c",
        "node",
        "path/to/mcp-local-file-reader/build/index.js"
      ],
      "env": {
        "FILE_TOOLS_API_KEY": ""
      }
    }
  }
}

使用 npm 部署

{
  "servers": {
    "file-tools": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "mcp-local-file-reader"
      ],
      "env": {
        "FILE_TOOLS_API_KEY": ""
      }
    }
  }
}

點擊 Windsurf 對話框中的錘子圖標，然後點擊 refresh 刷新服務器。官方配置說明：https://docs.codeium.com/windsurf/mcp 2. 重啟 Windsurf 以加載新的 MCP 配置。

在其他 MCP 兼容的 AI 應用中使用

按照特定應用的 MCP 集成指南，添加此服務器作為工具提供者。在 cursor 的配置與 Windsurf 中的配置類似，在 VSCode 中可能會稍微複雜一些，但本質上都是配置 mcp.json，可參考類似的配置。

📚 詳細文檔

開發

安裝依賴

npm install

構建服務器

npm run build

開發模式（自動重新構建）

npm run watch

使用 MCP Inspector 測試

npm run inspector

⚠️ 安全注意事項

此服務器允許 AI 模型訪問本地文件系統，請謹慎使用並確保：

1. 只允許訪問必要的目錄。
2. 不要暴露敏感文件或目錄。
3. 在生產環境中使用前，考慮添加額外的安全限制。

📄 許可證

本項目採用 MIT 許可證。