myaidev-method 0.2.1 → 0.2.3

package/README.md

@@ -1,22 +1,39 @@
 # MyAIDev Method
 
-> **🚀 The easiest way to supercharge your AI CLI with professional agents and get real work done!**
+> **🚀 A comprehensive development framework for AI-assisted software development with systematic workflows and multi-platform publishing!**
 
-A comprehensive package for AI CLI tools (Claude Code, Gemini CLI, Codex CLI) that provides custom subagents and MCP integrations for enhanced development workflows. **Zero code required** - just run one command and start creating professional content!
+The **MyAIDev Method** is a complete development framework for AI CLI tools (Claude Code, Gemini CLI, Codex CLI) featuring the **SPARC methodology** for systematic software development, inspired by [GitHub Spec-Kit](https://github.com/github/spec-kit) patterns for agentic software development.
 
-**✨ What makes this special:**
+**🌟 What makes this special:**
+
+**Comprehensive Development Framework:**
+- **SPARC Methodology**: 5-phase systematic development workflow (Specification → Pseudocode → Architecture → Refinement → Completion)
+- **Development Agents**: Architect, Coder, Tester, Reviewer, Documenter - complete coverage from design to deployment
+- **Quality-First**: Built-in security (OWASP Top 10), testing (80%+ coverage), and code review standards
+- **Spec-Kit Inspired**: Proven patterns for agentic software development based on GitHub's Spec-Kit framework
+
+**Multi-Platform Publishing & Deployment:**
+- **CMS Publishing**: WordPress, PayloadCMS with full content management
+- **Static Site Generators**: Docusaurus, Mintlify, Astro with git-based workflows
+- **Deployment**: Coolify self-hosted PaaS orchestration
+- **Infrastructure**: RamNode.com optimized deployment patterns
+
+**Professional Tooling:**
 - **Instant setup**: One `npx` command and you're ready
-- **Professional agents**: Content writer and WordPress admin out-of-the-box
-- **Claude Code native**: Follows official standards for maximum compatibility, with Gemini and OpenAI Codex CLI too.
-- **No dependencies**: Works standalone, leverages MCPs for WordPress, Notion, Google Workspace integration is optional
+- **Claude Code native**: Follows official standards for maximum compatibility
+- **Zero dependencies**: Core features work standalone, optional MCP integrations available
+- **Production-ready**: SOLID principles, Clean Code, comprehensive testing built-in
 
 ## 📋 Table of Contents
 
 - [Features](#features)
 - [Installation](#installation)
 - [Quick Start](#quick-start)
-- [Available Agents](#available-agents)
+- [SPARC Development Workflow](#sparc-development-workflow)
+- [Development Agents](#development-agents)
+- [Content & Publishing Agents](#content--publishing-agents)
 - [Slash Commands](#slash-commands)
+- [MCP Server Integration](#mcp-server-integration)
 - [Configuration](#configuration)
 - [WordPress Integration](#wordpress-integration)
 - [SSH Integration](#ssh-integration)
@@ -30,16 +47,35 @@ A comprehensive package for AI CLI tools (Claude Code, Gemini CLI, Codex CLI) th
 
 ## ✨ Features
 
-- 🤖 **Custom Subagents**: Pre-configured AI agents in Markdown format with YAML frontmatter
-- 📝 **Content Writer Agent**: Professional content creation with SEO optimization
-- 🔐 **WordPress Admin Agent**: Site administration, security analysis, and performance optimization
-- 📤 **Multi-Platform Publishing**: Publish to WordPress, PayloadCMS, Docusaurus, Mintlify, and Astro
-- 🚀 **Coolify Deployment**: Self-hosted PaaS deployment and management
-- 🔌 **MCP Integration**: WordPress, git-based workflows, and more
-- 💻 **SSH Integration**: Server-level operations for advanced administration
-- 🎯 **Slash Commands**: Easy-to-use Markdown-based commands for Claude Code
-- 🔄 **Git-Based Publishing**: Automated git workflows for static sites
-- ✅ **Standards Compliant**: Follows Claude Code 2.0 agent patterns
+### 🏗️ Development Framework (SPARC Methodology)
+- **Systematic Workflow**: 5-phase SPARC methodology (Specification → Pseudocode → Architecture → Refinement → Completion)
+- **Development Agents**: Complete suite of specialized agents for the full development lifecycle
+  - 🏗️ **Architect**: System design, API specifications, data modeling, technology selection
+  - 💻 **Coder**: Feature implementation, refactoring, SOLID principles, Clean Code
+  - 🧪 **Tester**: Unit/integration testing, 80%+ coverage, quality gates
+  - 👁️ **Reviewer**: Code quality, security (OWASP Top 10), performance analysis
+  - 📚 **Documenter**: API docs, user guides, architecture documentation
+- **Spec-Kit Patterns**: Proven agentic development patterns inspired by GitHub Spec-Kit
+- **Quality Standards**: Built-in security, testing, code review, and documentation standards
+- **File-Based Workflow**: Sequential agent coordination with `.myaidev-method/sparc/` outputs
+
+### 📝 Content & Publishing
+- **Content Writer Agent**: Professional SEO-optimized content creation
+- **Multi-Platform Publishing**: WordPress, PayloadCMS, Docusaurus, Mintlify, Astro
+- **Git-Based Workflows**: Automated publishing for static site generators
+- **WordPress Admin Agent**: Security, performance, health monitoring, and administration
+
+### 🚀 Deployment & Infrastructure
+- **Coolify Integration**: Self-hosted PaaS deployment and orchestration
+- **RamNode Optimized**: Deployment patterns optimized for RamNode.com infrastructure
+- **SSH Integration**: Server-level operations for advanced administration
+- **MCP Server Integration**: Optional advanced features with SPARC Orchestrator, Chrome DevTools, and WordPress MCP servers
+
+### 🛠️ Development Tools
+- **Slash Commands**: Easy-to-use Markdown-based commands for Claude Code
+- **Custom Subagents**: Pre-configured AI agents following Claude Code 2.0 standards
+- **Standards Compliant**: Full compatibility with Claude Code, Gemini CLI, Codex CLI
+- **Zero Dependencies**: Core features work standalone, optional MCP integrations
 
 ## 🚀 Installation
 
@@ -98,7 +134,269 @@ npx myaidev-method init
    /myai-wordpress-admin health-check
    ```
 
-## 🤖 Available Agents
+## 🏗️ SPARC Development Workflow
+
+The **MyAIDev Method** implements the **SPARC methodology** - a systematic 5-phase approach to software development inspired by [GitHub Spec-Kit](https://github.com/github/spec-kit) patterns for agentic software development.
+
+### What is SPARC?
+
+**SPARC** stands for:
+- **S**pecification - Define requirements and system boundaries
+- **P**seudocode - Plan implementation approach
+- **A**rchitecture - Design system structure, APIs, and data models
+- **R**efinement - Implement, test, and review code quality
+- **C**ompletion - Document and deliver production-ready software
+
+### The 5 Phases
+
+```
+┌─────────────────────────────────────────────────────────────────┐
+│  SPARC Workflow: Systematic Software Development                 │
+└─────────────────────────────────────────────────────────────────┘
+
+Phase 1: 🏗️ ARCHITECTURE
+├─ Agent: dev-architect
+├─ Output: .myaidev-method/sparc/architecture.md
+├─ Deliverables:
+│  ├─ System design with Mermaid diagrams
+│  ├─ API specifications (REST/GraphQL/gRPC)
+│  ├─ Data models and schemas
+│  ├─ Technology stack recommendations
+│  └─ Security and scalability planning
+└─ Command: /myai-dev-architect "Design authentication system"
+
+Phase 2: 💻 IMPLEMENTATION
+├─ Agent: dev-coder
+├─ Output: .myaidev-method/sparc/code-output/
+├─ Standards: SOLID, Clean Code, DRY/KISS/YAGNI
+├─ Features:
+│  ├─ Production-ready code implementation
+│  ├─ Security best practices (OWASP Top 10)
+│  ├─ Error handling and input validation
+│  └─ Inline documentation (JSDoc, etc.)
+└─ Command: /myai-dev-code "Implement JWT authentication"
+
+Phase 3: 🧪 TESTING
+├─ Agent: dev-tester
+├─ Output: .myaidev-method/sparc/test-results/
+├─ Coverage: 80%+ critical paths, 60%+ overall
+├─ Deliverables:
+│  ├─ Unit test suites
+│  ├─ Integration tests
+│  ├─ Coverage reports
+│  └─ Quality gate validation
+└─ Command: /myai-dev-test "Test authentication module"
+
+Phase 4: 👁️ REVIEW
+├─ Agent: dev-reviewer
+├─ Output: .myaidev-method/sparc/review-report.md
+├─ Analysis:
+│  ├─ Code quality and complexity
+│  ├─ Security audit (OWASP Top 10)
+│  ├─ Performance optimization
+│  ├─ Best practices compliance
+│  └─ Technical debt assessment
+└─ Command: /myai-dev-review "Review authentication implementation"
+
+Phase 5: 📚 DOCUMENTATION
+├─ Agent: dev-documenter
+├─ Output: .myaidev-method/sparc/documentation/
+├─ Deliverables:
+│  ├─ API reference (OpenAPI/Swagger)
+│  ├─ User guides and tutorials
+│  ├─ Architecture documentation
+│  └─ Code examples and snippets
+└─ Command: /myai-dev-docs "Document authentication API"
+```
+
+### Complete Workflow Execution
+
+Run the entire SPARC workflow with a single command:
+
+```bash
+# Execute all 5 phases sequentially
+npm run sparc "Build user authentication system with JWT"
+
+# Or use the slash command
+/myai-sparc-workflow "Create payment processing module"
+
+# With technology preferences
+npm run sparc "Build e-commerce checkout" --tech-stack "react,node,stripe,postgres"
+```
+
+### Workflow Output Structure
+
+```
+.myaidev-method/
+├── sparc/
+│   ├── architecture.md              # Phase 1: System design
+│   ├── code-output/                 # Phase 2: Implementation
+│   │   ├── src/
+│   │   ├── tests/
+│   │   └── ...
+│   ├── test-results/                # Phase 3: Testing
+│   │   ├── unit/
+│   │   ├── integration/
+│   │   └── coverage-report.md
+│   ├── review-report.md             # Phase 4: Code review
+│   └── documentation/               # Phase 5: Documentation
+│       ├── api/
+│       ├── user-guide/
+│       └── architecture/
+├── tasks/                           # Task tracking
+└── workflows/                       # Workflow execution logs
+```
+
+### Quality Standards
+
+Every SPARC workflow enforces:
+
+- **Code Quality**: SOLID principles, Clean Code, maintainability metrics
+- **Security**: OWASP Top 10 compliance, vulnerability scanning
+- **Testing**: 80%+ critical path coverage, integration tests
+- **Performance**: Algorithm complexity analysis, optimization recommendations
+- **Documentation**: Complete API docs, user guides, architecture specs
+
+### GitHub Spec-Kit Inspiration
+
+This framework is inspired by [GitHub's Spec-Kit](https://github.com/github/spec-kit) patterns for agentic software development:
+
+- **Systematic Approach**: Structured phases with clear deliverables
+- **Quality Gates**: Validation at each phase transition
+- **Agent Specialization**: Dedicated agents with specific expertise
+- **File-Based Coordination**: Agents communicate through well-defined outputs
+- **Reproducible Workflows**: Consistent results across projects
+
+### Individual Phase Commands
+
+You can also run individual phases:
+
+```bash
+# CLI commands
+npm run dev:architect "Design real-time chat app"
+npm run dev:code "Implement WebSocket server"
+npm run dev:test "Test chat functionality" --integration
+npm run dev:review "Review chat implementation" --security
+npm run dev:docs "Document chat API"
+
+# Slash commands (in Claude Code)
+/myai-dev-architect "Design microservices architecture"
+/myai-dev-code "Implement user service" --test-driven
+/myai-dev-test "Test user service" --coverage
+/myai-dev-review "Security audit for user service"
+/myai-dev-docs "Document user service API"
+```
+
+## 🤖 Development Agents
+
+### Complete Development Lifecycle Coverage
+
+The MyAIDev Method provides specialized agents for every phase of the development lifecycle:
+
+### 🏗️ Architecture Agent
+**File:** `.claude/agents/dev-architect.md`
+**Phase:** Architecture (SPARC Phase 1)
+
+System architect specializing in scalable design, API specifications, and technology selection.
+
+**Capabilities:**
+- High-level system architecture with Mermaid diagrams
+- API contract definitions (REST, GraphQL, gRPC)
+- Data modeling and schema design
+- Technology stack recommendations
+- Security architecture planning
+- Scalability and performance planning
+
+**Output:** `.myaidev-method/sparc/architecture.md`
+
+### 💻 Implementation Agent (Coder)
+**File:** `.claude/agents/dev-coder.md`
+**Phase:** Implementation (SPARC Phase 2)
+
+Production code implementer following SOLID principles and Clean Code practices.
+
+**Capabilities:**
+- Feature implementation from architecture specs
+- Code refactoring and optimization
+- SOLID principles application
+- Security best practices (OWASP Top 10)
+- Error handling and input validation
+- Inline documentation (JSDoc, Sphinx, etc.)
+
+**Output:** `.myaidev-method/sparc/code-output/`
+
+**Quality Standards:**
+- 80%+ test coverage target
+- SOLID, DRY, KISS, YAGNI principles
+- Security-first implementation
+- Comprehensive error handling
+
+### 🧪 Testing Agent
+**File:** `.claude/agents/dev-tester.md`
+**Phase:** Testing (SPARC Phase 3)
+
+Comprehensive testing specialist with TDD workflow support.
+
+**Capabilities:**
+- Unit test creation (AAA pattern)
+- Integration test development
+- Coverage analysis and reporting
+- Quality gate validation
+- Test-Driven Development (TDD) workflow
+- Multiple framework support (Jest, Mocha, Pytest, etc.)
+
+**Output:** `.myaidev-method/sparc/test-results/`
+
+**Coverage Standards:**
+- 80%+ for critical paths
+- 60%+ overall coverage
+- Pre-commit, pre-merge, pre-deployment gates
+
+### 👁️ Code Review Agent
+**File:** `.claude/agents/dev-reviewer.md`
+**Phase:** Review (SPARC Phase 4)
+
+Code quality and security analyst with comprehensive review capabilities.
+
+**Capabilities:**
+- Code quality metrics and complexity analysis
+- Security audit (OWASP Top 10 compliance)
+- Performance review and optimization
+- Best practices validation (SOLID, framework standards)
+- Technical debt assessment with priority scoring
+- Code smell and anti-pattern detection
+
+**Output:** `.myaidev-method/sparc/review-report.md`
+
+**Review Standards:**
+- Code quality: Complexity, readability, maintainability
+- Security: OWASP Top 10, vulnerability patterns
+- Performance: Algorithm complexity, resource management
+- Best practices: Framework standards, design patterns
+
+### 📚 Documentation Agent
+**File:** `.claude/agents/dev-documenter.md`
+**Phase:** Documentation (SPARC Phase 5)
+
+Technical documentation specialist for APIs, user guides, and architecture docs.
+
+**Capabilities:**
+- API reference generation (OpenAPI/Swagger)
+- User guide and tutorial creation
+- Architecture documentation
+- Code example generation and testing
+- Multiple format support (Markdown, HTML, reStructuredText)
+- Inline code documentation (JSDoc, Sphinx, etc.)
+
+**Output:** `.myaidev-method/sparc/documentation/`
+
+**Documentation Standards:**
+- Clarity: Simple language, clear examples, visual aids
+- Completeness: All public APIs documented
+- Accuracy: Tested code examples, synchronized with code
+- Accessibility: Multiple formats, searchable, well-organized
+
+## 📝 Content & Publishing Agents
 
 ### Content Writer Agent
 **File:** `.claude/agents/content-writer.md`
@@ -113,9 +411,7 @@ Professional content writer specializing in creating high-quality, engaging, and
 - Multiple tone and audience support
 - Keyword optimization
 
-### Publishing Agents
-
-#### WordPress Admin Agent
+### WordPress Admin Agent
 **File:** `.claude/agents/wordpress-admin.md`
 
 WordPress administrator for comprehensive site management, security, performance, and health analysis.
@@ -305,6 +601,67 @@ Configure MyAI Method settings.
 
 For detailed publishing workflows and platform-specific guides, see **[PUBLISHING_GUIDE.md](PUBLISHING_GUIDE.md)**
 
+## 🔧 MCP Server Integration
+
+MyAIDev Method includes three optional MCP (Model Context Protocol) servers for advanced orchestration, testing, and WordPress integration.
+
+### Available MCP Servers
+
+**1. SPARC Orchestrator** - Workflow automation for the 5-phase SPARC methodology
+- `sparc_orchestrate` - Orchestrate complete 5-phase workflows
+- `sparc_status` - Get workflow execution status
+- `sparc_phase_execute` - Execute single SPARC phases
+- `sparc_workflow_history` - View workflow history
+- `sparc_task_results` - Get detailed workflow results
+
+**2. Chrome DevTools MCP** - Browser automation and testing ([chrome-devtools-mcp](https://github.com/ChromeDevTools/chrome-devtools-mcp))
+- `cdp_connect` - Connect to Chrome DevTools Protocol
+- `cdp_navigate` - Browser navigation
+- `cdp_screenshot` - Visual testing with screenshots
+- `cdp_evaluate` - Execute JavaScript in browser
+- `cdp_network_monitor` - Monitor network requests
+- `cdp_console_logs` - Capture console logs
+
+**3. WordPress MCP** - Enhanced WordPress operations with session management
+- Session management and memory persistence
+- Health monitoring and site statistics
+- Batch publishing operations
+- Enhanced WordPress REST API integration
+
+### Setup MCP Servers
+
+Add to Claude Code MCP settings:
+
+```bash
+# SPARC Orchestrator
+claude mcp add myaidev-sparc npx myaidev-sparc-orchestrator
+
+# Chrome DevTools (requires separate installation)
+npm install -g chrome-devtools-mcp
+claude mcp add chrome-devtools npx chrome-devtools-mcp
+
+# WordPress MCP
+claude mcp add myaidev-wordpress npx myaidev-mcp-server
+```
+
+### Usage Example
+
+```javascript
+// Orchestrate complete SPARC workflow
+mcp__myaidev_sparc__sparc_orchestrate({
+  task: "Build user authentication system",
+  strategy: "sequential",
+  phases: ["architecture", "implementation", "testing", "review", "documentation"],
+  options: {
+    techStack: "nextjs,payloadcms,mongodb",
+    testFramework: "jest",
+    focusSecurity: true
+  }
+})
+```
+
+For detailed MCP setup and usage, see **[MCP_INTEGRATION.md](MCP_INTEGRATION.md)**
+
 ## ⚙️ Configuration
 
 After installation for Claude Code, the package creates a `.claude` directory following official standards: