Initial commit

This commit is contained in:
Zhongwei Li
2025-11-29 18:09:26 +08:00
commit 71330f5583
76 changed files with 15081 additions and 0 deletions

View File

@@ -0,0 +1,195 @@
# Following Plans - Plan Compliance System
## Overview
A simple, explicit system to prevent agents from deviating from implementation plans without approval.
**Problem:** Agents sometimes rationalize "simpler" approaches that were already considered and rejected during design, leading to expensive rework when the divergence is discovered later.
**Solution:** Algorithmic decision tree + STATUS reporting + gate enforcement + user escalation.
## Components
### 1. following-plans Skill (Algorithmic)
**Location:** `plugin/skills/following-plans/SKILL.md`
**Purpose:** Embedded in agent prompts to define clear boundaries:
- What changes are allowed (syntax fixes)
- What requires BLOCKED report (approach/architecture changes)
**Decision tree format:** Boolean questions with no room for interpretation.
**Key principle:** Better to report BLOCKED unnecessarily than deviate without approval.
### 2. STATUS Reporting Protocol
**Required in every agent completion:**
```
STATUS: OK
TASK: {task identifier}
SUMMARY: {what was done}
```
Or:
```
STATUS: BLOCKED
REASON: {why plan approach won't work}
TASK: {task identifier}
```
### 3. Plan Compliance Gate
**Location:** `plugin/scripts/plan-compliance.sh`
**Runs on:** SubagentStop hook
**Checks:**
- STATUS missing → BLOCK (agent must provide status)
- STATUS: BLOCKED → BLOCK (dispatcher handles escalation)
- STATUS: OK → CONTINUE (chain to check/test gates)
### 4. Dispatcher Handling (executing-plans skill)
**Location:** `plugin/skills/executing-plans/SKILL.md`
**When agent reports BLOCKED:**
1. Read BLOCKED reason
2. Review plan/design context
3. Ask user via AskUserQuestion (4 options: approve, revise, enforce, investigate)
4. Execute user decision
**No automatic retries. No automatic approvals. User decides.**
## Setup
**No setup required!** The plan-compliance gate runs automatically on all SubagentStop events, just like the commands gate runs on all UserPromptSubmit events.
### Optional: Add Additional Gates
If you want to chain additional gates after plan-compliance (like check/test), edit your `.claude/gates.json`:
```json
{
"gates": {
"check": {
"description": "Run quality checks",
"command": "mise run check",
"on_pass": "test",
"on_fail": "BLOCK"
},
"test": {
"description": "Run tests",
"command": "mise run test",
"on_pass": "CONTINUE",
"on_fail": "BLOCK"
}
},
"hooks": {
"SubagentStop": {
"enabled_agents": ["general-purpose", "cipherpowers:rust-agent", "cipherpowers:code-agent"],
"gates": ["check"]
}
}
}
```
**Flow:** plan-compliance (built-in) → check → test
### Example Configuration
Gate configuration is in `${CLAUDE_PLUGIN_ROOT}hooks/gates.json`. See turboshovel documentation for hooks runtime setup.
## Usage
### During Plan Execution
The executing-plans skill automatically:
1. **Embeds following-plans skill** in agent prompts
2. **Checks agent STATUS** after completion
3. **Handles BLOCKED** by escalating to user
### Agent Behavior
Agents following the embedded skill will:
**For syntax fixes:** Make the change, note in completion
```
STATUS: OK
TASK: Task 3 - Implement auth
SUMMARY: Implemented auth. Fixed function name from plan (was getUserData, actually getUser).
```
**For approach changes:** Report BLOCKED
```
STATUS: BLOCKED
REASON: Plan specifies JWT but existing service uses OAuth2. JWT would require refactoring entire auth system.
TASK: Task 3 - Implement auth middleware
```
### User Decisions
When agent reports BLOCKED, you get clear options:
1. **Trust agent** - Approve deviation, update plan
2. **Revise plan** - Update with different approach
3. **Enforce plan** - Agent must follow plan as written
4. **Investigate** - Need more context
## Benefits
**Prevents silent deviations** - Agents can't rationalize around plan
**Early detection** - Blockers caught immediately, not discovered later
**Explicit approval** - User decides on all plan deviations
**Simple** - No automatic retries, no state tracking, no complexity
**Clear boundaries** - Algorithmic decision tree (no interpretation)
**Audit trail** - STATUS in agent output provides record
## Example Scenarios
### Scenario 1: Syntax Fix (Allowed)
**Plan:** "Call getUserData() to fetch user"
**Reality:** Function is actually `getUser()`
**Agent action:** Fix syntax, report STATUS: OK with note
**Result:** No BLOCKED, continues
### Scenario 2: Approach Change (Blocked)
**Plan:** "Implement manual JWT verification"
**Agent thought:** "Library X is simpler"
**Agent action:** Report STATUS: BLOCKED
**Result:** User decides: trust agent, revise plan, or enforce
### Scenario 3: Plan Error (Blocked)
**Plan:** Task 3 says PostgreSQL, Task 5 says MongoDB
**Agent action:** Report STATUS: BLOCKED (plan contradiction)
**Result:** User fixes plan, execution continues
## Testing
Test the gate manually:
```bash
# Test with STATUS: OK
echo '{"output": "STATUS: OK\nTask complete"}' | \
HOOK_INPUT='{"output": "STATUS: OK\nTask complete"}' \
${CLAUDE_PLUGIN_ROOT}scripts/plan-compliance.sh
# Test with STATUS: BLOCKED
echo '{"output": "STATUS: BLOCKED\nREASON: Plan approach won't work"}' | \
HOOK_INPUT='{"output": "STATUS: BLOCKED\nREASON: Plan approach won't work"}' \
${CLAUDE_PLUGIN_ROOT}scripts/plan-compliance.sh
# Test with missing STATUS
echo '{"output": "Task complete"}' | \
HOOK_INPUT='{"output": "Task complete"}' \
${CLAUDE_PLUGIN_ROOT}scripts/plan-compliance.sh
```
## Design Principles
**Simplicity over automation:** No automatic retries. User decides on deviations.
**Explicit over implicit:** STATUS required. BLOCKED is explicit escalation.
**Algorithmic over imperative:** Decision tree, not guidelines. No interpretation.
**User control:** Agent reports, gate enforces, user decides.

