moai-adk 0.4.7__py3-none-any.whl → 0.4.10__py3-none-any.whl

moai_adk/templates/.claude/hooks/alfred/HOOK_SCHEMA_VALIDATION.md

@@ -0,0 +1,313 @@
+# Hook JSON 스키마 검증 및 해결 보고서
+
+**작성일**: 2025-10-23  
+**태그**: @CODE:HOOKS-REFACTOR-001  
+**상태**: ✅ 해결 완료
+
+---
+
+## 📋 문제 요약
+
+### 초기 오류
+```
+SessionStart:startup hook error: JSON validation failed: Hook JSON output validation failed
+Expected schema: { ... "systemMessage": ... }
+```
+
+### 근본 원인
+Claude Code Hook 스키마에서 `systemMessage`가 **최상위 필드**여야 하지만, 일부 구현에서는 이를 `hookSpecificOutput` 내부에 중첩시키고 있었습니다.
+
+---
+
+## 🔍 분석 결과
+
+### Claude Code 공식 Hook 스키마
+
+#### 1. 일반 Hook 이벤트 (SessionStart, PreToolUse, PostToolUse, SessionEnd 등)
+
+```json
+{
+  "continue": true|false,                  // ✅ 기본 필드
+  "systemMessage": "string",               // ✅ 최상위 필드 (NOT in hookSpecificOutput)
+  "decision": "approve"|"block"|undefined, // ✅ 선택적
+  "reason": "string",                      // ✅ 선택적
+  "permissionDecision": "allow"|"deny"|"ask"|undefined,  // ✅ 선택적
+  "suppressOutput": true|false             // ✅ 선택적
+}
+```
+
+#### 2. UserPromptSubmit 전용 스키마
+
+```json
+{
+  "continue": true,
+  "hookSpecificOutput": {                  // ✅ UserPromptSubmit에만 사용
+    "hookEventName": "UserPromptSubmit",
+    "additionalContext": "string"
+  }
+}
+```
+
+### 핵심 규칙
+
+| 규칙 | 설명 |
+|------|------|
+| **systemMessage 위치** | 최상위 필드 (`output["systemMessage"]`) |
+| **hookSpecificOutput** | UserPromptSubmit 전용 |
+| **내부 필드** | `context_files`, `suggestions`, `exit_code`는 Python 로직용 (JSON 출력 제외) |
+| **JSON 직렬화** | 모든 필드는 JSON 직렬화 가능해야 함 |
+
+---
+
+## ✅ 해결 방안
+
+### 1. 코드 수정
+
+**파일**: `.claude/hooks/alfred/core/__init__.py`
+
+#### `to_dict()` 메서드 (라인 63-118)
+```python
+def to_dict(self) -> dict[str, Any]:
+    """Claude Code 표준 Hook 출력 스키마로 변환"""
+    output: dict[str, Any] = {}
+
+    # 1. decision 또는 continue 추가
+    if self.decision:
+        output["decision"] = self.decision
+    else:
+        output["continue"] = self.continue_execution
+
+    # 2. reason 추가 (decision 또는 permissionDecision과 함께)
+    if self.reason:
+        output["reason"] = self.reason
+
+    # 3. suppressOutput 추가 (True인 경우만)
+    if self.suppress_output:
+        output["suppressOutput"] = True
+
+    # 4. permissionDecision 추가
+    if self.permission_decision:
+        output["permissionDecision"] = self.permission_decision
+
+    # 5. ⭐ systemMessage를 최상위 필드로 추가 (NOT in hookSpecificOutput)
+    if self.system_message:
+        output["systemMessage"] = self.system_message
+
+    # 🚫 내부 필드는 JSON 출력에서 제외
+    # - context_files: JIT 문맥 로드 (내부용)
+    # - suggestions: 제안 (내부용)
+    # - exit_code: 진단 (내부용)
+
+    return output
+```
+
+#### `to_user_prompt_submit_dict()` 메서드 (라인 120-160)
+```python
+def to_user_prompt_submit_dict(self) -> dict[str, Any]:
+    """UserPromptSubmit Hook 전용 스키마"""
+    if self.context_files:
+        context_str = "\n".join([f"📎 Context: {f}" for f in self.context_files])
+    else:
+        context_str = ""
+
+    if self.system_message:
+        if context_str:
+            context_str = f"{self.system_message}\n\n{context_str}"
+        else:
+            context_str = self.system_message
+
+    return {
+        "continue": self.continue_execution,
+        "hookSpecificOutput": {
+            "hookEventName": "UserPromptSubmit",
+            "additionalContext": context_str
+        }
+    }
+```
+
+### 2. 설정 검증
+
+**파일**: `.claude/settings.json` (라인 8-60)
+
+```json
+{
+  "hooks": {
+    "SessionStart": [
+      {
+        "hooks": [
+          {
+            "command": "uv run \"$CLAUDE_PROJECT_DIR\"/.claude/hooks/alfred/alfred_hooks.py SessionStart",
+            "type": "command"
+          }
+        ]
+      }
+    ],
+    "UserPromptSubmit": [
+      {
+        "hooks": [
+          {
+            "command": "uv run \"$CLAUDE_PROJECT_DIR\"/.claude/hooks/alfred/alfred_hooks.py UserPromptSubmit",
+            "type": "command"
+          }
+        ]
+      }
+    ]
+  }
+}
+```
+
+---
+
+## 🧪 검증 결과
+
+### 1. 자동 테스트 (8/8 통과)
+
+**파일**: `.claude/hooks/alfred/test_hook_output.py`
+
+```bash
+$ cd .claude/hooks/alfred && python test_hook_output.py
+
+✅ Test 1: Basic output - PASSED
+✅ Test 2: systemMessage (top-level) - PASSED
+✅ Test 3: decision + reason - PASSED
+✅ Test 4: UserPromptSubmit schema - PASSED
+✅ Test 5: permissionDecision - PASSED
+✅ Test 6: SessionStart typical output - PASSED
+✅ Test 7: JSON serializable - PASSED
+✅ Test 8: UserPromptSubmit with system_message - PASSED
+
+✅ ALL 8 TESTS PASSED
+```
+
+### 2. 실제 Hook 실행 검증
+
+#### SessionStart (compact phase)
+```bash
+$ echo '{"cwd": ".", "phase": "compact"}' | uv run .claude/hooks/alfred/alfred_hooks.py SessionStart
+
+{
+  "continue": true,
+  "systemMessage": "🚀 MoAI-ADK Session Started\n   Language: python\n   Branch: develop (d905363)\n   Changes: 215\n   SPEC Progress: 30/31 (96%)\n   Checkpoints: 2 available\n      - delete-20251022-134841\n      - critical-file-20251019-230247\n   Restore: /alfred:0-project restore"
+}
+```
+
+✅ **검증**: 
+- `systemMessage`가 최상위 필드
+- JSON 유효성 확인
+- `hookSpecificOutput` 없음 (올바름)
+
+#### SessionStart (clear phase)
+```bash
+$ echo '{"cwd": ".", "phase": "clear"}' | uv run .claude/hooks/alfred/alfred_hooks.py SessionStart
+
+{"continue": true}
+```
+
+✅ **검증**: 
+- 최소 스키마 (continue만)
+- clear 단계에서 중복 출력 방지
+
+#### UserPromptSubmit
+```bash
+$ echo '{"cwd": ".", "userPrompt": "test"}' | uv run .claude/hooks/alfred/alfred_hooks.py UserPromptSubmit
+
+{
+  "continue": true,
+  "hookSpecificOutput": {
+    "hookEventName": "UserPromptSubmit",
+    "additionalContext": "📎 Loaded 1 context file(s)\n\n📎 Context: tests/"
+  }
+}
+```
+
+✅ **검증**: 
+- UserPromptSubmit 특수 스키마
+- `hookSpecificOutput` 사용 (올바름)
+
+---
+
+## 📚 각 Hook 이벤트별 스키마 가이드
+
+| 이벤트 | 최소 JSON | 예시 | 차단 가능 |
+|--------|-----------|------|----------|
+| **SessionStart** | `{"continue": true}` | 프로젝트 상태 표시 | ❌ No |
+| **SessionEnd** | `{"continue": true}` | 정리 작업 | ❌ No |
+| **PreToolUse** | `{"continue": true}` | 도구 실행 승인/차단 | ✅ Yes |
+| **PostToolUse** | `{"continue": true}` | 도구 실행 후 피드백 | ❌ No* |
+| **UserPromptSubmit** | 특수 스키마 | 프롬프트 문맥 추가 | ✅ Yes |
+| **Notification** | `{"continue": true}` | 알림 처리 | ❌ No |
+| **Stop** | `{"continue": true}` | 종료 차단 | ✅ Yes |
+| **SubagentStop** | `{"continue": true}` | 서브에이전트 종료 차단 | ✅ Yes |
+
+*: PostToolUse는 도구가 이미 실행되었으므로 차단 불가능하지만, 피드백 제공 가능
+
+---
+
+## 🔧 구현 세부사항
+
+### HookResult 클래스 필드
+
+```python
+@dataclass
+class HookResult:
+    # ✅ Claude Code 표준 필드 (JSON에 포함)
+    continue_execution: bool = True
+    suppress_output: bool = False
+    decision: Literal["approve", "block"] | None = None
+    reason: str | None = None
+    permission_decision: Literal["allow", "deny", "ask"] | None = None
+    system_message: str | None = None  # ⭐ TOP-LEVEL in JSON
+    
+    # 🚫 내부 필드 (JSON 출력 제외)
+    context_files: list[str] = field(default_factory=list)
+    suggestions: list[str] = field(default_factory=list)
+    exit_code: int = 0
+```
+
+### 메서드별 역할
+
+| 메서드 | 사용 사건 | 반환 스키마 |
+|--------|---------|----------|
+| `to_dict()` | 일반 Hook 이벤트 | 표준 Claude Code 스키마 |
+| `to_user_prompt_submit_dict()` | UserPromptSubmit 이벤트 | 특수 스키마 + hookSpecificOutput |
+
+---
+
+## 📖 참고 문서
+
+### 공식 Claude Code 문서
+- **Claude Code Hooks**: https://docs.claude.com/en/docs/claude-code/hooks
+- **Hook Output Schema**: https://docs.claude.com/en/docs/claude-code/hooks#output-schema
+
+### Context7 참고 자료
+- **Claude Code Hooks Mastery** (Trust Score: 8.3, 100+ 코드 스니펫)
+- **Claude Code Templates** (Trust Score: 10)
+
+### 프로젝트 문서
+- **CLAUDE.md**: `Error Message Standard (Shared)` 섹션
+- **Hook 구현**: `.claude/hooks/alfred/handlers/` 디렉토리
+
+---
+
+## 🎯 결론
+
+✅ **상태**: 해결 완료  
+✅ **검증**: 8/8 자동 테스트 통과  
+✅ **실제 실행**: 모든 Hook 이벤트 정상 작동  
+
+### 핵심 수정사항
+1. `systemMessage`를 최상위 필드로 이동 (NOT in hookSpecificOutput)
+2. UserPromptSubmit 특수 스키마 분리
+3. 내부 필드 JSON 출력 제외
+4. 모든 Hook 이벤트 스키마 정규화
+
+### 다음 단계
+- ✅ Hook 스키마 검증 자동화
+- ✅ 테스트 스크립트 작성
+- ⏭️ 현재 상태 유지 및 모니터링
+
+---
+
+**검증 완료**: 2025-10-23  
+**담당자**: @agent-cc-manager  
+**참고**: @CODE:HOOKS-REFACTOR-001

