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