MCP Local File Reader

MCP Local File Reader

site icon
2025.03.19 3
JavaScript文件管理文件管理
MCP Local File Reader 是一个基于 Model Context Protocol (MCP) 的本地文件读取服务器,允许 AI 模型安全地访问本地文件系统。它提供了文件列表、文件内容读取和文件信息获取等功能,支持多种文件类型,并自动检测文件 MIME 类型。适用于需要 AI 模型访问本地文件系统的场景。
View on GitHub

Overview

基本能力

产品定位

MCP Local File Reader 是一个本地文件读取服务器,旨在为 AI 模型提供安全的本地文件系统访问能力。

核心功能

  1. 资源 (Resources)
  2. 列出和访问本地文件系统中的文件
  3. 支持多种文件类型,包括文本文件和二进制文件
  4. 自动检测文件 MIME 类型,提供适当的内容处理

  5. 工具 (Tools)

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

适用场景

  • AI 模型需要读取本地文件内容
  • 需要获取本地文件系统的文件列表或文件元数据
  • 在 Windsurf 或其他 MCP 兼容的 AI 应用中集成文件访问功能

使用教程

使用依赖

安装 Node.js 环境。

安装教程

npm install mcp-local-file-reader

作为命令行工具使用

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

npx mcp-local-file-reader

与 AI 工具集成

在 Windsurf 中使用

  1. 在 Windsurf 的 mcp_config.json 配置文件中添加以下配置:

本地化部署

{
  "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": ""
      }
    }
  }
}
  1. 重启 Windsurf 以加载新的 MCP 配置

调试方式

使用 MCP Inspector 测试:

npm run inspector

安全注意事项

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

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。