文件系统 MCP 服务器 SSE

Node.js 服务器 SSE 实现了用于文件系统操作的 Model Context Protocol (MCP)。

功能

• 读写文件
• 创建/列出/删除目录
• 移动文件/目录
• 搜索文件
• 获取文件元数据

注意：服务器仅允许在通过 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）
  • 返回详细的差异和匹配信息用于干运行，否则应用更改
  • 最佳实践：始终先使用 dryRun 预览更改，然后再应用它们

• create_directory

  • 创建新目录或确保其存在
  • 输入: path (字符串)
  • 如需要则创建父目录
  • 如果目录已存在，则静默成功

• list_directory

  • 列出带有 [FILE] 或 [DIR] 前缀的目录内容
  • 输入: path (字符串)

• move_file

  • 移动或重命名文件和目录
  • 输入:
    • source (字符串)
    • destination (字符串)
  • 如果目标已存在则失败

• search_files

  • 递归搜索文件/目录
  • 输入:
    • path (字符串): 起始目录
    • pattern (字符串): 搜索模式
    • excludePatterns (字符串数组): 排除任何模式。支持 glob 格式。
  • 不区分大小写的匹配
  • 返回匹配项的完整路径

• get_file_info

  • 获取详细的文件/目录元数据
  • 输入: path (字符串)
  • 返回:
    • 大小
    • 创建时间
    • 修改时间
    • 访问时间
    • 类型 (文件/目录)
    • 权限

• list_allowed_directories

  • 列出服务器允许访问的所有目录
  • 无需输入
  • 返回:
    • 该服务器可以从中读取/写入的目录

运行与使用

本地

1. 构建:

bash
npm install

2.1 Windows 上运行:

bash
node .distindex.js C:\Users\User

允许的目录: C:\Users\User

2.2 MacOS / Linux 上运行:

bash
node ./dist/index.js /Users

允许的目录: /Users

3. 配置:

json
{
"mcpServers": {
"file_system": {
"name": "file_system",
"baseUrl": "http://127.0.0.1:3001/sse"
}
}
}

许可证

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