README-updater-mcp

Ollama를 통해 의미 충돌을 분석하고 README.md 파일을 업데이트하는 MCP 서버입니다.

기능

• 지정된 README.md 파일에 내용을 추가합니다.
• 내용을 추가할 때 Ollama (llama3 모델 사용)로 기존 내용과의 의미 충돌을 분석합니다.
• 충돌이 감지되면 Ollama가 제안하는대로 기존 내용을 수정하거나 삭제 후 새 내용을 추가하려고 시도합니다.
• Ollama 분석에 실패하면, 충돌 없이 내용을 추가하는 방법으로 동작합니다 (Fallback).

사전 요구 사항

• 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