@prmichaelsen/remember-mcp 2.3.0 → 2.3.4

package/agent/commands/acp.update.md

@@ -0,0 +1,301 @@
+# Command: update
+
+> **🤖 Agent Directive**: If you are reading this file, the command `@acp.update` has been invoked. Follow the steps below to execute this command.
+
+**Namespace**: acp
+**Version**: 1.0.0
+**Created**: 2026-02-16
+**Last Updated**: 2026-02-16
+**Status**: Active
+
+---
+
+**Purpose**: Update progress.yaml with latest project status, task completion, and recent work
+**Category**: Documentation
+**Frequency**: As Needed
+
+---
+
+## What This Command Does
+
+This command updates `agent/progress.yaml` with the latest project status. It's used after completing work to ensure progress tracking accurately reflects what's been accomplished. The command updates task statuses, milestone progress percentages, recent work entries, and next steps.
+
+Use this command when you've completed tasks, made significant progress, or need to ensure the progress tracking is current. It's particularly useful after finishing a work session or when transitioning between tasks.
+
+Unlike `@acp.sync` which updates documentation based on code changes, `@acp.update` focuses specifically on updating the progress tracking file to reflect completed work and current status.
+
+---
+
+## Prerequisites
+
+- [ ] ACP installed in project
+- [ ] `agent/progress.yaml` exists
+- [ ] Work has been completed that needs to be tracked
+- [ ] You know which tasks/milestones to update
+
+---
+
+## Steps
+
+### 1. Read Current Progress
+
+Read `agent/progress.yaml` to understand current state.
+
+**Actions**:
+- Open and parse `agent/progress.yaml`
+- Note current milestone and its progress
+- Identify tasks and their statuses
+- Review recent work entries
+- Check next steps
+
+**Expected Outcome**: Current progress state understood
+
+### 2. Identify What Changed
+
+Determine what work was completed since last update.
+
+**Actions**:
+- Review what tasks were worked on
+- Identify completed tasks
+- Note any milestone completions
+- Determine new blockers or resolved blockers
+- Identify what should be in recent work
+
+**Expected Outcome**: Changes to track are identified
+
+### 3. Update Task Statuses
+
+Update individual task statuses and completion dates.
+
+**Actions**:
+- Mark completed tasks as `completed`
+- Set `completed_date` to today's date (YYYY-MM-DD)
+- Update task notes if needed
+- Change `in_progress` tasks if no longer active
+
+**Expected Outcome**: Task statuses reflect reality
+
+### 4. Update Milestone Progress
+
+Recalculate and update milestone progress percentages.
+
+**Actions**:
+- Count tasks completed vs total tasks
+- Calculate progress percentage
+- Update `progress` field (0-100)
+- Update `tasks_completed` count
+- Set `completed` date if milestone finished
+- Update milestone status if needed
+
+**Expected Outcome**: Milestone progress is accurate
+
+### 5. Add Recent Work Entry
+
+Add entry to `recent_work` section documenting what was done.
+
+**Actions**:
+- Add new entry with today's date
+- Write clear description of work completed
+- List specific items accomplished (use ✅, 📋, ⚠️ emojis)
+- Keep entries concise but informative
+- Maintain chronological order (newest first)
+
+**Expected Outcome**: Recent work documented
+
+### 6. Update Next Steps
+
+Refresh the `next_steps` list based on current state.
+
+**Actions**:
+- Remove completed items
+- Add new next steps based on progress
+- Prioritize by importance/urgency
+- Keep list focused (3-5 items)
+- Be specific and actionable
+
+**Expected Outcome**: Next steps are current
+
+### 7. Update Blockers
+
+Update the `current_blockers` list.
+
+**Actions**:
+- Remove resolved blockers
+- Add new blockers discovered
+- Keep descriptions clear and actionable
+- Empty list if no blockers
+
+**Expected Outcome**: Blockers list is accurate
+
+### 8. Save Changes
+
+Write updated progress.yaml back to disk.
+
+**Actions**:
+- Ensure YAML formatting is correct
+- Preserve structure and indentation
+- Save file
+- Verify file was written successfully
+
+**Expected Outcome**: progress.yaml updated on disk
+
+---
+
+## Verification
+
+- [ ] progress.yaml file updated successfully
+- [ ] Task statuses reflect completed work
+- [ ] Milestone progress percentages are accurate
+- [ ] Recent work entry added with today's date
+- [ ] Next steps list is current and actionable
+- [ ] Blockers list is accurate
+- [ ] YAML syntax is valid
+- [ ] No data was lost or corrupted
+
+---
+
+## Expected Output
+
+### Files Modified
+- `agent/progress.yaml` - Updated with latest progress
+
+### Console Output
+```
+📝 Updating Progress Tracking
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+Reading current progress...
+✓ Current milestone: M2 - Documentation & Utility Commands
+✓ Progress: 40% (2/5 tasks completed)
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+Updating progress...
+✓ Marked task-5 as completed
+✓ Updated milestone progress: 40% → 60%
+✓ Added recent work entry (2026-02-16)
+✓ Updated next steps
+✓ No new blockers
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+✅ Progress Updated!
+
+Summary:
+- Tasks completed: 2 → 3
+- Milestone progress: 40% → 60%
+- Recent work: Added entry for today
+- Next: task-6 - Implement Utility Commands
+```
+
+### Status Update
+- Task statuses updated
+- Milestone progress recalculated
+- Recent work documented
+- Next steps refreshed
+
+---
+
+## Examples
+
+### Example 1: After Completing a Task
+
+**Context**: Just finished task-3, need to update progress
+
+**Invocation**: `@acp.update`
+
+**Result**: Marks task-3 as completed, updates milestone from 40% to 60%, adds recent work entry, identifies task-4 as next
+
+### Example 2: Mid-Task Progress Update
+
+**Context**: Made significant progress on task-5 but not complete
+
+**Invocation**: `@acp.update`
+
+**Result**: Adds recent work entry documenting progress, updates task notes, keeps task status as in_progress
+
+### Example 3: Milestone Completion
+
+**Context**: Just finished last task in milestone
+
+**Invocation**: `@acp.update`
+
+**Result**: Marks task and milestone as completed, sets completion dates, updates to next milestone, celebrates achievement
+
+---
+
+## Related Commands
+
+- [`@acp.status`](acp.status.md) - View current status before updating
+- [`@acp.proceed`](acp.proceed.md) - Automatically updates progress after completing tasks
+- [`@acp.sync`](acp.sync.md) - Update documentation based on code changes
+- [`@acp.report`](acp.report.md) - Generate comprehensive progress report
+
+---
+
+## Troubleshooting
+
+### Issue 1: YAML syntax error after update
+
+**Symptom**: progress.yaml has syntax errors
+
+**Cause**: Incorrect indentation or formatting
+
+**Solution**: Validate YAML syntax, fix indentation (use 2 spaces), ensure proper structure
+
+### Issue 2: Progress percentages don't match
+
+**Symptom**: Calculated percentage doesn't match tasks completed
+
+**Cause**: Math error or incorrect task count
+
+**Solution**: Recalculate: (tasks_completed / tasks_total) * 100, round to nearest integer
+
+### Issue 3: Recent work entries out of order
+
+**Symptom**: Dates not in chronological order
+
+**Cause**: New entry added in wrong position
+
+**Solution**: Ensure newest entries are first in the list, maintain reverse chronological order
+
+---
+
+## Security Considerations
+
+### File Access
+- **Reads**: `agent/progress.yaml`
+- **Writes**: `agent/progress.yaml` (updates progress tracking)
+- **Executes**: None
+
+### Network Access
+- **APIs**: None
+- **Repositories**: None
+
+### Sensitive Data
+- **Secrets**: Does not access any secrets or credentials
+- **Credentials**: Does not access any credentials
+
+---
+
+## Notes
+
+- This command only updates progress.yaml, not other documentation
+- Use `@acp.sync` to update design docs and other documentation
+- Progress percentages should be integers (0-100)
+- Recent work entries should be concise but informative
+- Keep next steps list focused (3-5 items maximum)
+- Update frequently to maintain accurate tracking
+- Can be run multiple times per day as needed
+
+---
+
+**Namespace**: acp
+**Command**: update
+**Version**: 1.0.0
+**Created**: 2026-02-16
+**Last Updated**: 2026-02-16
+**Status**: Active
+**Compatibility**: ACP 1.1.0+
+**Author**: ACP Project

