Fire in da houseTop Tip:Paying $100+ per month for Perplexity, MidJourney, Runway, ChatGPT and other tools is crazy - get all your AI tools in one site starting at $15 per month with Galaxy AI Fire in da houseCheck it out free

mcp-local-file-reader

MCP.Pizza Chef: sworddut

mcp-local-file-reader is an MCP server that enables AI models to securely access and read local files. It supports multiple file types, automatically detects MIME types, and provides tools to read file contents, list directory files, and retrieve detailed file metadata such as size and creation time. This server integrates easily with AI workflows, allowing real-time, safe interaction with the local file system.

Use This MCP server To

Read contents of local text files for AI processing List files in local directories for file management Retrieve metadata of local files for auditing or indexing Enable AI models to access local binary file summaries Integrate local file reading into AI-enhanced development tools Automate file content extraction for document analysis Support AI workflows requiring real-time local file access

README

MCP Local File Reader

一个基于 Model Context Protocol (MCP) 的本地文件读取服务器,允许 AI 模型安全地访问本地文件系统。

功能特点

资源 (Resources)

  • 列出和访问本地文件系统中的文件
  • 支持多种文件类型,包括文本文件和二进制文件
  • 自动检测文件 MIME 类型,提供适当的内容处理

工具 (Tools)

  • read_file - 读取指定文件的内容
    • 对文本文件返回完整内容
    • 对二进制文件返回文件信息摘要
  • list_files - 列出指定目录中的所有文件
    • 返回文件名列表
  • get_file_info - 获取指定文件的详细信息
    • 返回文件大小、类型、创建时间等元数据

安装

npm install mcp-local-file-reader

使用方法

作为命令行工具

安装后,可以直接在命令行中运行:

npx mcp-local-file-reader

此时会启动一个 MCP node服务器,监听llm对话。

与 AI 工具集成

在 Windsurf 中使用

在windsurf中,不需要手动启动mcp-local-file-reader,只需要配置即可,windsurf会自动启动mcp-local-file-reader(在windsurf的mcp_config.json中配置,点击refresh刷新服务器)。

  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对话框的小锤子图标,点击refrsh刷新服务器 官方配置说明:https://docs.codeium.com/windsurf/mcp

  1. 重启 Windsurf 以加载新的 MCP 配置

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

按照特定应用的 MCP 集成指南,添加此服务器作为工具提供者。cursor配置与windsurf中的配置类似,vscode的cline会稍微复杂一些。但是本质都是配置mcp.json,可以类似的配置。

开发

安装依赖:

npm install

构建服务器:

npm run build

开发模式(自动重新构建):

npm run watch

使用 MCP Inspector 测试:

npm run inspector

安全注意事项

此服务器允许 AI 模型访问本地文件系统,请谨慎使用并确保:

  1. 只允许访问必要的目录
  2. 不要暴露敏感文件或目录
  3. 在生产环境中使用前,考虑添加额外的安全限制

许可证

MIT

mcp-local-file-reader FAQ

How do I install mcp-local-file-reader?
Install it via npm using 'npm install mcp-local-file-reader'.
How do I start the mcp-local-file-reader server?
Run it directly with 'npx mcp-local-file-reader' to start the MCP node server.
Can mcp-local-file-reader handle binary files?
Yes, it returns summaries for binary files and full content for text files.
How does mcp-local-file-reader detect file types?
It automatically detects MIME types to provide appropriate content handling.
Is mcp-local-file-reader compatible with AI tool integrations?
Yes, it integrates with AI tools like Windsurf for seamless local file access.
What file operations does mcp-local-file-reader support?
It supports reading files, listing directory contents, and retrieving file metadata.
Can I configure mcp-local-file-reader for custom environments?
Yes, you can configure it via command line or JSON config files for different setups.
Does mcp-local-file-reader support secure file access?
Yes, it is designed to safely expose local files to AI models using MCP protocols.