활용 가이드
코드와 API 설명을 대조하고 저장소에 연결한 문서의 직접 갱신 결과를 요청·응답·예시와 함께 확인합니다.
API 코드와 문서의 요청·응답이 달라졌다면, 현재 구현을 읽어 문서를 만들고 연결된 문서의 다음 변경까지 확인하세요.
준비할 자료
라우트, 핸들러, 스키마가 있는 GitHub 저장소와 대상 브랜치를 준비합니다. 기존 API 문서와 대상 독자도 정합니다. 인증 정보나 운영 시크릿의 실제 값은 문서에 넣지 않습니다.


생성과 리뷰
채팅으로 저장소를 읽고 API 레퍼런스를 작성하도록 요청합니다. 호출 흐름을 이해하기 어렵다면 클라이언트·서버·외부 서비스 사이의 다이어그램도 요청하세요. 경로와 메서드, 필수 필드, 상태 코드, 인증·권한, 페이지네이션, 오류와 예시를 실제 핸들러·스키마·테스트와 대조합니다.
코드 변경 후 갱신
자동 갱신이 필요한 기존 문서나 캔버스에 저장소와 브랜치를 연결합니다. 해당 브랜치의 push는 연결된 결과물을 직접 갱신하는 실행을 시작할 수 있습니다. 갱신된 본문과 변경 이력에서 반영 내용을 확인하세요. 함께 유지할 다른 가이드도 각각 저장소에 연결합니다.
채팅 요청 예시
API 저장소의 현재 브랜치를 읽고 주문 생성 API 문서를 작성해 줘.
요청·응답·오류·권한과 예시를 근거 파일 경로와 함께 정리해 줘.
확인하지 못한 동작은 미확인으로 남기고 호출 흐름도 설명해 줘.기존 연동을 깨는 변경은 마이그레이션 안내와 공지 범위를 사람이 결정합니다. 구현을 고칠 때에는 개선 문서를 만들고 코딩 에이전트에 MCP로 읽게 한 뒤, push 후 연결된 문서를 다시 검토하세요.