package/agent/commands/acp.validate.md

@@ -0,0 +1,385 @@
+# Command: validate
+
+> **🤖 Agent Directive**: If you are reading this file, the command `@acp.validate` has been invoked. Follow the steps below to execute this command.
+
+**Namespace**: acp
+**Version**: 1.0.0
+**Created**: 2026-02-16
+**Last Updated**: 2026-02-16
+**Status**: Active
+
+---
+
+**Purpose**: Validate all ACP documents for structure, consistency, and correctness
+**Category**: Documentation
+**Frequency**: As Needed
+
+---
+
+## What This Command Does
+
+This command validates all ACP documentation to ensure it follows proper structure, maintains consistency, and contains no errors. It checks document formatting, verifies links and references, validates YAML syntax, and ensures all required sections are present.
+
+Use this command before committing documentation changes, after creating new documents, or periodically to ensure documentation quality. It's particularly useful before releases or when onboarding new contributors.
+
+Unlike `@acp.sync` which compares docs to code, `@acp.validate` checks the internal consistency and correctness of the documentation itself.
+
+---
+
+## Prerequisites
+
+- [ ] ACP installed in project
+- [ ] Documentation exists in `agent/` directory
+- [ ] You want to verify documentation quality
+
+---
+
+## Steps
+
+### 1. Validate Directory Structure
+
+Check that all required directories and files exist.
+
+**Actions**:
+- Verify `agent/` directory exists
+- Check for `agent/design/`, `agent/milestones/`, `agent/patterns/`, `agent/tasks/`
+- Verify `agent/progress.yaml` exists
+- Check for `agent/commands/` directory
+- Note any missing directories
+
+**Expected Outcome**: Directory structure validated
+
+### 2. Validate progress.yaml
+
+Check YAML syntax and required fields.
+
+**Actions**:
+- Parse `agent/progress.yaml` as YAML
+- Verify required fields exist (project, milestones, tasks)
+- Check field types (strings, numbers, dates)
+- Validate date formats (YYYY-MM-DD)
+- Verify progress percentages (0-100)
+- Check milestone/task references are consistent
+- Validate status values (not_started, in_progress, completed)
+
+**Expected Outcome**: progress.yaml is valid
+
+### 3. Validate Design Documents
+
+Check design document structure and content.
+
+**Actions**:
+- Read all files in `agent/design/`
+- Verify required sections exist (Overview, Problem, Solution)
+- Check for proper markdown formatting
+- Validate code blocks have language tags
+- Verify dates are in correct format
+- Check status values are valid
+- Ensure no broken internal links
+
+**Expected Outcome**: Design docs are well-formed
+
+### 4. Validate Milestone Documents
+
+Check milestone document structure.
+
+**Actions**:
+- Read all files in `agent/milestones/`
+- Verify required sections (Overview, Deliverables, Success Criteria)
+- Check naming convention (milestone-N-name.md)
+- Validate task references exist
+- Verify success criteria are checkboxes
+- Check for proper formatting
+
+**Expected Outcome**: Milestone docs are valid
+
+### 5. Validate Task Documents
+
+Check task document structure.
+
+**Actions**:
+- Read all files in `agent/tasks/`
+- Verify required sections (Objective, Steps, Verification)
+- Check naming convention (task-N-name.md)
+- Validate milestone references
+- Verify verification items are checkboxes
+- Check for proper formatting
+
+**Expected Outcome**: Task docs are valid
+
+### 6. Validate Pattern Documents
+
+Check pattern document structure.
+
+**Actions**:
+- Read all files in `agent/patterns/`
+- Verify required sections (Overview, Implementation, Examples)
+- Check code examples are properly formatted
+- Validate examples have language tags
+- Verify no broken links
+
+**Expected Outcome**: Pattern docs are valid
+
+### 7. Validate Command Documents
+
+Check command document structure.
+
+**Actions**:
+- Read all files in `agent/commands/`
+- Verify required sections (Purpose, Steps, Verification)
+- Check agent directive is present
+- Validate namespace and version fields
+- Verify examples are complete
+- Check related commands links work
+
+**Expected Outcome**: Command docs are valid
+
+### 8. Check Cross-References
+
+Validate links between documents.
+
+**Actions**:
+- Extract all internal links from documents
+- Verify linked files exist
+- Check milestone → task references
+- Verify task → milestone back-references
+- Validate command → command links
+- Note any broken links
+
+**Expected Outcome**: All links are valid
+
+### 9. Generate Validation Report
+
+Summarize validation results.
+
+**Actions**:
+- Count total documents validated
+- List any errors found
+- List any warnings
+- Provide recommendations
+- Suggest fixes for issues
+
+**Expected Outcome**: Validation report generated
+
+---
+
+## Verification
+
+- [ ] All required directories exist
+- [ ] progress.yaml is valid YAML
+- [ ] progress.yaml has all required fields
+- [ ] All design documents are well-formed
+- [ ] All milestone documents are valid
+- [ ] All task documents are valid
+- [ ] All pattern documents are valid
+- [ ] All command documents are valid
+- [ ] No broken internal links
+- [ ] Validation report generated
+
+---
+
+## Expected Output
+
+### Files Modified
+None - this is a read-only validation command
+
+### Console Output
+```
+✓ Validating ACP Documentation
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+Directory Structure:
+✓ agent/ directory exists
+✓ agent/design/ exists (5 files)
+✓ agent/milestones/ exists (2 files)
+✓ agent/patterns/ exists (3 files)
+✓ agent/tasks/ exists (7 files)
+✓ agent/commands/ exists (11 files)
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+progress.yaml:
+✓ Valid YAML syntax
+✓ All required fields present
+✓ Date formats correct
+✓ Progress percentages valid (0-100)
+✓ Status values valid
+✓ Task/milestone references consistent
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+Design Documents (5):
+✓ All have required sections
+✓ Markdown formatting correct
+✓ Code blocks properly tagged
+⚠️  auth-design.md: Missing "Last Updated" date
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+Milestone Documents (2):
+✓ All have required sections
+✓ Naming convention followed
+✓ Task references valid
+✓ Success criteria are checkboxes
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+Task Documents (7):
+✓ All have required sections
+✓ Naming convention followed
+✓ Milestone references valid
+✓ Verification items are checkboxes
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+Pattern Documents (3):
+✓ All have required sections
+✓ Code examples properly formatted
+✓ No broken links
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+Command Documents (11):
+✓ All have required sections
+✓ Agent directives present
+✓ Namespace and version fields valid
+✓ Examples complete
+✓ Related command links valid
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+Cross-References:
+✓ All internal links valid
+✓ Milestone → task references correct
+✓ Task → milestone back-references correct
+✓ Command → command links work
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+✅ Validation Complete!
+
+Summary:
+- Documents validated: 28
+- Errors: 0
+- Warnings: 1
+- Overall: PASS
+
+Warnings:
+⚠️  auth-design.md: Missing "Last Updated" date
+
+Recommendations:
+- Add "Last Updated" date to auth-design.md
+- Consider adding more code examples to patterns
+```
+
+### Status Update
+- Validation completed
+- Issues identified (if any)
+- Documentation quality confirmed
+
+---
+
+## Examples
+
+### Example 1: Before Committing Changes
+
+**Context**: Made changes to several docs, want to verify before commit
+
+**Invocation**: `@acp.validate`
+
+**Result**: Validates all docs, finds 2 broken links, reports them, you fix them before committing
+
+### Example 2: After Creating New Documents
+
+**Context**: Created 3 new design documents
+
+**Invocation**: `@acp.validate`
+
+**Result**: Validates new docs, confirms they follow proper structure, identifies missing section in one doc
+
+### Example 3: Periodic Quality Check
+
+**Context**: Monthly documentation review
+
+**Invocation**: `@acp.validate`
+
+**Result**: Validates all 50+ documents, finds minor formatting issues in 3 files, overall quality is good
+
+---
+
+## Related Commands
+
+- [`@acp.sync`](acp.sync.md) - Sync documentation with code (different from validation)
+- [`@acp.update`](acp.update.md) - Update progress tracking
+- [`@acp.report`](acp.report.md) - Generate comprehensive report including validation results
+- [`@acp.init`](acp.init.md) - Can include validation as part of initialization
+
+---
+
+## Troubleshooting
+
+### Issue 1: YAML parsing errors
+
+**Symptom**: progress.yaml fails to parse
+
+**Cause**: Invalid YAML syntax (indentation, special characters)
+
+**Solution**: Use YAML validator, check indentation (2 spaces), quote strings with special characters
+
+### Issue 2: Many broken links reported
+
+**Symptom**: Validation finds numerous broken links
+
+**Cause**: Files were moved or renamed
+
+**Solution**: Update links to reflect new file locations, use relative paths, verify files exist
+
+### Issue 3: Validation takes too long
+
+**Symptom**: Command runs for several minutes
+
+**Cause**: Very large project with many documents
+
+**Solution**: This is normal for large projects, consider validating specific directories only, run less frequently
+
+---
+
+## Security Considerations
+
+### File Access
+- **Reads**: All files in `agent/` directory
+- **Writes**: None (read-only validation)
+- **Executes**: None
+
+### Network Access
+- **APIs**: None
+- **Repositories**: None
+
+### Sensitive Data
+- **Secrets**: Does not access secrets or credentials
+- **Credentials**: Does not access credentials files
+
+---
+
+## Notes
+
+- This is a read-only command - it doesn't modify files
+- Validation should be fast (< 30 seconds for most projects)
+- Run before committing documentation changes
+- Integrate into CI/CD pipeline if desired
+- Warnings are informational, not failures
+- Errors should be fixed before proceeding
+- Consider running after major documentation updates
+- Can be automated as a pre-commit hook
+
+---
+
+**Namespace**: acp
+**Command**: validate
+**Version**: 1.0.0
+**Created**: 2026-02-16
+**Last Updated**: 2026-02-16
+**Status**: Active
+**Compatibility**: ACP 1.1.0+
+**Author**: ACP Project