moai_adk/templates/.claude/hooks/alfred/alfred_hooks.py

@@ -136,7 +136,8 @@ def main() -> None:
         handler = handlers.get(event_name)
         result = handler({"cwd": cwd, **data}) if handler else HookResult()
 
-        # UserPromptSubmit uses a special output schema
+        # Output Hook result as JSON
+        # Note: UserPromptSubmit uses to_user_prompt_submit_dict() for special schema
         if event_name == "UserPromptSubmit":
             print(json.dumps(result.to_user_prompt_submit_dict()))
         else:
@@ -145,9 +146,21 @@ def main() -> None:
         sys.exit(0)
 
     except json.JSONDecodeError as e:
+        # Return valid Hook response even on JSON parse error
+        error_response: dict[str, Any] = {
+            "continue": True,
+            "hookSpecificOutput": {"error": f"JSON parse error: {e}"}
+        }
+        print(json.dumps(error_response))
         print(f"JSON parse error: {e}", file=sys.stderr)
         sys.exit(1)
     except Exception as e:
+        # Return valid Hook response even on unexpected error
+        error_response: dict[str, Any] = {
+            "continue": True,
+            "hookSpecificOutput": {"error": f"Hook error: {e}"}
+        }
+        print(json.dumps(error_response))
         print(f"Unexpected error: {e}", file=sys.stderr)
         sys.exit(1)
 

