docs: MCP 도메인 주석/Javadoc 정리

[kangcheolung]

Summary

• MCP 도메인(설정~도구 계층) 전체 주석을 코드 리뷰하며 정리
• 코드로 자명한 WHAT 주석 제거, WHY만 유지 또는 실제 선언 위 Javadoc으로 이동
• SecurityConfig/McpApiKeyAuthFilter의 실제 동작과 어긋난 주석(401 vs 403, 인증 vs 인가 표현) 정정
• 응답 DTO 4종에 클래스 레벨 @Schema 추가(앱 전체 관례에 맞춤)
• 로직 변경 없음 (주석/Javadoc만 수정)

Test plan

• ./backend/gradlew -p backend compileJava 통과
• ./backend/gradlew -p backend test --tests "com.opensource.docgrid.domain.mcp.*" 통과

🤖 Generated with Claude Code

Summary by CodeRabbit

• 문서화
  • MCP 액세스 토큰, 문서 응답 및 토큰 폐기 응답에 대한 API 문서 설명을 보강했습니다.
  • MCP 인증, 보안 필터, 요청 제한, 도구 실행 흐름에 대한 주석과 Javadoc을 정리했습니다.
  • 토큰 저장 및 생성 시각 관리 방식과 웹 요청 인터셉터 동작을 문서화했습니다.
  • 실행 로직과 보안 동작에는 변경이 없습니다.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 3b057ec4-3692-4865-b738-9d91e032c731

📥 Commits

Reviewing files that changed from the base of the PR and between 679ae0d and f84e768.

📒 Files selected for processing (13)

• backend/src/main/java/com/opensource/docgrid/domain/mcp/converter/McpAccessTokenConverter.java
• backend/src/main/java/com/opensource/docgrid/domain/mcp/dto/response/DocumentDetailResponse.java
• backend/src/main/java/com/opensource/docgrid/domain/mcp/dto/response/McpAccessTokenIssueResponse.java
• backend/src/main/java/com/opensource/docgrid/domain/mcp/dto/response/McpAccessTokenListResponse.java
• backend/src/main/java/com/opensource/docgrid/domain/mcp/dto/response/McpAccessTokenResponse.java
• backend/src/main/java/com/opensource/docgrid/domain/mcp/dto/response/McpAccessTokenRevokeResponse.java
• backend/src/main/java/com/opensource/docgrid/domain/mcp/security/McpApiKeyAuthFilter.java
• backend/src/main/java/com/opensource/docgrid/domain/mcp/security/McpRateLimiter.java
• backend/src/main/java/com/opensource/docgrid/domain/mcp/tool/DocGridMcpTools.java
• backend/src/main/java/com/opensource/docgrid/domain/user/entity/McpAccessToken.java
• backend/src/main/java/com/opensource/docgrid/domain/user/repository/McpAccessTokenRepository.java
• backend/src/main/java/com/opensource/docgrid/global/config/SecurityConfig.java
• backend/src/main/java/com/opensource/docgrid/global/config/WebMvcConfig.java

---

📝 Walkthrough

Walkthrough

MCP 토큰 응답 DTO에 Swagger 설명을 추가했습니다. 토큰, 인증 필터, 요청 제한, 도구 실행, 보안 설정, MVC 인터셉터의 JavaDoc과 주석을 정비했습니다. 실행 로직과 공개 메서드 시그니처는 변경하지 않았습니다.

Changes

MCP 문서화 정비

Layer / File(s)	Summary
토큰 API와 저장 설명 backend/src/main/java/com/opensource/docgrid/domain/mcp/dto/response/*, backend/src/main/java/com/opensource/docgrid/domain/mcp/converter/McpAccessTokenConverter.java, backend/src/main/java/com/opensource/docgrid/domain/user/{entity,repository}/*	토큰 응답 DTO에 @Schema 설명을 추가했습니다. 토큰 원본·해시 처리, 폐기 상태 반영, 저장소 조회 규칙을 JavaDoc으로 설명했습니다.
MCP 인증과 도구 설명 backend/src/main/java/com/opensource/docgrid/domain/mcp/security/*, backend/src/main/java/com/opensource/docgrid/domain/mcp/tool/DocGridMcpTools.java	API 키 인증 범위, SecurityContext 저장, 사용자 식별, 요청 제한 동기화, 도구 실행 제약을 문서화했습니다.
보안 및 MVC 설정 설명 backend/src/main/java/com/opensource/docgrid/global/config/SecurityConfig.java, backend/src/main/java/com/opensource/docgrid/global/config/WebMvcConfig.java	JWT 및 MCP 인증 필터의 실행 위치와 MVC 인터셉터의 OSIV 적용 범위를 설명했습니다.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested reviewers: gimini-3

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch hotfix/comment-cleanup

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}