返回市场
本地文件读取器

本地文件读取器

作者:sworddut10 星标更新:2025-03-19

项目介绍

MCP本地文件读取器

基于模型上下文协议(MCP)的本地文件读取服务器,允许AI模型安全地访问本地文件系统。

特性

资源

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

工具

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

安装

npm install mcp-local-file-reader

使用说明

作为命令行工具

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

npx mcp-local-file-reader

此时,将启动一个MCP节点服务器来监听LLM对话。

与AI工具集成

在Windsurf中使用

在Windsurf中,无需手动启动mcp本地文件读取器,只需进行配置。Windsurf会自动启动mcp本地文件读取器(配置在Windsurf的mcp_config.json中,点击刷新以刷新服务器)。

  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": ""
      }
    }
  }
}

在Windsurf对话框中点击小锤子图标,然后点击刷新以刷新服务器 官方配置说明: https://docs.codeium.com/windsurf/mcp

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

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

根据特定应用的MCP集成指南,将此服务器添加为工具提供者。光标配置类似于Windsurf中的配置,但VSCode的配置稍显复杂。但本质上是配置mcp.json,可以类似地进行配置。

开发

安装依赖项:

npm install

构建服务器:

npm run build

开发模式(自动重建):

npm run watch

使用MCP Inspector进行测试:

npm run inspector

安全注意事项

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

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

许可证

MIT