Filesystem MCP Server

Filesystem MCP Server

site icon
2025.03.04 0
JavaScript文件管理文件管理
Filesystem MCP Server 是一个基于 Node.js 的服务器,实现了 Model Context Protocol (MCP),专门用于文件系统操作。它提供了丰富的文件管理功能,包括文件的读写、目录的创建与删除、文件移动、文件搜索以及获取文件元数据等。该服务器设计为仅在通过参数指定的目录内进行操作,确保了操作的安全性。
View on GitHub

Overview

基本能力

产品定位

Filesystem MCP Server 是一个专注于文件系统操作的服务器,旨在提供高效、安全的文件管理解决方案。

核心功能

  • 文件的读写操作
  • 目录的创建、列出和删除
  • 文件和目录的移动
  • 文件搜索
  • 获取文件元数据

适用场景

  • 需要自动化文件管理的开发环境
  • 需要安全限制文件操作范围的应用
  • 需要高效文件搜索和批量处理的场景

工具列表及能力

  • read_file: 读取文件的完整内容,支持 UTF-8 编码。
  • read_multiple_files: 同时读取多个文件,即使部分读取失败也不会中断整个操作。
  • write_file: 创建新文件或覆盖现有文件。
  • edit_file: 使用高级模式匹配和格式化进行选择性编辑,支持多种编辑选项和预览模式。
  • create_directory: 创建新目录或确保目录存在。
  • list_directory: 列出目录内容,并标记文件和目录。
  • move_file: 移动或重命名文件和目录。
  • search_files: 递归搜索文件和目录,支持模式匹配和排除模式。
  • get_file_info: 获取文件和目录的详细元数据。
  • list_allowed_directories: 列出服务器允许访问的所有目录。

常见问题解答

  • 如何限制服务器访问的目录?:通过 args 参数指定允许访问的目录。
  • 如何预览文件编辑更改?:使用 edit_file 工具的 dryRun 选项进行预览。

使用教程

使用依赖

  • Node.js 环境
  • Docker(如需使用 Docker 运行)

安装教程

Docker 安装

docker build -t mcp/filesystem -f src/filesystem/Dockerfile .

NPX 安装

npx -y @modelcontextprotocol/server-filesystem /path/to/allowed/dir

调试方式

  • 使用 list_allowed_directories 工具确认服务器可访问的目录。
  • 使用 dryRun 选项预览文件编辑更改。

许可证

该项目遵循 MIT 开源许可条款。