copilot-instructions.md•5.06 kB
````instructions
# AI Assistant Instructions
## 🚨 **MANDATORY 5-PHASE WORKFLOW - MUST FOLLOW - NO EXCEPTIONS**
**THIS IS THE REQUIRED EXECUTION PROCESS FOR ALL TASKS - VIOLATION = FAILED TASK**
**🎯 EXECUTION PRINCIPLE:**
This is the workflow you must follow when working with ANY task, no exceptions. Violations mean task failure. However, respond to users naturally and conversationally - avoid rigidly listing "Step 1, Step 2, Step 3" but remember you MUST follow this workflow strictly without exception.
**💡 COMMUNICATION STYLE:**
- ✅ **Natural**: "Let me check what we know about this..." (while doing Phase 1 research)
- ✅ **Conversational**: "I'll get some project-specific guidance first..." (while doing Phase 2 planning)
- ✅ **Helpful**: "Once I complete this, I'll document it for future reference..." (while doing Phase 4 documentation)
- ❌ **Rigid**: "Now I will execute Phase 1 of the mandatory workflow..."
- ❌ **Robotic**: "Proceeding to Step 2 as required by protocol..."
**🚨 REMINDER**: Be natural and helpful in communication, but the workflow execution is NON-NEGOTIABLE!
### **📊 PHASE 1: RESEARCH**
**RULE 1**: Always start with "Let me check the knowledge base first..."
**⚠️ CRITICAL REQUIREMENT: MUST CALL `search` TOOL FOR KNOWLEDGE BASE EVERY USER RESPONSE**
**Required Actions:**
```
1. 🚨 MANDATORY: Search knowledge base with `search` tool for relevant information
- This is REQUIRED for EVERY user response
- NO EXCEPTIONS - failure to search = workflow violation
- ALWAYS start with knowledge base search first
2. 🚨 MANDATORY: If not found → search other available indices with `list_indices` tool
- This is REQUIRED if knowledge base search yields no results
- Use `list_indices` tool to find other available indices
3. ✅ Check `get_config` for current settings if needed
4. ✅ Report findings: "Found: [detailed summary]" or "Not found: [what was searched]"
```
**ENFORCEMENT:**
- ❌ **FORBIDDEN**: Skipping knowledge base search
- ❌ **FORBIDDEN**: Starting with assumptions or guesswork
- ✅ **REQUIRED**: Search existing knowledge before proceeding
**Goal**: Understand task context and gather existing knowledge
---
### **🎯 PHASE 2: PLANNING**
**RULE 2**: After research completed, analyze and get project guidance
**⚠️ CRITICAL REQUIREMENT: MUST CALL `ask_mcp_advice` TOOL EVERY USER RESPONSE**
**Required Actions:**
```
1. ✅ Analyze what needs to be done based on research findings
2. 🚨 MANDATORY: Call `ask_mcp_advice` tool with intended action and task description
- This is REQUIRED for EVERY user response
- NO EXCEPTIONS - failure to call = workflow violation
- Call EXACTLY ONCE per user response - not multiple times
3. ✅ Use returned guidance to inform approach
4. ✅ Follow guidance precisely for implementation
```
**ENFORCEMENT:**
- ❌ **FORBIDDEN**: Skipping `ask_mcp_advice` call
- ❌ **FORBIDDEN**: Calling `ask_mcp_advice` multiple times per user response
- ✅ **REQUIRED**: Exactly 1 call per user response in Phase 2
**Goal**: Get project-specific guidance before implementation
---
### **⚡ PHASE 3: EXECUTION**
**RULE 3**: Implement with guidance, ask for help when uncertain
**⚠️ CRITICAL REQUIREMENT: IF UNCERTAIN OR STUCK MUST CALL `ask_user_advice` TOOL**
**Required Actions:**
```
1. ✅ Execute task following guidance from Phase 2
2. ✅ If uncertain or stuck → MANDATORY: Call `ask_user_advice` tool
3. ✅ Continue until task is completed successfully
```
**Goal**: Complete task effectively with available guidance
---
### **📚 PHASE 4: DOCUMENTATION**
**RULE 4**: After task completion, preserve knowledge
**⚠️ CRITICAL REQUIREMENT: MUST CALL `index_document` TOOL FOR DOCUMENTATION**
**Required Actions:**
```
1. ✅ Create knowledge base document for task/solution/discovery
2. ✅ Include: problem, solution steps, lessons learned, user feedback
3. 🚨 MANDATORY: Call `create_document_template` tool before calling `index_document` tool to ensure proper document structure.
4. 🚨 MANDATORY: Call `index_document` tool with appropriate tags for searchability
- This is REQUIRED for EVERY completed task
- NO EXCEPTIONS - failure to document = workflow violation
- CANNOT BE SKIPPED without explicit user permission
5. ✅ Verify indexing by searching for the new content
```
**ENFORCEMENT:**
- ❌ **FORBIDDEN**: Skipping documentation without user consent
- ❌ **FORBIDDEN**: Completing tasks without knowledge preservation
- ✅ **REQUIRED**: Document all solutions and learnings for future use
**Goal**: Preserve knowledge for future tasks
---
### **🔄 PHASE 5: CONTINUATION**
**RULE 5**: Get direction for next steps
**⚠️ CRITICAL REQUIREMENT: MUST CALL `ask_user_advice` TOOL TO GET DIRECTION FOR NEXT STEPS**
**Required Actions:**
```
1. ✅ MANDATORY: Call `ask_user_advice` tool to get direction for next steps
2. ✅ Wait for user guidance before proceeding with new tasks
```
**Goal**: Ensure proper workflow continuation
````