moai_adk/templates/.claude/hooks/alfred/core/__init__.py

@@ -4,8 +4,8 @@
 Common type definitions and utility functions
 """
 
-from dataclasses import asdict, dataclass, field
-from typing import Any, NotRequired, TypedDict
+from dataclasses import dataclass, field
+from typing import Any, Literal, NotRequired, TypedDict
 
 
 class HookPayload(TypedDict):
@@ -16,63 +16,147 @@ class HookPayload(TypedDict):
     """
 
     cwd: str
-    userPrompt: NotRequired[str] # Includes only UserPromptSubmit events
+    userPrompt: NotRequired[str]  # Includes only UserPromptSubmit events
     tool: NotRequired[str]  # PreToolUse/PostToolUse events
     arguments: NotRequired[dict[str, Any]]  # Tool arguments
 
 
 @dataclass
 class HookResult:
-    """Hook execution result"""
+    """Hook execution result following Claude Code standard schema.
+
+    Attributes conform to Claude Code Hook output specification:
+    https://docs.claude.com/en/docs/claude-code/hooks
+
+    Standard Fields (Claude Code schema - included in JSON output):
+        continue_execution: Allow execution to continue (default True)
+        suppress_output: Suppress hook output display (default False)
+        decision: "approve" or "block" operation (optional)
+        reason: Explanation for decision (optional)
+        permission_decision: "allow", "deny", or "ask" (optional)
+        system_message: Message displayed to user (top-level field)
+
+    Internal Fields (MoAI-ADK only - NOT in JSON output):
+        context_files: List of context files to load (internal use only)
+        suggestions: Suggestions for user (internal use only)
+        exit_code: Exit code for diagnostics (internal use only)
+
+    Note:
+        - systemMessage appears at TOP LEVEL in JSON output
+        - hookSpecificOutput is ONLY used for UserPromptSubmit events
+        - Internal fields are used for Python logic but not serialized to JSON
+    """
+
+    # Claude Code standard fields
+    continue_execution: bool = True
+    suppress_output: bool = False
+    decision: Literal["approve", "block"] | None = None
+    reason: str | None = None
+    permission_decision: Literal["allow", "deny", "ask"] | None = None
 
