Readme Updater MCP

🚀 README-updater-mcp

This is an MCP server that analyzes semantic conflicts through Ollama and updates the README.md file.

✨ Features

• Add content to the specified README.md file.
• When adding content, analyze semantic conflicts with the existing content using Ollama (using the llama3 model).
• If a conflict is detected, attempt to modify or delete the existing content as suggested by Ollama and then add the new content.
• If the Ollama analysis fails, it will operate in a way that adds content without conflict (Fallback).

📦 Installation

Prerequisites

• Node.js (The latest LTS version is recommended).
• Install Ollama.
• Download the Ollama llama3 model:

ollama pull llama3

Steps

1. Clone the repository:

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

2. Navigate to the directory:

cd readme-updater-mcp

3. Install dependencies:

npm install

4. (Optional) Build: The server can be built automatically when running. If you want to build it manually, run the following command:

npm run build

📚 Documentation

MCP Client Configuration

You need to register this server in the configuration file of the MCP client you are using (e.g., Cline, Claude Desktop, etc.).

• Windows (Example for Claude Desktop): %APPDATA%/Claude/claude_desktop_config.json
• macOS (Example for Claude Desktop): ~/Library/Application Support/Claude/claude_desktop_config.json
• Cline (Example for VS Code Extension): c:/Users/[Username]/AppData/Roaming/Windsurf/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json (The path may vary).

Add the following content to the mcpServers object in the configuration file. The path in args should be modified to the actual location where the server code is installed.

{
  "mcpServers": {
    // ... Other server settings ...
    "readme-updater-mcp": {
      "command": "node",
      "args": [
        // Example: "C:/path/to/downloaded/readme-updater-mcp/build/index.js"
        // Modify it to the full path of the actual server build/index.js file.
        "/full/path/to/readme-updater-mcp/build/index.js"
      ],
      "env": {
        // Set the local Ollama API address (can be omitted if it is the same as the default value)
        "OLLAMA_HOST": "http://127.0.0.1:11434"
      },
      "disabled": false,
      "autoApprove": [] // Add tools to be automatically approved as needed
    }
  }
}

⚠️ Important Note

You need to restart the MCP client for the configuration changes to take effect.

Usage

Call the update_readme tool through an MCP client (e.g., Cline).

Parameters:

• filePath (Required): The absolute path of the README.md file to be updated (string).
• contentToAppend (Required): The content to be added to the README file (string).
• commitMessage (Optional): The commit message (Default: "Update README.md").
• branchName (Optional): The branch name (Default: "main").

Example command:

update_readme --filePath ./README.md --contentToAppend "# New Section\n## Added Content\nThis part was added automatically."

Example output:

Success: README.md updated successfully
Commit Message: Update README.md
Branch Name: main