View File

@@ -0,0 +1,253 @@
---
name: following-plans
description: Algorithmic decision tree for when to follow plan exactly vs when to report BLOCKED - prevents scope creep and unauthorized deviations
when_to_use: embedded in agent prompts during plan execution, not called directly
version: 1.0.0
---
# Following Plans
## Overview
This skill is **embedded in agent prompts** during plan execution. It provides an algorithmic decision tree for determining when to follow the plan exactly vs when to report BLOCKED.
**Purpose:** Prevent agents from rationalizing "simpler approaches" that were already considered and rejected during design.
## When to Use
This skill is **embedded in agent prompts during plan execution**. It applies when:
- Agent executing implementation plan encounters situation requiring deviation
- Current approach in plan seems problematic or won't work
- Agent discovers syntax errors or naming issues in plan
- Agent wants to use "simpler approach" than plan specifies
- Tests fail with planned approach
- Plan contains contradictions or errors
**This skill prevents:**
- Unauthorized architectural changes during execution
- Scope creep from "better ideas" during implementation
- Rationalization of deviations without approval
- Silent changes that break plan assumptions
## Quick Reference
```
Is change syntax/naming only?
├─ YES → Fix it, note in completion, STATUS: OK
└─ NO → Does it change approach/architecture?
├─ YES → Report STATUS: BLOCKED with reason
└─ NO → Follow plan exactly, STATUS: OK
```
**Allowed without BLOCKED:**
- Syntax corrections (wrong function name in plan)
- Error handling implementation details
- Variable naming choices
- Code organization within file
- Test implementation details
**Requires BLOCKED:**
- Different algorithm or approach
- Different library/framework
- Different data structure/API design
- Skipping/adding planned functionality
- Refactoring not in plan
## Algorithmic Decision Tree
**Follow this exactly. No interpretation.**
### Step 1: Check if this is a syntax/naming fix
```
Is the change you want to make limited to:
- Correcting function/variable names
- Fixing syntax errors
- Updating import paths
- Correcting typos in code
YES → Make the change
Add note to task completion: "Fixed syntax: {what you fixed}"
Continue to Step 4
NO → Continue to Step 2
```
### Step 2: Check if this changes approach/architecture
```
Does your change alter:
- The overall approach or algorithm
- The architecture or structure
- Which libraries/frameworks to use
- The data model or API design
YES → STOP
Report STATUS: BLOCKED
Continue to Step 3
NO → Continue to Step 4
```
### Step 3: Report BLOCKED (Required Format)
```
STATUS: BLOCKED
REASON: [Explain why plan approach won't work and what you want to do instead]
TASK: [Task identifier from plan]
Example:
STATUS: BLOCKED
REASON: Plan specifies JWT auth but existing service uses OAuth2. Implementing JWT would require refactoring auth service.
TASK: Task 3 - Implement authentication middleware
```
**STOP HERE. Do not proceed with implementation.**
### Step 4: Follow plan exactly
```
Implement the task exactly as specified in plan.
Report STATUS: OK when complete.
```
## Status Reporting (REQUIRED)
**Every task completion MUST include STATUS.**
### STATUS: OK
Use when task completed as planned:
```
STATUS: OK
TASK: Task 3 - Implement authentication middleware
SUMMARY: Implemented JWT authentication middleware per plan specification.
```
### STATUS: BLOCKED
Use when plan approach won't work:
```
STATUS: BLOCKED
REASON: [Clear explanation]
TASK: [Task identifier]
```
**Missing STATUS = gate will block you from proceeding.**
## Red Flags (Rationalization Defense)
If you're thinking ANY of these thoughts, you're about to violate the plan:
| Thought | Reality |
|---------|---------|
| "This simpler approach would work better" | Simpler approach was likely considered and rejected in design. Report BLOCKED. |
| "The plan way seems harder than necessary" | Plan reflects design decisions you don't have context for. Follow plan or report BLOCKED. |
| "I can just use library X instead" | Library choice is architectural decision. Report BLOCKED. |
| "This is a minor architectural change" | All architecture changes require approval. Report BLOCKED. |
| "The tests would pass if I just..." | Making tests pass ≠ meeting requirements. Follow plan or report BLOCKED. |
| "I'll note the deviation in my summary" | Deviations require explicit approval BEFORE implementation. Report BLOCKED. |
**All of these mean: STOP. Report STATUS: BLOCKED.**
## What Counts as "Following Plan Exactly"
**Allowed without BLOCKED:**
- Syntax corrections (wrong function name in plan)
- Error handling implementation details (plan says "validate input", you choose validation approach)
- Variable naming (plan says "store user data", you choose variable name)
- Code organization within a file (where to place helper functions)
- Test implementation details (plan says "add tests", you write specific test cases)
**Requires BLOCKED:**
- Different algorithm or approach
- Different library/framework
- Different data structure
- Different API design
- Skipping planned functionality
- Adding unplanned functionality
- Refactoring not in plan
## Common Scenarios
### Scenario: Plan has wrong function name
```
Plan says: "Call getUserData()"
Reality: Function is actually getUser()
Decision: Fix syntax
Action: Use getUser(), note in completion
Status: OK
```
### Scenario: Plan approach seems unnecessarily complex
```
Plan says: "Implement manual JWT verification"
Your thought: "Library X does this better and simpler"
Decision: Architectural change
Action: Report BLOCKED
Status: BLOCKED
Reason: Plan specifies manual JWT verification but library X provides simpler approach. Should we use library instead?
```
### Scenario: Tests fail with planned approach
```
Plan says: "Use synchronous file reads"
Reality: Tests timeout with sync reads, async would fix
Decision: Approach change
Action: Report BLOCKED
Status: BLOCKED
Reason: Synchronous file reads cause test timeouts. Need async approach or different solution.
```
### Scenario: Plan contradicts itself
```
Plan Task 3: "Use PostgreSQL"
Plan Task 5: "Query MongoDB"
Decision: Plan error
Action: Report BLOCKED
Status: BLOCKED
Reason: Plan specifies both PostgreSQL (Task 3) and MongoDB (Task 5). Which should be used?
```
## Common Mistakes
**Mistake:** "This simpler approach would work better"
- **Why wrong:** Simpler approach was likely considered and rejected in design
- **Fix:** Report STATUS: BLOCKED, don't implement
**Mistake:** "This is a minor architectural change"
- **Why wrong:** All architecture changes require approval
- **Fix:** Report STATUS: BLOCKED for any approach/architecture change
**Mistake:** "I'll note the deviation in my summary"
- **Why wrong:** Deviations require explicit approval BEFORE implementation
- **Fix:** Report STATUS: BLOCKED before making changes
**Mistake:** "The tests would pass if I just use library X instead"
- **Why wrong:** Making tests pass ≠ meeting requirements, library choice is architectural
- **Fix:** Report STATUS: BLOCKED, explain issue
**Mistake:** "Forgot to include STATUS in my completion report"
- **Why wrong:** Missing STATUS = gate will block you from proceeding
- **Fix:** Always include STATUS: OK or STATUS: BLOCKED
## Remember
- **Syntax fixes**: Allowed (note in completion)
- **Approach changes**: Report BLOCKED
- **Architecture changes**: Report BLOCKED
- **Plan errors**: Report BLOCKED
- **Always provide STATUS**: OK or BLOCKED
- **When in doubt**: Report BLOCKED
**Better to report BLOCKED unnecessarily than to deviate from plan without approval.**