Atomic Writer MCP

🚀 原子寫手 MCP 服務器

原子寫手 MCP 服務器是一個安全且原子化的文件操作服務，以 MCP（模型上下文協議）服務器的形式實現。它通過 MCP 協議提供安全、事務性的文件操作，能有效避免文件操作中的意外數據丟失。

🚀 快速開始

原子寫手 MCP 服務器旨在提供安全的文件操作。以下是使用前的安裝與配置步驟：

1. 克隆倉庫

   git clone https://github.com/yourusername/atomic-writer.git
   cd atomic-writer
   

2. 安裝依賴

   npm install
   

3. 構建項目（如果使用 TypeScript）

   npm run build
   

4. 配置 MCP 主機

   • 在你的 MCP 配置文件中添加如下設置：

     {
       "servers": {
         "atomic-writer": {
           "type": "MCP",
           "host": "localhost",
           "port": 3001,
           "path": "/api"
         }
       }
     }
     

✨ 主要特性

核心功能

• 原子操作：所有文件操作都是原子化的，確保要麼完全成功，要麼不發生。
• 完整性檢查：每個文件都有 checksum 驗證，確保內容的完整性和一致性。
• 防止覆蓋：新內容只能追加，避免意外覆蓋現有數據。
• 日誌記錄：詳細的操作日誌，支持回滾和故障排除。

安全特性

• 鎖定機制：在操作期間對文件進行鎖定，防止其他進程干擾。
• 垃圾目錄：刪除的文件不會被永久刪除，而是移動到垃圾目錄中。
• 臨時文件：所有更改都先寫入臨時文件，確保原文件的安全性。

支持的操作

• 文件創建
• 文件讀取
• 文件更新
• 文件刪除
• 內容替換
• 內容插入
• 內容刪除

📦 安裝指南

1. 克隆倉庫

   git clone https://github.com/yourusername/atomic-writer.git
   cd atomic-writer
   

2. 安裝依賴

   npm install
   

3. 構建項目（如果使用 TypeScript）

   npm run build
   

4. 配置 MCP 主機

   • 在你的 MCP 配置文件中添加如下設置：

     {
       "servers": {
         "atomic-writer": {
           "type": "MCP",
           "host": "localhost",
           "port": 3001,
           "path": "/api"
         }
       }
     }
     

💻 使用示例

基礎用法

// 創建文件
const writer = new AtomicWriter('localhost', 3001, '/api');
await writer.createFile('/notes/new-note.md', 'hello world');

// 更新文件內容
await writer.updateContent('/notes/example.md', 'new content');

// 回滾操作
// 如果發生錯誤，可以通過日誌回滾到之前的狀態
writer.rollback('latest successful state');

📚 詳細文檔

動機

你是否曾經遇到過大型語言模型不小心刪除你的內容，而它還在自信地進行幫助？這是一個常見且令人沮喪的經歷——AI 自信地修改文件，卻在事後意識到自己意外刪除了重要信息。

開發此係統源於一次特別痛苦的體驗：在使用 Obsidian 筆記時遇到了問題。當時正在集成一個允許 AI 幫助管理筆記的功能，結果發現有時它會不經意間 wiping out 筆記內容的一半而沒有意識到其影響。

在那之後，開發了這個系統——原子寫手，這是一個以安全為首要考慮的文件操作系統，通過設計防止破壞性操作：

• 新內容只能追加，絕不會覆蓋
• 文件僅在不存在且為空的情況下創建
• 所有操作都被記錄並可以回滾
• 持續監控和驗證文件完整性

雖然最初是為了防止 AI 的意外修改而開發的，但原子寫手可以在任何需要文件安全性的場景中使用。它非常適合：

• 需要修改文件的 AI 整合
• 協作編輯系統
• 關鍵數據管理
• 任何需要防止意外數據丟失的應用

📄 許可證

項目遵循 MIT License，自由使用和修改，但需保留版權聲明。

通過原子寫手 MCP 服務器，您可以在處理文件操作時享有更高的安全性和可靠性。無論是個人筆記、團隊協作還是關鍵數據管理，它都能為您的文件保駕護航。

學習與貢獻

• 問題反饋：遇到任何問題，請在 GitHub Issues 中提出。
• 代碼貢獻：歡迎 fork 倉庫並提交pull request，幫助改進系統功能和性能。
• 文檔擴展：如果您對某個模塊或功能有深入瞭解，歡迎補充和完善文檔內容。