Readme Updater MCP

🚀 README-updater-mcp

這是一個通過Ollama分析語義衝突並更新README.md文件的MCP服務器，能夠有效處理內容添加時的衝突問題，確保文檔內容的一致性和準確性。

✨ 主要特性

• 可向指定的README.md文件添加內容。
• 在添加內容時，藉助Ollama（使用llama3模型）分析與現有內容的語義衝突。
• 若檢測到衝突，會嘗試按照Ollama的建議修改或刪除現有內容，再添加新內容。
• 若Ollama分析失敗，則以無衝突的方式添加內容（備用方案）。

📦 安裝指南

前置要求

• Node.js（推薦使用最新的LTS版本）
• 安裝 Ollama
• 下載Ollama llama3 模型：

ollama pull llama3

安裝步驟

1. 克隆倉庫：

git clone https://github.com/nCrom/readme-updater-mcp.git

2. 進入目錄：

cd readme-updater-mcp

3. 安裝依賴：

npm install

4. （可選）構建：服務器在運行時會自動構建，若需手動構建，可執行以下命令：

npm run build

📚 詳細文檔

MCP客戶端配置

需要在正在使用的MCP客戶端（如Cline、Claude Desktop等）的配置文件中註冊此服務器。

• Windows（以Claude Desktop為例）：%APPDATA%/Claude/claude_desktop_config.json
• macOS（以Claude Desktop為例）：~/Library/Application Support/Claude/claude_desktop_config.json
• Cline（VS Code擴展程序為例）：c:/Users/[用戶名]/AppData/Roaming/Windsurf/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json（路徑可能會有所變化）

在配置文件的mcpServers對象中添加以下內容，args中的路徑需修改為實際安裝服務器代碼的位置。

{
  "mcpServers": {
    // ... 其他服務器配置 ...
    "readme-updater-mcp": {
      "command": "node",
      "args": [
        // 示例: "C:/path/to/downloaded/readme-updater-mcp/build/index.js"
        // 請將其修改為實際服務器build/index.js文件的完整路徑。
        "/full/path/to/readme-updater-mcp/build/index.js"
      ],
      "env": {
        // 設置本地Ollama API地址（若與默認值相同可省略）
        "OLLAMA_HOST": "http://127.0.0.1:11434"
      },
      "disabled": false,
      "autoApprove": [] // 根據需要添加自動批准的工具
    }
  }
}

注意：需要重新啟動MCP客戶端，配置更改才能生效。

使用方法

通過MCP客戶端（如Cline）調用update_readme工具。

參數說明

• filePath（必填）：要更新的README.md文件的絕對路徑（字符串）
• contentToAppend（必填）：要添加到README文件的內容（字符串）
• commitMessage（可選）：提交消息（默認值："Update README.md"）
• branchName（可選）：分支名稱（默認值："main"）

示例命令

update_readme --filePath ./README.md --contentToAppend "# New Section\n## 內容添加\n這部分是自動添加的。"

輸出示例

Success: README.md更新完成
Commit Message: Update README.md
Branch Name: main