-    message: str | None = None
-    systemMessage: str | None = None  # Message displayed directly to the user  # noqa: N815
-    blocked: bool = False
-    contextFiles: list[str] = field(default_factory=list)  # noqa: N815
+    # MoAI-ADK custom fields (wrapped in hookSpecificOutput)
+    system_message: str | None = None
+    context_files: list[str] = field(default_factory=list)
     suggestions: list[str] = field(default_factory=list)
-    exitCode: int = 0  # noqa: N815
+    exit_code: int = 0
 
     def to_dict(self) -> dict[str, Any]:
-        """Dictionary conversion for general Hook"""
-        return asdict(self)
+        """Convert to Claude Code standard Hook output schema.
+
+        Returns:
+            Dictionary conforming to Claude Code Hook specification with:
+            - Top-level fields: continue, suppressOutput, decision, reason,
+              permissionDecision, systemMessage
+            - MoAI-ADK internal fields (context_files, suggestions, exit_code)
+              are NOT included in JSON output (used for internal logic only)
+
+        Examples:
+            >>> result = HookResult(continue_execution=True)
+            >>> result.to_dict()
+            {'continue': True}
+
+            >>> result = HookResult(decision="block", reason="Dangerous")
+            >>> result.to_dict()
+            {'decision': 'block', 'reason': 'Dangerous'}
+
+            >>> result = HookResult(system_message="Test")
+            >>> result.to_dict()
+            {'continue': True, 'systemMessage': 'Test'}
+
+        Note:
+            - systemMessage is a TOP-LEVEL field (not nested in hookSpecificOutput)
+            - hookSpecificOutput is ONLY used for UserPromptSubmit events
+            - context_files, suggestions, exit_code are internal-only fields
+        """
+        output: dict[str, Any] = {}
+
+        # Add decision or continue flag
+        if self.decision:
+            output["decision"] = self.decision
+        else:
+            output["continue"] = self.continue_execution
+
+        # Add reason if provided (works with both decision and permissionDecision)
+        if self.reason:
+            output["reason"] = self.reason
+
+        # Add suppressOutput if True
+        if self.suppress_output:
+            output["suppressOutput"] = True
+
+        # Add permissionDecision if set
+        if self.permission_decision:
+            output["permissionDecision"] = self.permission_decision
+
+        # Add systemMessage at TOP LEVEL (required by Claude Code schema)
+        if self.system_message:
+            output["systemMessage"] = self.system_message
+
+        # Note: context_files, suggestions, exit_code are internal-only fields
+        # and are NOT included in the JSON output per Claude Code schema
+
+        return output
 
     def to_user_prompt_submit_dict(self) -> dict[str, Any]:
