🚀 文件系统 MCP 服务器

本项目是一个基于 Node.js 实现的模型上下文协议（MCP）服务器，专门用于文件系统操作。它提供了丰富的文件和目录管理功能，能满足多样化的文件系统操作需求。

🚀 快速开始

在 claudia.json 文件中添加以下内容，即可在 Claude Desktop 中使用该服务器：

{
  "filesystem": {
    "server": "mcp/filesystem",
    "options": {
      "sandboxed_directories": [
        "/path/to/sandbox1",
        "/path/to/sandbox2"
      ]
    }
  }
}

使用以下命令构建 Docker 镜像：

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

✨ 主要特性

• 支持读取/写入文件，满足基本的文件数据交互需求。
• 可进行创建/列出/删除目录操作，灵活管理文件系统的目录结构。
• 能够移动文件/目录，方便进行文件位置的调整。
• 具备搜索文件功能，便于快速定位所需文件。
• 可以获取文件元数据，了解文件的详细信息。

⚠️ 重要提示

该服务器仅允许在通过 args 指定的目录内执行操作。

📚 详细文档

API 说明

资源

• file://system：文件系统操作接口

工具

• read_file

  • 功能：读取文件的完整内容。
  • 输入：path（字符串）
  • 说明：使用 UTF-8 编码读取整个文件内容。

• read_multiple_files

  • 功能：同时读取多个文件。
  • 输入：paths（字符串数组）
  • 说明：失败的读取不会停止整个操作。

• write_file

  • 功能：创建新文件或覆盖现有文件（使用此功能时需谨慎）。
  • 输入：
    • path（字符串）：文件路径
    • content（字符串）：文件内容

• edit_file

  • 功能：使用高级模式匹配和格式化进行选择性编辑。具体包括行内内容匹配和多行内容匹配、带缩进保留的空白字符规范化、模糊匹配带置信度评分、多次同时编辑并正确定位、缩进样式检测和保留、类似 Git 的差异输出带上下文、使用试运行模式预览更改、通过置信度评分调试失败的匹配。
  • 输入：
    • path（字符串）：要编辑的文件路径
    • edits（数组）：编辑操作列表
      • oldText（字符串）：要搜索的文本（可以是子字符串）
      • newText（字符串）：要替换的新文本
    • dryRun（布尔值）：预览更改而不应用（默认：false）
    • options（对象）：可选格式化设置
      • preserveIndentation（布尔值）：保留现有缩进（默认：true）
      • normalizeWhitespace（布尔值）：规范化空格字符（默认：true）
  • 输出：修改后的文件内容

• create_directory

  • 功能：创建新目录。
  • 输入：path（字符串）

• remove_directory

  • 功能：删除目录。
  • 输入：path（字符串）

• list_directories

  • 功能：列出所有子目录。
  • 输入：path（字符串）
  • 输出：包含子目录路径的数组

• rename_file

  • 功能：重命名文件。
  • 输入：
    • oldPath（字符串）：旧文件路径
    • newPath（字符串）：新文件路径

• delete_file

  • 功能：删除文件。
  • 输入：path（字符串）

📄 许可证

该 MCP 服务器根据 MIT 许可证发布。这意味着您可以自由地使用、修改和分发软件，但需遵守 MIT 许可证的条款和条件。有关详细信息，请参阅项目仓库中的 LICENSE 文件。