@mytechtoday/augment-extensions 0.2.0 → 0.5.0

package/augment-extensions/domain-rules/marketing-standards/seo-sales-marketing/schemas/content-template.schema.json

@@ -0,0 +1,383 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://augment.dev/schemas/marketing/content-template.json",
+  "title": "Content Template",
+  "description": "JSON schema for content templates (blog, social, email) with validation rules",
+  "type": "object",
+  "required": ["templateName", "contentType"],
+  "properties": {
+    "templateName": {
+      "type": "string",
+      "description": "Template name"
+    },
+    "templateId": {
+      "type": "string",
+      "description": "Unique template identifier"
+    },
+    "contentType": {
+      "type": "string",
+      "enum": ["blog_post", "social_media", "email", "landing_page", "case_study", "whitepaper", "press_release", "newsletter", "ad_copy", "other"],
+      "description": "Type of content"
+    },
+    "platform": {
+      "type": "string",
+      "enum": ["website", "facebook", "instagram", "twitter", "linkedin", "youtube", "tiktok", "email", "other"],
+      "description": "Target platform (for social media and email)"
+    },
+    "structure": {
+      "type": "object",
+      "description": "Content structure and sections",
+      "properties": {
+        "sections": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": ["name", "type"],
+            "properties": {
+              "name": {
+                "type": "string",
+                "description": "Section name (e.g., 'Introduction', 'Body', 'CTA')"
+              },
+              "type": {
+                "type": "string",
+                "enum": ["heading", "paragraph", "list", "image", "video", "cta", "quote", "code", "table", "custom"],
+                "description": "Section type"
+              },
+              "required": {
+                "type": "boolean",
+                "default": false,
+                "description": "Whether this section is required"
+              },
+              "placeholder": {
+                "type": "string",
+                "description": "Placeholder text or instructions"
+              },
+              "maxLength": {
+                "type": "integer",
+                "description": "Maximum character length"
+              },
+              "minLength": {
+                "type": "integer",
+                "description": "Minimum character length"
+              },
+              "validation": {
+                "type": "object",
+                "properties": {
+                  "pattern": { "type": "string" },
+                  "errorMessage": { "type": "string" }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "metadata": {
+      "type": "object",
+      "description": "Content metadata fields",
+      "properties": {
+        "title": {
+          "type": "object",
+          "properties": {
+            "required": { "type": "boolean", "default": true },
+            "maxLength": { "type": "integer", "default": 60 },
+            "placeholder": { "type": "string" }
+          }
+        },
+        "description": {
+          "type": "object",
+          "properties": {
+            "required": { "type": "boolean", "default": true },
+            "maxLength": { "type": "integer", "default": 160 },
+            "placeholder": { "type": "string" }
+          }
+        },
+        "keywords": {
+          "type": "object",
+          "properties": {
+            "required": { "type": "boolean", "default": false },
+            "minItems": { "type": "integer", "default": 3 },
+            "maxItems": { "type": "integer", "default": 10 }
+          }
+        },
+        "author": {
+          "type": "object",
+          "properties": {
+            "required": { "type": "boolean", "default": true },
+            "placeholder": { "type": "string" }
+          }
+        },
+        "publishDate": {
+          "type": "object",
+          "properties": {
+            "required": { "type": "boolean", "default": true },
+            "format": { "type": "string", "default": "date-time" }
+          }
+        },
+        "category": {
+          "type": "object",
+          "properties": {
+            "required": { "type": "boolean", "default": false },
+            "options": { "type": "array", "items": { "type": "string" } }
+          }
+        },
+        "tags": {
+          "type": "object",
+          "properties": {
+            "required": { "type": "boolean", "default": false },
+            "minItems": { "type": "integer" },
+            "maxItems": { "type": "integer" }
+          }
+        }
+      }
+    },
+    "seo": {
+      "type": "object",
+      "description": "SEO-specific fields",
+      "properties": {
+        "metaTitle": {
+          "type": "object",
+          "properties": {
+            "maxLength": { "type": "integer", "default": 60 },
+            "includeKeyword": { "type": "boolean", "default": true }
+          }
+        },
+        "metaDescription": {
+          "type": "object",
+          "properties": {
+            "maxLength": { "type": "integer", "default": 160 },
+            "includeKeyword": { "type": "boolean", "default": true }
+          }
+        },
+        "focusKeyword": {
+          "type": "object",
+          "properties": {
+            "required": { "type": "boolean", "default": true },
+            "density": {
+              "type": "object",
+              "properties": {
+                "min": { "type": "number", "default": 0.5 },
+                "max": { "type": "number", "default": 2.5 }
+              }
+            }
+          }
+        },
+        "headings": {
+          "type": "object",
+          "properties": {
+            "h1Count": { "type": "integer", "default": 1 },
+            "h2MinCount": { "type": "integer", "default": 2 },
+            "includeKeywordInH1": { "type": "boolean", "default": true }
+          }
+        },
+        "internalLinks": {
+          "type": "object",
+          "properties": {
+            "minCount": { "type": "integer", "default": 2 }
+          }
+        },
+        "externalLinks": {
+          "type": "object",
+          "properties": {
+            "minCount": { "type": "integer", "default": 1 }
+          }
+        }
+      }
+    },
+    "formatting": {
+      "type": "object",
+      "description": "Formatting guidelines",
+      "properties": {
+        "wordCount": {
+          "type": "object",
+          "properties": {
+            "min": { "type": "integer" },
+            "max": { "type": "integer" },
+            "target": { "type": "integer" }
+          }
+        },
+        "paragraphLength": {
+          "type": "object",
+          "properties": {
+            "maxSentences": { "type": "integer", "default": 4 },
+            "maxWords": { "type": "integer", "default": 150 }
+          }
+        },
+        "sentenceLength": {
+          "type": "object",
+          "properties": {
+            "maxWords": { "type": "integer", "default": 20 }
+          }
+        },
+        "readabilityScore": {
+          "type": "object",
+          "properties": {
+            "target": { "type": "string", "enum": ["elementary", "middle_school", "high_school", "college", "professional"] },
+            "fleschKincaid": {
+              "type": "object",
+              "properties": {
+                "min": { "type": "number" },
+                "max": { "type": "number" }
+              }
+            }
+          }
+        },
+        "tone": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": ["professional", "casual", "friendly", "authoritative", "conversational", "formal", "humorous", "inspirational"]
+          }
+        }
+      }
+    },
+    "callToAction": {
+      "type": "object",
+      "description": "Call-to-action requirements",
+      "properties": {
+        "required": {
+          "type": "boolean",
+          "default": true
+        },
+        "placement": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": ["beginning", "middle", "end", "sidebar", "popup"]
+          }
+        },
+        "minCount": {
+          "type": "integer",
+          "default": 1
+        },
+        "maxCount": {
+          "type": "integer",
+          "default": 3
+        },
+        "examples": {
+          "type": "array",
+          "items": { "type": "string" }
+        }
+      }
+    },
+    "images": {
+      "type": "object",
+      "description": "Image requirements",
+      "properties": {
+        "required": {
+          "type": "boolean",
+          "default": false
+        },
+        "minCount": {
+          "type": "integer"
+        },
+        "maxCount": {
+          "type": "integer"
+        },
+        "featuredImage": {
+          "type": "object",
+          "properties": {
+            "required": { "type": "boolean", "default": true },
+            "dimensions": {
+              "type": "object",
+              "properties": {
+                "width": { "type": "integer" },
+                "height": { "type": "integer" }
+              }
+            },
+            "altTextRequired": { "type": "boolean", "default": true }
+          }
+        },
+        "formats": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": ["jpg", "png", "webp", "svg", "gif"]
+          }
+        }
+      }
+    },
+    "compliance": {
+      "type": "object",
+      "description": "Legal and compliance requirements",
+      "properties": {
+        "disclaimerRequired": {
+          "type": "boolean",
+          "default": false
+        },
+        "disclosureRequired": {
+          "type": "boolean",
+          "default": false
+        },
+        "copyrightNotice": {
+          "type": "boolean",
+          "default": false
+        },
+        "privacyPolicy": {
+          "type": "boolean",
+          "default": false
+        },
+        "unsubscribeLink": {
+          "type": "boolean",
+          "default": false,
+          "description": "Required for email templates"
+        }
+      }
+    },
+    "variables": {
+      "type": "array",
+      "description": "Template variables for personalization",
+      "items": {
+        "type": "object",
+        "required": ["name", "type"],
+        "properties": {
+          "name": {
+            "type": "string",
+            "description": "Variable name (e.g., 'firstName', 'companyName')"
+          },
+          "type": {
+            "type": "string",
+            "enum": ["string", "number", "date", "boolean", "url", "email"],
+            "description": "Variable data type"
+          },
+          "required": {
+            "type": "boolean",
+            "default": false
+          },
+          "defaultValue": {
+            "type": "string",
+            "description": "Default value if not provided"
+          },
+          "placeholder": {
+            "type": "string",
+            "description": "Placeholder text"
+          }
+        }
+      }
+    },
+    "version": {
+      "type": "string",
+      "description": "Template version"
+    },
+    "created": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Creation date"
+    },
+    "lastUpdated": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Last update date"
+    },
+    "author": {
+      "type": "string",
+      "description": "Template author"
+    },
+    "tags": {
+      "type": "array",
+      "items": { "type": "string" },
+      "description": "Template tags for categorization"
+    }
+  }
+}
+

