grimoire-framework 1.0.0

package/.grimoire/data/grimoire-kb.md

@@ -0,0 +1,918 @@
+# grimoire Knowledge Base
+
+## Overview
+
+grimoire-Method is a framework that combines AI agents with Agile development methodologies. The v4 system introduces a modular architecture with improved dependency management, bundle optimization, and support for both web and IDE environments.
+
+### Key Features
+
+- **Modular Agent System**: Specialized AI agents for each Agile role
+- **Build System**: Automated dependency resolution and optimization
+- **Dual Environment Support**: Optimized for both web UIs and IDEs
+- **Reusable Resources**: Portable templates, tasks, and checklists
+- **Slash Command Integration**: Quick agent switching and control
+
+### When to Use grimoire
+
+- **New Projects (Greenfield)**: Complete end-to-end development
+- **Existing Projects (Brownfield)**: Feature additions and enhancements
+- **Team Collaboration**: Multiple roles working together
+- **Quality Assurance**: Structured testing and validation
+- **Documentation**: Professional PRDs, architecture docs, user stories
+
+## How grimoire Works
+
+### The Core Method
+
+grimoire transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
+
+1. **You Direct, AI Executes**: You provide vision and decisions; agents handle implementation details
+2. **Specialized Agents**: Each agent masters one role (PM, Developer, Architect, etc.)
+3. **Structured Workflows**: Proven patterns guide you from idea to deployed code
+4. **Clean Handoffs**: Fresh context windows ensure agents stay focused and effective
+
+### The Two-Phase Approach
+
+#### Phase 1: Planning (Web UI - Cost Effective)
+
+- Use large context windows (Gemini's 1M tokens)
+- Generate comprehensive documents (PRD, Architecture)
+- Leverage multiple agents for brainstorming
+- Create once, use throughout development
+
+#### Phase 2: Development (IDE - Implementation)
+
+- Shard documents into manageable pieces
+- Execute focused SM → Dev cycles
+- One story at a time, sequential progress
+- Real-time file operations and testing
+
+### The Development Loop
+
+```text
+1. SM Agent (New Chat) → Creates next story from sharded docs
+2. You → Review and approve story
+3. Dev Agent (New Chat) → Implements approved story
+4. QA Agent (New Chat) → Reviews and refactors code
+5. You → Verify completion
+6. Repeat until epic complete
+```
+
+### Why This Works
+
+- **Context Optimization**: Clean chats = better AI performance
+- **Role Clarity**: Agents don't context-switch = higher quality
+- **Incremental Progress**: Small stories = manageable complexity
+- **Human Oversight**: You validate each step = quality control
+- **Document-Driven**: Specs guide everything = consistency
+
+## Getting Started
+
+### Quick Start Options
+
+#### Option 1: Web UI
+
+**Best for**: ChatGPT, Claude, Gemini users who want to start immediately
+
+1. Navigate to `dist/teams/`
+2. Copy `team-fullstack.txt` content
+3. Create new Gemini Gem or CustomGPT
+4. Upload file with instructions: "Your critical operating instructions are attached, do not break character as directed"
+5. Type `/help` to see available commands
+
+#### Option 2: IDE Integration
+
+**Best for**: Cursor, Claude Code, Gemini CLI, Github Copilot users
+
+```bash
+# Interactive installation (recommended)
+npx @grimoire/grimoire install
+```
+
+**Installation Steps**:
+
+- Choose "Complete installation"
+- Select your IDE from supported options:
+  - **Cursor**: Native AI integration
+  - **Claude Code**: Anthropic's official IDE
+  - **GitHub Copilot**: VS Code extension with AI peer programming assistant
+
+**Note for VS Code Users**: grimoire-Method assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot. Standard VS Code without AI capabilities cannot run grimoire agents.
+
+**Verify Installation**:
+
+- `.grimoire/` folder created with all agents
+- IDE-specific integration files created
+- All agent commands/rules/modes available
+
+**Remember**: At its core, grimoire-Method is about mastering and harnessing prompt engineering. Any IDE with AI agent support can use grimoire - the framework provides the structured prompts and workflows that make AI development effective
+
+### Environment Selection Guide
+
+**Use Web UI for**:
+
+- Initial planning and documentation (PRD, architecture)
+- Cost-effective document creation (especially with Gemini)
+- Brainstorming and analysis phases
+- Multi-agent consultation and planning
+
+**Use IDE for**:
+
+- Active development and coding
+- File operations and project integration
+- Document sharding and story management
+- Implementation workflow (SM/Dev cycles)
+
+**Cost-Saving Tip**: Create large documents (PRDs, architecture) in web UI, then copy to `docs/prd.md` and `docs/architecture.md` in your project before switching to IDE for development.
+
+### IDE-Only Workflow Considerations
+
+**Can you do everything in IDE?** Yes, but understand the tradeoffs:
+
+**Pros of IDE-Only**:
+
+- Single environment workflow
+- Direct file operations from start
+- No copy/paste between environments
+- Immediate project integration
+
+**Cons of IDE-Only**:
+
+- Higher token costs for large document creation
+- Smaller context windows (varies by IDE/model)
+- May hit limits during planning phases
+- Less cost-effective for brainstorming
+
+**Using Web Agents in IDE**:
+
+- **NOT RECOMMENDED**: Web agents (PM, Architect) have rich dependencies designed for large contexts
+- **Why it matters**: Dev agents are kept lean to maximize coding context
+- **The principle**: "Dev agents code, planning agents plan" - mixing breaks this optimization
+
+**About grimoire-master and grimoire-orchestrator**:
+
+- **grimoire-master**: CAN do any task without switching agents, BUT...
+- **Still use specialized agents for planning**: PM, Architect, and UX Expert have tuned personas that produce better results
+- **Why specialization matters**: Each agent's personality and focus creates higher quality outputs
+- **If using grimoire-master/orchestrator**: Fine for planning phases, but...
+
+**CRITICAL RULE for Development**:
+
+- **ALWAYS use SM agent for story creation** - Never use grimoire-master or grimoire-orchestrator
+- **ALWAYS use Dev agent for implementation** - Never use grimoire-master or grimoire-orchestrator
+- **Why this matters**: SM and Dev agents are specifically optimized for the development workflow
+- **No exceptions**: Even if using grimoire-master for everything else, switch to SM → Dev for implementation
+
+**Best Practice for IDE-Only**:
+
+1. Use PM/Architect/UX agents for planning (better than grimoire-master)
+2. Create documents directly in project
+3. Shard immediately after creation
+4. **MUST switch to SM agent** for story creation
+5. **MUST switch to Dev agent** for implementation
+6. Keep planning and coding in separate chat sessions
+
+## Core Configuration (core-config.yaml)
+
+**New in V4**: The `grimoire/core-config.yaml` file is a critical innovation that enables grimoire to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
+
+### What is core-config.yaml?
+
+This configuration file acts as a map for grimoire agents, telling them exactly where to find your project documents and how they're structured. It enables:
+
+- **Version Flexibility**: Work with V3, V4, or custom document structures
+- **Custom Locations**: Define where your documents and shards live
+- **Developer Context**: Specify which files the dev agent should always load
+- **Debug Support**: Built-in logging for troubleshooting
+
+### Key Configuration Areas
+
+#### PRD Configuration
+
+- **prdVersion**: Tells agents if PRD follows v3 or v4 conventions
+- **prdSharded**: Whether epics are embedded (false) or in separate files (true)
+- **prdShardedLocation**: Where to find sharded epic files
+- **epicFilePattern**: Pattern for epic filenames (e.g., `epic-{n}*.md`)
+
+#### Architecture Configuration
+
+- **architectureVersion**: v3 (monolithic) or v4 (sharded)
+- **architectureSharded**: Whether architecture is split into components
+- **architectureShardedLocation**: Where sharded architecture files live
+
+#### Developer Files
+
+- **devLoadAlwaysFiles**: List of files the dev agent loads for every task
+- **devDebugLog**: Where dev agent logs repeated failures
+- **agentCoreDump**: Export location for chat conversations
+
+### Why It Matters
+
+1. **No Forced Migrations**: Keep your existing document structure
+2. **Gradual Adoption**: Start with V3 and migrate to V4 at your pace
+3. **Custom Workflows**: Configure grimoire to match your team's process
+4. **Intelligent Agents**: Agents automatically adapt to your configuration
+
+### Common Configurations
+
+**Legacy V3 Project**:
+
+```yaml
+prdVersion: v3
+prdSharded: false
+architectureVersion: v3
+architectureSharded: false
+```
+
+**V4 Optimized Project**:
+
+```yaml
+prdVersion: v4
+prdSharded: true
+prdShardedLocation: docs/prd
+architectureVersion: v4
+architectureSharded: true
+architectureShardedLocation: docs/architecture
+```
+
+## Core Philosophy
+
+### Vibe CEO'ing
+
+You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a singular vision. Your AI agents are your high-powered team, and your role is to:
+
+- **Direct**: Provide clear instructions and objectives
+- **Refine**: Iterate on outputs to achieve quality
+- **Oversee**: Maintain strategic alignment across all agents
+
+### Core Principles
+
+1. **MAXIMIZE_AI_LEVERAGE**: Push the AI to deliver more. Challenge outputs and iterate.
+2. **QUALITY_CONTROL**: You are the ultimate arbiter of quality. Review all outputs.
+3. **STRATEGIC_OVERSIGHT**: Maintain the high-level vision and ensure alignment.
+4. **ITERATIVE_REFINEMENT**: Expect to revisit steps. This is not a linear process.
+5. **CLEAR_INSTRUCTIONS**: Precise requests lead to better outputs.
+6. **DOCUMENTATION_IS_KEY**: Good inputs (briefs, PRDs) lead to good outputs.
+7. **START_SMALL_SCALE_FAST**: Test concepts, then expand.
+8. **EMBRACE_THE_CHAOS**: Adapt and overcome challenges.
+
+### Key Workflow Principles
+
+1. **Agent Specialization**: Each agent has specific expertise and responsibilities
+2. **Clean Handoffs**: Always start fresh when switching between agents
+3. **Status Tracking**: Maintain story statuses (Draft → Approved → InProgress → Done)
+4. **Iterative Development**: Complete one story before starting the next
+5. **Documentation First**: Always start with solid PRD and architecture
+
+## Agent System
+
+### Core Development Team
+
+| Agent       | Role               | Primary Functions                       | When to Use                            |
+| ----------- | ------------------ | --------------------------------------- | -------------------------------------- |
+| `analyst`   | Business Analyst   | Market research, requirements gathering | Project planning, competitive analysis |
+| `pm`        | Product Manager    | PRD creation, feature prioritization    | Strategic planning, roadmaps           |
+| `architect` | Solution Architect | System design, technical architecture   | Complex systems, scalability planning  |
+| `dev`       | Developer          | Code implementation, debugging          | All development tasks                  |
+| `qa`        | QA Specialist      | Test planning, quality assurance        | Testing strategies, bug validation     |
+| `ux-expert` | UX Designer        | UI/UX design, prototypes                | User experience, interface design      |
+| `po`        | Product Owner      | Backlog management, story validation    | Story refinement, acceptance criteria  |
+| `sm`        | Scrum Master       | Sprint planning, story creation         | Project management, workflow           |
+
+### Meta Agents
+
+| Agent               | Role             | Primary Functions                     | When to Use                       |
+| ------------------- | ---------------- | ------------------------------------- | --------------------------------- |
+| `grimoire-orchestrator` | Team Coordinator | Multi-agent workflows, role switching | Complex multi-role tasks          |
+| `grimoire-master`       | Universal Expert | All capabilities without switching    | Single-session comprehensive work |
+
+### Agent Interaction Commands
+
+#### IDE-Specific Syntax
+
+**Agent Loading by IDE**:
+
+- **Claude Code**: `/agent-name` (e.g., `/grimoire-master`)
+- **Cursor**: `@agent-name` (e.g., `@grimoire-master`)
+- **GitHub Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
+
+**Chat Management Guidelines**:
+
+- **Claude Code, Cursor**: Start new chats when switching agents
+
+**Common Task Commands**:
+
+- `*help` - Show available commands
+- `*status` - Show current context/progress
+- `*exit` - Exit the agent mode
+- `*shard-doc docs/prd.md prd` - Shard PRD into manageable pieces
+- `*shard-doc docs/architecture.md architecture` - Shard architecture document
+- `*create` - Run create-next-story task (SM agent)
+
+**In Web UI**:
+
+```text
+/pm create-doc prd
+/architect review system design
+/dev implement story 1.2
+/help - Show available commands
+/switch agent-name - Change active agent (if orchestrator available)
+```
+
+## Team Configurations
+
+### Pre-Built Teams
+
+#### Team All
+
+- **Includes**: All 10 agents + orchestrator
+- **Use Case**: Complete projects requiring all roles
+- **Bundle**: `team-all.txt`
+
+#### Team Fullstack
+
+- **Includes**: PM, Architect, Developer, QA, UX Expert
+- **Use Case**: End-to-end web/mobile development
+- **Bundle**: `team-fullstack.txt`
+
+#### Team No-UI
+
+- **Includes**: PM, Architect, Developer, QA (no UX Expert)
+- **Use Case**: Backend services, APIs, system development
+- **Bundle**: `team-no-ui.txt`
+
+## Core Architecture
+
+### System Overview
+
+The grimoire-Method is built around a modular architecture centered on the `grimoire` directory, which serves as the brain of the entire system. This design enables the framework to operate effectively in both IDE environments (like Cursor, VS Code) and web-based AI interfaces (like ChatGPT, Gemini).
+
+### Key Architectural Components
+
+#### 1. Agents (`grimoire/agents/`)
+
+- **Purpose**: Each markdown file defines a specialized AI agent for a specific Agile role (PM, Dev, Architect, etc.)
+- **Structure**: Contains YAML headers specifying the agent's persona, capabilities, and dependencies
+- **Dependencies**: Lists of tasks, templates, checklists, and data files the agent can use
+- **Startup Instructions**: Can load project-specific documentation for immediate context
+
+#### 2. Agent Teams (`grimoire/agent-teams/`)
+
+- **Purpose**: Define collections of agents bundled together for specific purposes
+- **Examples**: `team-all.yaml` (comprehensive bundle), `team-fullstack.yaml` (full-stack development)
+- **Usage**: Creates pre-packaged contexts for web UI environments
+
+#### 3. Workflows (`grimoire/workflows/`)
+
+- **Purpose**: YAML files defining prescribed sequences of steps for specific project types
+- **Types**: Greenfield (new projects) and Brownfield (existing projects) for UI, service, and fullstack development
+- **Structure**: Defines agent interactions, artifacts created, and transition conditions
+
+#### 4. Reusable Resources
+
+- **Templates** (`grimoire/templates/`): Markdown templates for PRDs, architecture specs, user stories
+- **Tasks** (`grimoire/tasks/`): Instructions for specific repeatable actions like "shard-doc" or "create-next-story"
+- **Checklists** (`grimoire/checklists/`): Quality assurance checklists for validation and review
+- **Data** (`grimoire/data/`): Core knowledge base and technical preferences
+
+### Dual Environment Architecture
+
+#### IDE Environment
+
+- Users interact directly with agent markdown files
+- Agents can access all dependencies dynamically
+- Supports real-time file operations and project integration
+- Optimized for development workflow execution
+
+#### Web UI Environment
+
+- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assets with an orchestrating agent
+- Single text files containing all agent dependencies are in `dist/agents/` - these are unnecessary unless you want to create a web agent that is only a single agent and not a team
+- Created by the web-builder tool for upload to web interfaces
+- Provides complete context in one package
+
+### Template Processing System
+
+grimoire employs a sophisticated template system with three key components:
+
+1. **Template Format** (`utils/grimoire-doc-template.md`): Defines markup language for variable substitution and AI processing directives from yaml templates
+2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction to transform yaml spec to final markdown output
+3. **Advanced Elicitation** (`tasks/advanced-elicitation.md`): Provides interactive refinement through structured brainstorming
+
+### Technical Preferences Integration
+
+The `technical-preferences.md` file serves as a persistent technical profile that:
+
+- Ensures consistency across all agents and projects
+- Eliminates repetitive technology specification
+- Provides personalized recommendations aligned with user preferences
+- Evolves over time with lessons learned
+
+### Build and Delivery Process
+
+The `web-builder.js` tool creates web-ready bundles by:
+
+1. Reading agent or team definition files
+2. Recursively resolving all dependencies
+3. Concatenating content into single text files with clear separators
+4. Outputting ready-to-upload bundles for web AI interfaces
+
+This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes grimoire powerful.
+
+## Complete Development Workflow
+
+### Planning Phase (Web UI Recommended - Especially Gemini!)
+
+**Ideal for cost efficiency with Gemini's massive context:**
+
+**For Brownfield Projects - Start Here!**:
+
+1. **Upload entire project to Gemini Web** (GitHub URL, files, or zip)
+2. **Document existing system**: `/analyst` → `*document-project`
+3. **Creates comprehensive docs** from entire codebase analysis
+
+**For All Projects**:
+
+1. **Optional Analysis**: `/analyst` - Market research, competitive analysis
+2. **Project Brief**: Create foundation document (Analyst or user)
+3. **PRD Creation**: `/pm create-doc prd` - Comprehensive product requirements
+4. **Architecture Design**: `/architect create-doc architecture` - Technical foundation
+5. **Validation & Alignment**: `/po` run master checklist to ensure document consistency
+6. **Document Preparation**: Copy final documents to project as `docs/prd.md` and `docs/architecture.md`
+
+#### Example Planning Prompts
+
+**For PRD Creation**:
+
+```text
+"I want to build a [type] application that [core purpose].
+Help me brainstorm features and create a comprehensive PRD."
+```
+
+**For Architecture Design**:
+
+```text
+"Based on this PRD, design a scalable technical architecture
+that can handle [specific requirements]."
+```
+
+### Critical Transition: Web UI to IDE
+
+**Once planning is complete, you MUST switch to IDE for development:**
+
+- **Why**: Development workflow requires file operations, real-time project integration, and document sharding
+- **Cost Benefit**: Web UI is more cost-effective for large document creation; IDE is optimized for development tasks
+- **Required Files**: Ensure `docs/prd.md` and `docs/architecture.md` exist in your project
+
+### IDE Development Workflow
+
+**Prerequisites**: Planning documents must exist in `docs/` folder
+
+1. **Document Sharding** (CRITICAL STEP):
+   - Documents created by PM/Architect (in Web or IDE) MUST be sharded for development
+   - Two methods to shard:
+     a) **Manual**: Drag `shard-doc` task + document file into chat
+     b) **Agent**: Ask `@grimoire-master` or `@po` to shard documents
+   - Shards `docs/prd.md` → `docs/prd/` folder
+   - Shards `docs/architecture.md` → `docs/architecture/` folder
+   - **WARNING**: Do NOT shard in Web UI - copying many small files is painful!
+
+2. **Verify Sharded Content**:
+   - At least one `epic-n.md` file in `docs/prd/` with stories in development order
+   - Source tree document and coding standards for dev agent reference
+   - Sharded docs for SM agent story creation
+
+Resulting Folder Structure:
+
+- `docs/prd/` - Broken down PRD sections
+- `docs/architecture/` - Broken down architecture sections
+- `docs/stories/` - Generated user stories
+
+1. **Development Cycle** (Sequential, one story at a time):
+
+   **CRITICAL CONTEXT MANAGEMENT**:
+   - **Context windows matter!** Always use fresh, clean context windows
+   - **Model selection matters!** Use most powerful thinking model for SM story creation
+   - **ALWAYS start new chat between SM, Dev, and QA work**
+
+   **Step 1 - Story Creation**:
+   - **NEW CLEAN CHAT** → Select powerful model → `@sm` → `*create`
+   - SM executes create-next-story task
+   - Review generated story in `docs/stories/`
+   - Update status from "Draft" to "Approved"
+
+   **Step 2 - Story Implementation**:
+   - **NEW CLEAN CHAT** → `@dev`
+   - Agent asks which story to implement
+   - Include story file content to save dev agent lookup time
+   - Dev follows tasks/subtasks, marking completion
+   - Dev maintains File List of all changes
+   - Dev marks story as "Review" when complete with all tests passing
+
+   **Step 3 - Senior QA Review**:
+   - **NEW CLEAN CHAT** → `@qa` → execute review-story task
+   - QA performs senior developer code review
+   - QA can refactor and improve code directly
+   - QA appends results to story's QA Results section
+   - If approved: Status → "Done"
+   - If changes needed: Status stays "Review" with unchecked items for dev
+
+   **Step 4 - Repeat**: Continue SM → Dev → QA cycle until all epic stories complete
+
+**Important**: Only 1 story in progress at a time, worked sequentially until all epic stories complete.
+
+### Status Tracking Workflow
+
+Stories progress through defined statuses:
+
+- **Draft** → **Approved** → **InProgress** → **Done**
+
+Each status change requires user verification and approval before proceeding.
+
+### Workflow Types
+
+#### Greenfield Development
+
+- Business analysis and market research
+- Product requirements and feature definition  
+- System architecture and design
+- Development execution
+- Testing and deployment
+
+#### Brownfield Enhancement (Existing Projects)
+
+**Key Concept**: Brownfield development requires comprehensive documentation of your existing project for AI agents to understand context, patterns, and constraints.
+
+**Complete Brownfield Workflow Options**:
+
+**Option 1: PRD-First (Recommended for Large Codebases/Monorepos)**:
+
+1. **Upload project to Gemini Web** (GitHub URL, files, or zip)
+2. **Create PRD first**: `@pm` → `*create-doc brownfield-prd`
+3. **Focused documentation**: `@analyst` → `*document-project`
+   - Analyst asks for focus if no PRD provided
+   - Choose "single document" format for Web UI
+   - Uses PRD to document ONLY relevant areas
+   - Creates one comprehensive markdown file
+   - Avoids bloating docs with unused code
+
+**Option 2: Document-First (Good for Smaller Projects)**:
+
+1. **Upload project to Gemini Web**
+2. **Document everything**: `@analyst` → `*document-project`
+3. **Then create PRD**: `@pm` → `*create-doc brownfield-prd`
+   - More thorough but can create excessive documentation
+
+4. **Requirements Gathering**:
+   - **Brownfield PRD**: Use PM agent with `brownfield-prd-tmpl`
+   - **Analyzes**: Existing system, constraints, integration points
+   - **Defines**: Enhancement scope, compatibility requirements, risk assessment
+   - **Creates**: Epic and story structure for changes
+
+5. **Architecture Planning**:
+   - **Brownfield Architecture**: Use Architect agent with `brownfield-architecture-tmpl`
+   - **Integration Strategy**: How new features integrate with existing system
+   - **Migration Planning**: Gradual rollout and backwards compatibility
+   - **Risk Mitigation**: Addressing potential breaking changes
+
+**Brownfield-Specific Resources**:
+
+**Templates**:
+
+- `brownfield-prd-tmpl.md`: Comprehensive enhancement planning with existing system analysis
+- `brownfield-architecture-tmpl.md`: Integration-focused architecture for existing systems
+
+**Tasks**:
+
+- `document-project`: Generates comprehensive documentation from existing codebase
+- `brownfield-create-epic`: Creates single epic for focused enhancements (when full PRD is overkill)
+- `brownfield-create-story`: Creates individual story for small, isolated changes
+
+**When to Use Each Approach**:
+
+**Full Brownfield Workflow** (Recommended for):
+
+- Major feature additions
+- System modernization
+- Complex integrations
+- Multiple related changes
+
+**Quick Epic/Story Creation** (Use when):
+
+- Single, focused enhancement
+- Isolated bug fixes
+- Small feature additions
+- Well-documented existing system
+
+**Critical Success Factors**:
+
+1. **Documentation First**: Always run `document-project` if docs are outdated/missing
+2. **Context Matters**: Provide agents access to relevant code sections
+3. **Integration Focus**: Emphasize compatibility and non-breaking changes
+4. **Incremental Approach**: Plan for gradual rollout and testing
+
+**For detailed guide**: See `docs/working-in-the-brownfield.md`
+
+## Document Creation Best Practices
+
+### Required File Naming for Framework Integration
+
+- `docs/prd.md` - Product Requirements Document
+- `docs/architecture.md` - System Architecture Document
+
+**Why These Names Matter**:
+
+- Agents automatically reference these files during development
+- Sharding tasks expect these specific filenames
+- Workflow automation depends on standard naming
+
+### Cost-Effective Document Creation Workflow
+
+**Recommended for Large Documents (PRD, Architecture):**
+
+1. **Use Web UI**: Create documents in web interface for cost efficiency
+2. **Copy Final Output**: Save complete markdown to your project
+3. **Standard Names**: Save as `docs/prd.md` and `docs/architecture.md`
+4. **Switch to IDE**: Use IDE agents for development and smaller documents
+
+### Document Sharding
+
+Templates with Level 2 headings (`##`) can be automatically sharded:
+
+**Original PRD**:
+
+```markdown
+## Goals and Background Context
+## Requirements  
+## User Interface Design Goals
+## Success Metrics
+```
+
+**After Sharding**:
+
+- `docs/prd/goals-and-background-context.md`
+- `docs/prd/requirements.md`
+- `docs/prd/user-interface-design-goals.md`
+- `docs/prd/success-metrics.md`
+
+Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sharding.
+
+## ClickUp Integration Workflow
+
+### Overview
+
+grimoire integrates with ClickUp for project management and story tracking. When creating stories using the `create-next-story` task, agents must follow a specific workflow to correctly interact with the ClickUp MCP server.
+
+### Critical Workflow Pattern
+
+**ALWAYS use this 2-step process:**
+
+#### Step 1: Get Workspace Hierarchy
+```javascript
+// Call get_workspace_hierarchy (no parameters needed)
+const hierarchy = await clickup.get_workspace_hierarchy();
+
+// Extract the numeric list_id from response:
+{
+  "spaces": [{
+    "name": "grimoire Project",
+    "lists": [{
+      "name": "Backlog",
+      "id": "901317181013"  // ← This is what you need
+    }]
+  }]
+}
+```
+
+**Store the numeric list_id** for use in Step 2.
+
+#### Step 2: Create Task with Discovered list_id
+```yaml
+# Call create_task with these parameters:
+list_id: "901317181013"  # ← MUST be numeric string from Step 1
+name: "Story 5.2: Implement Feature X"
+parent: "86acfeqeq"  # Epic task ID (if creating as subtask)
+markdown_description: "Complete story content..."
+tags:
+  - "story"
+  - "epic-5"
+  - "story-5.2"
+custom_fields:
+  - id: "epic_number"
+    value: 5
+  - id: "story_number"
+    value: "5.2"
+```
+
+### Validation Requirements
+
+**Critical Rules:**
+- `list_id` MUST be a numeric string (validated by `/^\d+$/`)
+- Using `"Backlog"` or other non-numeric values WILL FAIL
+- `assignees` (if provided) must be an array: `[123, 456]`
+- `custom_fields` must be array of objects with `id` and `value`
+
+### Common Errors and Solutions
+
+#### Error: "list_id must be a numeric string"
+**Cause:** Used list name instead of numeric ID
+```yaml
+# ❌ Wrong
+list_id: "Backlog"
+
+# ✅ Correct
+list_id: "901317181013"
+```
+
+#### Error: "assignees must be array"
+**Cause:** Used object format instead of array
+```yaml
+# ❌ Wrong
+assignees: {add: [456]}
+
+# ✅ Correct
+assignees: [456]
+```
+
+#### Error: "custom_fields must be an array"
+**Cause:** Invalid field structure
+```yaml
+# ❌ Wrong
+custom_fields: "field-value"
+
+# ✅ Correct
+custom_fields:
+  - id: "field-uuid"
+    value: "field-value"
+```
+
+### Quick Reference
+
+**When creating stories:**
+1. Always call `get_workspace_hierarchy` first
+2. Extract numeric `list_id` from response
+3. Use that `list_id` in `create_task`
+4. Store returned `task_id` in story frontmatter
+
+**Where to find examples:**
+- Complete workflow: `grimoire/tools/mcp/clickup.yaml` (story_creation_workflow section)
+- Task instructions: `grimoire/tasks/create-next-story.md` (sections 5.1 and 5.3)
+- Validators: `grimoire/tools/mcp/clickup.yaml` (executable_knowledge section)
+
+**Response Handling:**
+```yaml
+# After successful create_task, update story frontmatter:
+clickup:
+  task_id: "86acfetr9"  # From create_task response
+  epic_task_id: "86acfeqeq"  # From get_workspace_tasks
+  list: "Backlog"
+  url: "https://app.clickup.com/t/86acfetr9"
+  last_sync: "2025-10-10T14:30:00Z"
+```
+
+### Performance Tips
+
+- Cache workspace hierarchy during session
+- Reuse list_id for multiple story creations
+- Pre-fetch epic task IDs at story creation start
+- Validate parameters before MCP call using built-in validators
+
+## Usage Patterns and Best Practices
+
+### Environment-Specific Usage
+
+**Web UI Best For**:
+
+- Initial planning and documentation phases
+- Cost-effective large document creation
+- Agent consultation and brainstorming
+- Multi-agent workflows with orchestrator
+
+**IDE Best For**:
+
+- Active development and implementation
+- File operations and project integration
+- Story management and development cycles
+- Code review and debugging
+
+### Quality Assurance
+
+- Use appropriate agents for specialized tasks
+- Follow Agile ceremonies and review processes
+- Maintain document consistency with PO agent
+- Regular validation with checklists and templates
+
+### Performance Optimization
+
+- Use specific agents vs. `grimoire-master` for focused tasks
+- Choose appropriate team size for project needs
+- Leverage technical preferences for consistency
+- Regular context management and cache clearing
+
+## Success Tips
+
+- **Use Gemini for big picture planning** - The team-fullstack bundle provides collaborative expertise
+- **Use grimoire-master for document organization** - Sharding creates manageable chunks
+- **Follow the SM → Dev cycle religiously** - This ensures systematic progress
+- **Keep conversations focused** - One agent, one task per conversation
+- **Review everything** - Always review and approve before marking complete
+
+## Contributing to grimoire-Method
+
+### Quick Contribution Guidelines
+
+For full details, see `CONTRIBUTING.md`. Key points:
+
+**Fork Workflow**:
+
+1. Fork the repository
+2. Create feature branches
+3. Submit PRs to `next` branch (default) or `main` for critical fixes only
+4. Keep PRs small: 200-400 lines ideal, 800 lines maximum
+5. One feature/fix per PR
+
+**PR Requirements**:
+
+- Clear descriptions (max 200 words) with What/Why/How/Testing
+- Use conventional commits (feat:, fix:, docs:)
+- Atomic commits - one logical change per commit
+- Must align with guiding principles
+
+**Core Principles** (from docs/GUIDING-PRINCIPLES.md):
+
+- **Dev Agents Must Be Lean**: Minimize dependencies, save context for code
+- **Natural Language First**: Everything in markdown, no code in core
+- **Core vs Squads**: Core for universal needs, squads for specialized domains
+- **Design Philosophy**: "Dev agents code, planning agents plan"
+
+## Squads
+
+### What Are Squads?
+
+Squads extend grimoire-Method beyond traditional software development into ANY domain. They provide specialized agent teams, templates, and workflows while keeping the core framework lean and focused on development.
+
+### Why Use Squads?
+
+1. **Keep Core Lean**: Dev agents maintain maximum context for coding
+2. **Domain Expertise**: Deep, specialized knowledge without bloating core
+3. **Community Innovation**: Anyone can create and share squads
+4. **Modular Design**: Install only what you need
+
+### Available Squads
+
+**Technical Squads**:
+
+- **Infrastructure/DevOps**: Cloud architects, SRE experts, security specialists
+- **Game Development**: Game designers, level designers, narrative writers
+- **Mobile Development**: iOS/Android specialists, mobile UX experts
+- **Data Science**: ML engineers, data scientists, visualization experts
+
+**Non-Technical Squads**:
+
+- **Business Strategy**: Consultants, financial analysts, marketing strategists
+- **Creative Writing**: Plot architects, character developers, world builders
+- **Health & Wellness**: Fitness trainers, nutritionists, habit engineers
+- **Education**: Curriculum designers, assessment specialists
+- **Legal Support**: Contract analysts, compliance checkers
+
+**Specialty Squads**:
+
+- **Expansion Creator**: Tools to build your own squads
+- **RPG Game Master**: Tabletop gaming assistance
+- **Life Event Planning**: Wedding planners, event coordinators
+- **Scientific Research**: Literature reviewers, methodology designers
+
+### Using Squads
+
+1. **Browse Available Squads**: Check `squads/` directory
+2. **Get Inspiration**: See `docs/squads.md` for detailed examples and ideas
+3. **Install via CLI**:
+
+   ```bash
+   npx @grimoire/grimoire install
+   # Select "Install squad" option
+   ```
+
+4. **Use in Your Workflow**: Installed squads integrate seamlessly with existing agents
+
+### Creating Custom Squads
+
+Use the **squad-creator** squad to build your own:
+
+1. **Define Domain**: What expertise are you capturing?
+2. **Design Agents**: Create specialized roles with clear boundaries
+3. **Build Resources**: Tasks, templates, checklists for your domain
+4. **Test & Share**: Validate with real use cases, share with community
+
+**Key Principle**: Squads democratize expertise by making specialized knowledge accessible through AI agents.
+
+## Getting Help
+
+- **Commands**: Use `*/*help` in any environment to see available commands
+- **Agent Switching**: Use `*/*switch agent-name` with orchestrator for role changes
+- **Documentation**: Check `docs/` folder for project-specific context
+- **Community**: Discord and GitHub resources available for support
+- **Contributing**: See `CONTRIBUTING.md` for full guidelines
+ 
+
+