-        """UserPromptSubmit Hook-specific output format
+        """UserPromptSubmit Hook-specific output format.
 
-        Claude Code requires a special schema for UserPromptSubmit:
-        {
-            "hookEventName": "UserPromptSubmit",
-            "additionalContext": "string (required)"
-        }
+        Claude Code requires a special schema for UserPromptSubmit events.
+        The result is wrapped in the standard Hook schema with hookSpecificOutput.
 
         Returns:
-            Claude Code UserPromptSubmit Hook Dictionary matching schema
+            Claude Code UserPromptSubmit Hook Dictionary matching schema:
+            {
+                "continue": true,
+                "hookSpecificOutput": {
+                    "hookEventName": "UserPromptSubmit",
+                    "additionalContext": "string"
+                }
+            }
 
         Examples:
-            >>> result = HookResult(contextFiles=["tests/"])
+            >>> result = HookResult(context_files=["tests/"])
             >>> result.to_user_prompt_submit_dict()
-            {'hookEventName': 'UserPromptSubmit', 'additionalContext': '📎 Context: tests/'}
+            {'continue': True, 'hookSpecificOutput': {'hookEventName': 'UserPromptSubmit', 'additionalContext': '📎 Context: tests/'}}
         """
-        # Convert contextFiles to additionalContext string
-        if self.contextFiles:
-            context_str = "\n".join([f"📎 Context: {f}" for f in self.contextFiles])
+        # Convert context_files to additionalContext string
+        if self.context_files:
+            context_str = "\n".join([f"📎 Context: {f}" for f in self.context_files])
         else:
             context_str = ""
 
-        # Add message if there is one
-        if self.message:
+        # Add system_message if there is one
+        if self.system_message:
             if context_str:
-                context_str = f"{self.message}\n\n{context_str}"
+                context_str = f"{self.system_message}\n\n{context_str}"
             else:
-                context_str = self.message
-
-        # If the string is empty, use default
-        if not context_str:
-            context_str = ""
+                context_str = self.system_message
 
         return {
-            "hookEventName": "UserPromptSubmit",
-            "additionalContext": context_str
+            "continue": self.continue_execution,
+            "hookSpecificOutput": {
+                "hookEventName": "UserPromptSubmit",
+                "additionalContext": context_str
+            }
         }
 
 

moai_adk/templates/.claude/hooks/alfred/handlers/session.py

@@ -19,7 +19,7 @@ def handle_session_start(payload: HookPayload) -> HookResult:
         payload: Claude Code event payload (cwd key required)
 
     Returns:
-        HookResult(message=project status summary message, systemMessage=for user display)
+        HookResult(system_message=project status summary message)
 
     Message Format:
         🚀 MoAI-ADK Session Started
@@ -31,14 +31,15 @@ def handle_session_start(payload: HookPayload) -> HookResult:
 
     Note:
         - Claude Code processes SessionStart in several stages (clear → compact)
-        - Display message only at “compact” stage to prevent duplicate output
-        - "clear" step returns empty result (invisible to user)
+        - Display message only at "compact" stage to prevent duplicate output
+        - "clear" step returns minimal result (empty hookSpecificOutput)
 
     TDD History:
         - RED: Session startup message format test
         - GREEN: Generate status message by combining helper functions
         - REFACTOR: Improved message format, improved readability, added checkpoint list
         - FIX: Prevent duplicate output of clear step (only compact step is displayed)
+        - UPDATE: Migrated to Claude Code standard Hook schema
 
     @TAG:CHECKPOINT-EVENT-001
     """
