只读文件系统服务

一个基于Node.js实现的只读文件系统服务,提供文件读取、目录列表、文件搜索和文件元数据获取等功能。

  • by danielsuguimoto
  • JavaScript
  • 本地部署
  • 6 星标
  • 更新于
在 GitHub 查看 danielsuguimoto/readonly-filesystem-mcp

使用说明

只读文件系统MCP服务器

Node.js服务器实现了用于只读文件系统操作的模型上下文协议(MCP)。克隆自 模型上下文协议/服务器文件系统.

特性

  • 读取文件
  • 列出目录
  • 搜索文件
  • 获取文件元数据

备注:服务器只允许在通过指定的目录内进行操作 args.

API

资源

  • file://system:文件系统操作界面

工具

  • read_file

    • 读取文件的完整内容
    • 输入:
      • path (string):要读取的文件路径
      • from (数字):可选。开始阅读的行号。默认为0。
      • to (数字):可选。结束行号。如果未设置,则读取到文件末尾。
    • 读取UTF-8编码的文件内容(全部或部分)
  • 读取多个文件

    • 同时读取多个文件
    • 输入: paths (字符串[])
    • 读取失败不会停止整个操作
  • list_directory

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

    • 递归搜索文件/目录
    • 输入:
      • path (string):起始目录
      • pattern (string):搜索模式
      • excludePatterns (string[]):排除任何模式。支持Glob格式。
    • 不区分大小写的匹配
    • 返回匹配项的完整路径
  • 获取_文件_信息

    • 获取详细的文件/目录元数据
    • 输入: path (字符串)
    • 退货:
      • 尺寸
      • 创建时间
      • 修改时间
      • 访问时间
      • 类型(文件/目录)
      • 权限
  • list_allowed_directories

    • 列出服务器允许访问的所有目录
    • 无需输入
    • 退货:
      • 此服务器可以读取/写入的目录

使用Claude Desktop

将此添加到您的 claude_desktop_config.json:

注意:您可以通过将沙盒目录挂载到以下位置来向服务器提供沙盒目录 /projects.添加 ro 标志将使目录对服务器只读。

NPX

{
  "mcpServers": {
    "filesystem": {
      "command": "npx",
      "args": [
        "-y",
        "@danielsuguimoto/readonly-server-filesystem",
        "/Users/username/Desktop",
        "/path/to/other/allowed/dir"
      ]
    }
  }
}

许可证

此MCP服务器根据MIT许可证获得许可。这意味着您可以根据MIT许可证的条款和条件自由使用、修改和分发软件。有关更多详细信息,请参阅项目存储库中的LICENSE文件。