Atomic Writer MCP Server

Atomic Writer MCP Server

site icon
2025.03.24 4
TypeScript安全文件操作原子文件操作文件完整性管理文件管理
Atomic Writer MCP Server 是一个安全的原子文件操作服务,通过 MCP(Model Context Protocol)协议提供事务性的文件操作。该服务专注于防止意外数据丢失,特别适用于需要高安全性的文件操作场景。
View on GitHub

Overview

产品定位

Atomic Writer MCP Server 是一个专注于安全文件操作的 MCP 服务,提供原子性、事务性的文件操作能力,特别适合需要防止意外数据丢失的场景。

核心功能

核心文件操作

  • 创建和写入文件(带内容验证)
  • 读取文件(带完整性检查)
  • 原子性移动文件
  • 安全删除文件(带回收站功能)
  • 追加和前置内容到文件

文本操作

  • 替换首次或全部匹配文本
  • 在指定行号插入内容
  • 删除指定行
  • 读取特定行或搜索词周围的上下文

安全特性

  • 所有操作都是原子性的并被记录
  • 文件完整性验证
  • 修改前自动备份
  • 回收站功能
  • 锁管理防止冲突
  • 操作回滚能力
  • 自动集成外部文件

系统操作

  • 系统状态监控
  • 文件操作历史
  • 锁管理
  • 从日志恢复文件
  • 完整性验证(支持外部文件)
  • 自动跟踪未跟踪文件

适用场景

  • AI集成需要修改文件的场景
  • 协作编辑系统
  • 关键数据管理
  • 任何需要防止意外数据丢失的应用

工具列表

文件操作工具

  • write-file: 创建新文件或写入空文件
  • read-file: 读取文件(带完整性验证)
  • delete-file: 将文件移动到回收站
  • move-file: 原子性移动/重命名文件
  • append-content: 追加内容到文件
  • prepend-content: 前置内容到文件

文本操作工具

  • replace-content: 替换首次出现的文本
  • replace-all-content: 替换所有出现的文本
  • insert-content-at-line: 在指定行号插入内容
  • delete-line: 删除指定行
  • read-lines: 读取指定行号
  • read-around: 读取搜索词周围的行

系统工具

  • verify-integrity: 检查文件完整性并初始化外部文件跟踪
  • get-status: 获取系统状态
  • recover-file: 从日志恢复文件
  • get-file-history: 查看操作历史
  • get-lock-status: 检查文件锁状态
  • force-release-lock: 释放卡住的锁
  • rollback-operation: 回滚更改

常见问题解答

  • 错误代码说明:
  • FILE_NOT_FOUND: 文件不存在
  • INVALID_PATH: 路径无效
  • EMPTY_CONTENT: 内容为空
  • LINE_OUT_OF_BOUNDS: 行号无效
  • FILE_LOCKED: 文件被锁定
  • INTEGRITY_ERROR: 校验和验证失败

使用教程

使用依赖

  1. 确保已安装 Node.js

安装教程

  1. 克隆仓库
  2. 安装依赖: npm install
  3. 构建项目: npm run build
  4. 在 MCP 主机的配置中配置服务器

调试方式

  • npm run test: 运行测试套件
  • npm run lint: 运行代码检查

MCP 服务器配置

添加到 claude_desktop_config.json:

{
  "mcpServers": {
    "atomic-writer": {
      "command": "node",
      "args": [
        "/absolute/path/to/atomic-writer/build/index.js",
        "/absolute/path/to/base/directory"
      ]
    }
  }
}

重要提示:第二个参数("/absolute/path/to/base/directory")是必需的,指定了 Atomic Writer 存储和管理文件的目录。

许可证

None