package/augment-extensions/domain-rules/mcp/README.md

@@ -0,0 +1,150 @@
+# Model Context Protocol (MCP) Guidelines
+
+## Overview
+
+This module provides comprehensive guidelines for designing and implementing **Model Context Protocol (MCP)** systems. MCP refers to the strategies and patterns for managing context in Large Language Model (LLM) applications, including how context is stored, retrieved, compressed, and injected into prompts.
+
+## Key Benefits
+
+- **Multi-Type Coverage**: Guidelines for 6 MCP types (token, state, vector, hybrid, graph, compressed)
+- **Universal Rules**: Cross-cutting concerns (security, monitoring, testing)
+- **Configuration System**: Flexible project-level configuration
+- **Practical Examples**: Real-world implementation patterns
+- **Best Practices**: Industry-proven patterns and anti-patterns
+
+## Installation
+
+### With CLI (Future)
+```bash
+augx link domain-rules/mcp
+```
+
+### Without CLI (Current)
+1. Copy this module to your project's `.augment/` folder
+2. Reference rule files in your project's AGENTS.md
+3. Create `.augment/mcp-config.json` with your configuration
+
+## Directory Structure
+
+```
+augment-extensions/domain-rules/mcp/
+├── module.json                          # Module metadata
+├── README.md                            # This file
+├── rules/                               # Detailed guidelines
+│   ├── universal-rules.md               # Cross-cutting concerns
+│   ├── configuration.md                 # Configuration system
+│   ├── testing-validation.md            # Testing strategies
+│   ├── token-based-mcp.md               # Token-based MCP
+│   ├── state-based-mcp.md               # State-based MCP
+│   ├── vector-based-mcp.md              # Vector-based MCP (RAG)
+│   ├── hybrid-mcp.md                    # Hybrid multi-memory
+│   ├── graph-augmented-mcp.md           # Graph-augmented MCP
+│   └── compressed-mcp.md                # Compressed MCP
+└── examples/                            # Implementation examples
+    ├── token-based-example.md           # Legal contract analysis
+    ├── state-based-example.md           # Customer support agent
+    ├── vector-based-example.md          # Knowledge base Q&A
+    ├── hybrid-example.md                # Research assistant
+    ├── graph-augmented-example.md       # Supply chain analysis
+    └── compressed-example.md            # Mobile assistant
+```
+
+## MCP Types
+
+### 1. Token-Based MCP
+Manage context within token limits using compression, chunking, and budgeting.
+
+**Use Cases**: Long document analysis, legal contracts, research papers
+
+### 2. State-Based MCP
+Persist conversation state across sessions with serialization and concurrency control.
+
+**Use Cases**: Customer support, multi-turn agents, workflow automation
+
+### 3. Vector-Based MCP
+Retrieve relevant context using semantic search and embeddings (RAG).
+
+**Use Cases**: Knowledge base Q&A, documentation search, semantic retrieval
+
+### 4. Hybrid MCP
+Combine multiple memory types (token + vector + state) for complex applications.
+
+**Use Cases**: Research assistants, enterprise agents, multi-modal systems
+
+### 5. Graph-Augmented MCP
+Use knowledge graphs for structured context with entity relationships.
+
+**Use Cases**: Supply chain analysis, fraud detection, knowledge management
+
+### 6. Compressed MCP
+Apply aggressive compression for resource-constrained environments.
+
+**Use Cases**: Mobile apps, edge devices, cost-sensitive applications
+
+## Core Workflow
+
+### 1. Choose MCP Type(s)
+
+Analyze your requirements:
+- **Token limits?** → Token-based
+- **Persistent state?** → State-based
+- **Large knowledge base?** → Vector-based
+- **Complex requirements?** → Hybrid
+- **Structured knowledge?** → Graph-augmented
+- **Resource constraints?** → Compressed
+
+### 2. Configure Module
+
+Create `.augment/mcp-config.json`:
+
+```json
+{
+  "version": "1.0",
+  "mcpTypes": ["token", "vector"],
+  "strictMode": true,
+  "universalRules": true,
+  "typeSpecificConfig": {
+    "token": {
+      "maxContextWindow": 200000,
+      "compressionThreshold": 0.85
+    },
+    "vector": {
+      "embeddingModel": "voyage-3-large",
+      "topK": 10
+    }
+  }
+}
+```
+
+### 3. Apply Rules
+
+Follow type-specific guidelines from `rules/` directory:
+- Read universal rules first
+- Apply type-specific patterns
+- Implement testing strategies
+- Monitor and optimize
+
+### 4. Validate Implementation
+
+Use testing checklist from `rules/testing-validation.md`:
+- Unit tests for transformations
+- Integration tests for pipelines
+- Performance benchmarks
+- Security validation
+
+## Character Count
+
+**Total**: ~219,130 characters
+
+## Contents
+
+- **Universal Rules**: Context optimization, error handling, security, monitoring, testing, documentation
+- **Type-Specific Rules**: Detailed guidelines for each of 6 MCP types
+- **Configuration System**: JSON schema, validation, override semantics
+- **Testing Framework**: Unit, integration, synthetic testing strategies
+- **Examples**: 6 complete implementation examples with code
+
+## Version History
+
+- **1.0.0** (2026-01-29): Initial release with 6 MCP types and universal rules
+