@@ -46,7 +47,8 @@ def handle_session_start(payload: HookPayload) -> HookResult:
     # Ignore the "clear" stage and output messages only at the "compact" stage
     event_phase = payload.get("phase", "")
     if event_phase == "clear":
-        return HookResult() # returns an empty result (prevents duplicate output)
+        # Return minimal valid Hook result for clear phase
+        return HookResult(continue_execution=True)
 
     cwd = payload.get("cwd", ".")
     language = detect_language(cwd)
@@ -59,7 +61,7 @@ def handle_session_start(payload: HookPayload) -> HookResult:
     changes = git_info.get("changes", 0)
     spec_progress = f"{specs['completed']}/{specs['total']}"
 
-    # systemMessage: displayed directly to the user
+    # system_message: displayed directly to the user
     lines = [
         "🚀 MoAI-ADK Session Started",
         f"   Language: {language}",
@@ -78,10 +80,7 @@ def handle_session_start(payload: HookPayload) -> HookResult:
 
     system_message = "\n".join(lines)
 
-    return HookResult(
-        message=system_message, # for Claude context
-        systemMessage=system_message, # For user display
-    )
+    return HookResult(system_message=system_message)
 
 
 def handle_session_end(payload: HookPayload) -> HookResult:

moai_adk/templates/.claude/hooks/alfred/handlers/tool.py

@@ -20,8 +20,8 @@ def handle_pre_tool_use(payload: HookPayload) -> HookResult:
 
     Returns:
         HookResult(
-            message=checkpoint creation notification (when danger is detected);
-            blocked=False (always continue operation)
+            system_message=checkpoint creation notification (when danger is detected);
+            continue_execution=True (always continue operation)
         )
 
     Checkpoint Triggers:
@@ -34,7 +34,7 @@ def handle_pre_tool_use(payload: HookPayload) -> HookResult:
         → "🛡️ Checkpoint created: before-delete-20251015-143000"
 
     Notes:
-        - Return blocked=False even after detection of danger (continue operation)
+        - Return continue_execution=True even after detection of danger (continue operation)
         - Work continues even when checkpoint fails (ignores)
         - Transparent background operation
 
@@ -52,14 +52,14 @@ def handle_pre_tool_use(payload: HookPayload) -> HookResult:
         checkpoint_branch = create_checkpoint(cwd, operation_type)
 
         if checkpoint_branch != "checkpoint-failed":
-            message = (
+            system_message = (
                 f"🛡️ Checkpoint created: {checkpoint_branch}\n"
                 f"   Operation: {operation_type}"
             )
 
-            return HookResult(message=message, blocked=False)
+            return HookResult(system_message=system_message, continue_execution=True)
 
-    return HookResult(blocked=False)
+    return HookResult(continue_execution=True)
 
 
 def handle_post_tool_use(payload: HookPayload) -> HookResult:

moai_adk/templates/.claude/hooks/alfred/handlers/user.py

@@ -20,22 +20,23 @@ def handle_user_prompt_submit(payload: HookPayload) -> HookResult:
 
     Returns:
         HookResult(
-            message=Number of Files loaded (or None),
-            contextFiles=Recommended document path list
+            system_message=Number of Files loaded (or None),
+            context_files=Recommended document path list
         )
 
     TDD History:
         - RED: JIT document loading scenario testing
         - GREEN: Recommend documents by calling get_jit_context()
         - REFACTOR: Message conditional display (only when there is a file)
+        - UPDATE: Migrated to Claude Code standard Hook schema with snake_case fields
     """
     user_prompt = payload.get("userPrompt", "")
     cwd = payload.get("cwd", ".")
     context_files = get_jit_context(user_prompt, cwd)
 
-    message = f"📎 Loaded {len(context_files)} context file(s)" if context_files else None
+    system_message = f"📎 Loaded {len(context_files)} context file(s)" if context_files else None
 
-    return HookResult(message=message, contextFiles=context_files)
+    return HookResult(system_message=system_message, context_files=context_files)
 
 
 __all__ = ["handle_user_prompt_submit"]