@channel.io/github-pr-mcp
v1.0.0
Published
GitHub PR Model Context Protocol server for Channel.io
Readme
mcp-github-pr-server
개요
mcp-github-pr-server는 GitHub PR 리뷰를 위한 서버입니다.
사용 방법
mcp-github-pr-server 빌드
$ cd apps/github-pr-mcp && pnpm install && pnpm buildCursor Settings > Features > MCP 에서 + Add New MCP Server 클릭 하여 MCP 서버를 추가합니다.(#)
- Name: 아무거나
- Type: command
- Command:
env GITHUB_TOKEN=<<자신의 토큰>> GITHUB_DEFAULT_REPO=<<자주 사용하는 레포지토리>> node <<알맞은 경로>>/ch-mcp-tools/apps/github-pr-mcp/dist/index.js- GITHUB_TOKEN: GitHub API 요청을 위한 개인 액세스 토큰입니다. GitHub 설정에서 발급받을 수 있습니다.
- GITHUB_DEFAULT_REPO: 자주 사용하는 레포지토리 이름입니다(예: ch-dropwizard, ch-desk-web 등).
- 백엔드 개발자는 이미 GITHUB_TOKEN이 env에 설정되어 있기 때문에 별도로 추가할 필요가 없습니다.
- 여기서 설정한 자주 사용하는 레포지토리 이외의 레포에서 mcp를 사용할때는 반드시 pr 번호와 레포지토리 이름을 함께 전달해야합니다.
- PR 번호를 확인합니다.
- 아래의 프롬프트를 사용하여 AI 기반 PR 리뷰를 진행합니다.
권장 PR 유형
- 많은 수정 사항을 포함한 PR
- 처음 접한 도메인 PR
- 크리티컬한 기능을 포함한 PR
피해야할 PR 유형
- 이해하기 쉬운 PR
- 짧은 수정 사항의 PR
권장 프롬프트
아래의 프롬프트를 사용하면 체계적이고 효율적인 PR 리뷰를 진행할 수 있습니다:
목표:
- PR 리뷰
제한 사항:
- 코드 리뷰만 할 거라서 코드 수정 금지
- 내 허락없이 "순서"의 다음 단계로 넘어가지 말것
- "순서"의 다음 단계로 넘어가는 걸 제안할때는 이때까지 한것, 다음에 할 것을 정리하여 보여줄것
- 필요하다면 다른 브랜치를 checkout 하여 코드를 확인할 것
순서:
1. PR 번호, 레포지토리 이름 받기
2. PR 정보 수집
- get_pr_details 를 통해 PR 정보 가져오기
- 레포지토리 이름은 "channel-io/"를 제외하고 이름만 포함해야하며, 환경변수의 default repo 라면 전달하지 않아도됨
- 베이스 브랜치 최신화
- 최신화 시에는 "git fetch origin {} || git fetch upstream {} ; git checkout {} ; git pull origin {} || git pull upstream {};"
- PR 브랜치 checkout
- 체크아웃 시에는 "git fetch origin pull/{}/head:pr-{} || git fetch upstream pull/{}/head:pr-{}; git checkout pr-{};"를 사용할 것
- 코드 변경 사항 확인
3. 어떤 문제를 해결하기 위한 것인지, 어떻게 문제를 해결했는지, 왜 그렇게 해결했는지 파악
4. 리뷰 방향 논의 및 결정
5. 리뷰 순서 논의 및 결정
6. 5번에서 결정된 리뷰 순서에 따라 순차적으로 진행
- 리뷰시 내가 코멘트할 수 있도록 먼저 자세히 설명해줘
- 내가 코멘트하고 나면 너가 코멘트를 해줘이 프롬프트를 사용하면 체계적인 순서로 PR 리뷰를 진행할 수 있으며, 각 단계별로 필요한 정보를 수집하고 논의할 수 있습니다.
