Filesystem MCP Server (MOD)

Filesystem MCP Server (MOD)

site icon
2025.04.17 0
JavaScript文件管理文件管理
Filesystem MCP Server (MOD) 是一个基于文件系统的MCP服务器,支持对当前项目文件夹进行文件读写、目录操作、文件搜索和获取文件元数据等功能。该服务器默认工作于当前项目文件夹,所有路径均可相对于项目根目录,便于将MCP服务器作为全局服务而非每个项目的本地服务使用。
View on GitHub

Overview

基本能力

产品定位

Filesystem MCP Server (MOD) 是一个用于文件系统操作的MCP服务器,支持对文件进行读写、目录操作、文件搜索和获取文件元数据等功能。

核心功能

  • 文件读写:支持读取、写入、编辑文件内容。
  • 目录操作:支持创建、列出、删除目录。
  • 文件移动:支持移动或重命名文件和目录。
  • 文件搜索:支持递归搜索文件和目录。
  • 文件元数据:支持获取文件或目录的详细信息(如大小、创建时间、修改时间等)。

适用场景

  • 项目文件管理:适用于需要对项目文件进行批量操作或管理的场景。
  • 文件编辑:适用于需要对文件内容进行选择性编辑的场景。
  • 文件搜索:适用于需要快速查找项目中的文件或目录的场景。

工具列表

  • read_file:读取文件的完整内容。
  • read_multiple_files:同时读取多个文件的内容。
  • write_file:创建新文件或覆盖现有文件。
  • edit_file:对文件内容进行选择性编辑,支持预览模式。
  • create_directory:创建新目录或确保目录存在。
  • list_directory:列出目录内容。
  • move_file:移动或重命名文件和目录。
  • search_files:递归搜索文件或目录。
  • get_file_info:获取文件或目录的元数据。
  • list_allowed_directories:列出服务器允许访问的所有目录。

常见问题解答

  • 如何预览文件编辑? 使用 edit_file 工具的 dryRun 参数设置为 true 可以预览编辑效果而不实际应用更改。
  • 如何避免覆盖现有文件? 使用 write_file 工具时需谨慎,确保路径正确以避免意外覆盖。

使用教程

使用依赖

无特殊依赖,直接安装即可。

安装教程

  1. 克隆项目仓库: bash git clone https://github.com/modelcontextprotocol/servers.git
  2. 进入项目目录: bash cd servers/src/filesystem
  3. 启动服务器: bash npm start

调试方式

  1. 检查服务器是否运行: bash curl http://localhost:3000/file://system
  2. 测试文件读取: bash curl -X POST -H "Content-Type: application/json" -d '{"path":"example.txt"}' http://localhost:3000/file://system/read_file
  3. 测试文件写入: bash curl -X POST -H "Content-Type: application/json" -d '{"path":"example.txt", "content":"Hello, World!"}' http://localhost:3000/file://system/write_file

许可证

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