@prmichaelsen/task-mcp 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.env.example +19 -0
- package/AGENT.md +1165 -0
- package/CHANGELOG.md +72 -0
- package/agent/commands/acp.commit.md +511 -0
- package/agent/commands/acp.init.md +376 -0
- package/agent/commands/acp.package-install.md +347 -0
- package/agent/commands/acp.proceed.md +311 -0
- package/agent/commands/acp.report.md +392 -0
- package/agent/commands/acp.status.md +280 -0
- package/agent/commands/acp.sync.md +323 -0
- package/agent/commands/acp.update.md +301 -0
- package/agent/commands/acp.validate.md +385 -0
- package/agent/commands/acp.version-check-for-updates.md +275 -0
- package/agent/commands/acp.version-check.md +190 -0
- package/agent/commands/acp.version-update.md +288 -0
- package/agent/commands/command.template.md +273 -0
- package/agent/commands/git.commit.md +511 -0
- package/agent/commands/git.init.md +513 -0
- package/agent/design/.gitkeep +0 -0
- package/agent/design/acp-task-execution-requirements.md +555 -0
- package/agent/design/api-dto-design.md +394 -0
- package/agent/design/code-extraction-guide.md +827 -0
- package/agent/design/design.template.md +136 -0
- package/agent/design/requirements.template.md +387 -0
- package/agent/design/rest-api-integration.md +489 -0
- package/agent/design/sdk-export-requirements.md +549 -0
- package/agent/milestones/.gitkeep +0 -0
- package/agent/milestones/milestone-1-{title}.template.md +206 -0
- package/agent/milestones/milestone-2-task-infrastructure.md +232 -0
- package/agent/milestones/milestone-4-autonomous-execution.md +235 -0
- package/agent/patterns/.gitkeep +0 -0
- package/agent/patterns/bootstrap.md +1271 -0
- package/agent/patterns/bootstrap.template.md +1237 -0
- package/agent/patterns/pattern.template.md +364 -0
- package/agent/progress.template.yaml +158 -0
- package/agent/progress.yaml +375 -0
- package/agent/scripts/check-for-updates.sh +88 -0
- package/agent/scripts/install.sh +157 -0
- package/agent/scripts/uninstall.sh +75 -0
- package/agent/scripts/update.sh +139 -0
- package/agent/scripts/version.sh +35 -0
- package/agent/tasks/.gitkeep +0 -0
- package/agent/tasks/task-1-{title}.template.md +225 -0
- package/agent/tasks/task-86-task-data-model-schemas.md +143 -0
- package/agent/tasks/task-87-task-database-service.md +220 -0
- package/agent/tasks/task-88-firebase-client-wrapper.md +139 -0
- package/agent/tasks/task-88-task-execution-engine.md +277 -0
- package/agent/tasks/task-89-mcp-server-implementation.md +197 -0
- package/agent/tasks/task-90-build-configuration.md +146 -0
- package/agent/tasks/task-91-deployment-configuration.md +128 -0
- package/coverage/base.css +224 -0
- package/coverage/block-navigation.js +87 -0
- package/coverage/favicon.png +0 -0
- package/coverage/index.html +191 -0
- package/coverage/lcov-report/base.css +224 -0
- package/coverage/lcov-report/block-navigation.js +87 -0
- package/coverage/lcov-report/favicon.png +0 -0
- package/coverage/lcov-report/index.html +191 -0
- package/coverage/lcov-report/prettify.css +1 -0
- package/coverage/lcov-report/prettify.js +2 -0
- package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
- package/coverage/lcov-report/sorter.js +210 -0
- package/coverage/lcov-report/src/client.ts.html +1030 -0
- package/coverage/lcov-report/src/constant/collections.ts.html +469 -0
- package/coverage/lcov-report/src/constant/index.html +116 -0
- package/coverage/lcov-report/src/dto/index.html +116 -0
- package/coverage/lcov-report/src/dto/transformers.ts.html +568 -0
- package/coverage/lcov-report/src/index.html +146 -0
- package/coverage/lcov-report/src/schemas/index.html +116 -0
- package/coverage/lcov-report/src/schemas/task.ts.html +547 -0
- package/coverage/lcov-report/src/server-factory.ts.html +418 -0
- package/coverage/lcov-report/src/server.ts.html +289 -0
- package/coverage/lcov-report/src/services/index.html +116 -0
- package/coverage/lcov-report/src/services/task-database.service.ts.html +1495 -0
- package/coverage/lcov-report/src/tools/index.html +236 -0
- package/coverage/lcov-report/src/tools/index.ts.html +292 -0
- package/coverage/lcov-report/src/tools/task-add-message.ts.html +277 -0
- package/coverage/lcov-report/src/tools/task-complete-task-item.ts.html +343 -0
- package/coverage/lcov-report/src/tools/task-create-milestone.ts.html +286 -0
- package/coverage/lcov-report/src/tools/task-create-task-item.ts.html +358 -0
- package/coverage/lcov-report/src/tools/task-get-next-step.ts.html +460 -0
- package/coverage/lcov-report/src/tools/task-get-status.ts.html +316 -0
- package/coverage/lcov-report/src/tools/task-report-completion.ts.html +343 -0
- package/coverage/lcov-report/src/tools/task-update-progress.ts.html +232 -0
- package/coverage/lcov.info +974 -0
- package/coverage/prettify.css +1 -0
- package/coverage/prettify.js +2 -0
- package/coverage/sort-arrow-sprite.png +0 -0
- package/coverage/sorter.js +210 -0
- package/coverage/src/client.ts.html +1030 -0
- package/coverage/src/constant/collections.ts.html +469 -0
- package/coverage/src/constant/index.html +116 -0
- package/coverage/src/dto/index.html +116 -0
- package/coverage/src/dto/transformers.ts.html +568 -0
- package/coverage/src/index.html +146 -0
- package/coverage/src/schemas/index.html +116 -0
- package/coverage/src/schemas/task.ts.html +547 -0
- package/coverage/src/server-factory.ts.html +418 -0
- package/coverage/src/server.ts.html +289 -0
- package/coverage/src/services/index.html +116 -0
- package/coverage/src/services/task-database.service.ts.html +1495 -0
- package/coverage/src/tools/index.html +236 -0
- package/coverage/src/tools/index.ts.html +292 -0
- package/coverage/src/tools/task-add-message.ts.html +277 -0
- package/coverage/src/tools/task-complete-task-item.ts.html +343 -0
- package/coverage/src/tools/task-create-milestone.ts.html +286 -0
- package/coverage/src/tools/task-create-task-item.ts.html +358 -0
- package/coverage/src/tools/task-get-next-step.ts.html +460 -0
- package/coverage/src/tools/task-get-status.ts.html +316 -0
- package/coverage/src/tools/task-report-completion.ts.html +343 -0
- package/coverage/src/tools/task-update-progress.ts.html +232 -0
- package/firestore.rules +95 -0
- package/jest.config.js +31 -0
- package/package.json +67 -0
- package/src/client.spec.ts +199 -0
- package/src/client.ts +315 -0
- package/src/constant/collections.ts +128 -0
- package/src/dto/index.ts +47 -0
- package/src/dto/task-api.dto.ts +219 -0
- package/src/dto/transformers.spec.ts +462 -0
- package/src/dto/transformers.ts +161 -0
- package/src/schemas/task.ts +154 -0
- package/src/server-factory.spec.ts +70 -0
- package/src/server-factory.ts +111 -0
- package/src/server.ts +68 -0
- package/src/services/task-database.service.e2e.ts +116 -0
- package/src/services/task-database.service.spec.ts +479 -0
- package/src/services/task-database.service.ts +470 -0
- package/src/test-schemas.ts +161 -0
- package/src/tools/index.ts +69 -0
- package/src/tools/task-add-message.ts +64 -0
- package/src/tools/task-complete-task-item.ts +86 -0
- package/src/tools/task-create-milestone.ts +67 -0
- package/src/tools/task-create-task-item.ts +91 -0
- package/src/tools/task-get-next-step.spec.ts +136 -0
- package/src/tools/task-get-next-step.ts +125 -0
- package/src/tools/task-get-status.spec.ts +213 -0
- package/src/tools/task-get-status.ts +77 -0
- package/src/tools/task-report-completion.ts +86 -0
- package/src/tools/task-update-progress.ts +49 -0
- package/src/tools/tools.spec.ts +194 -0
- package/tsconfig.json +31 -0
|
@@ -0,0 +1,385 @@
|
|
|
1
|
+
# Command: validate
|
|
2
|
+
|
|
3
|
+
> **🤖 Agent Directive**: If you are reading this file, the command `@acp.validate` has been invoked. Follow the steps below to execute this command.
|
|
4
|
+
|
|
5
|
+
**Namespace**: acp
|
|
6
|
+
**Version**: 1.0.0
|
|
7
|
+
**Created**: 2026-02-16
|
|
8
|
+
**Last Updated**: 2026-02-16
|
|
9
|
+
**Status**: Active
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
**Purpose**: Validate all ACP documents for structure, consistency, and correctness
|
|
14
|
+
**Category**: Documentation
|
|
15
|
+
**Frequency**: As Needed
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## What This Command Does
|
|
20
|
+
|
|
21
|
+
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.
|
|
22
|
+
|
|
23
|
+
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.
|
|
24
|
+
|
|
25
|
+
Unlike `@acp.sync` which compares docs to code, `@acp.validate` checks the internal consistency and correctness of the documentation itself.
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## Prerequisites
|
|
30
|
+
|
|
31
|
+
- [ ] ACP installed in project
|
|
32
|
+
- [ ] Documentation exists in `agent/` directory
|
|
33
|
+
- [ ] You want to verify documentation quality
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## Steps
|
|
38
|
+
|
|
39
|
+
### 1. Validate Directory Structure
|
|
40
|
+
|
|
41
|
+
Check that all required directories and files exist.
|
|
42
|
+
|
|
43
|
+
**Actions**:
|
|
44
|
+
- Verify `agent/` directory exists
|
|
45
|
+
- Check for `agent/design/`, `agent/milestones/`, `agent/patterns/`, `agent/tasks/`
|
|
46
|
+
- Verify `agent/progress.yaml` exists
|
|
47
|
+
- Check for `agent/commands/` directory
|
|
48
|
+
- Note any missing directories
|
|
49
|
+
|
|
50
|
+
**Expected Outcome**: Directory structure validated
|
|
51
|
+
|
|
52
|
+
### 2. Validate progress.yaml
|
|
53
|
+
|
|
54
|
+
Check YAML syntax and required fields.
|
|
55
|
+
|
|
56
|
+
**Actions**:
|
|
57
|
+
- Parse `agent/progress.yaml` as YAML
|
|
58
|
+
- Verify required fields exist (project, milestones, tasks)
|
|
59
|
+
- Check field types (strings, numbers, dates)
|
|
60
|
+
- Validate date formats (YYYY-MM-DD)
|
|
61
|
+
- Verify progress percentages (0-100)
|
|
62
|
+
- Check milestone/task references are consistent
|
|
63
|
+
- Validate status values (not_started, in_progress, completed)
|
|
64
|
+
|
|
65
|
+
**Expected Outcome**: progress.yaml is valid
|
|
66
|
+
|
|
67
|
+
### 3. Validate Design Documents
|
|
68
|
+
|
|
69
|
+
Check design document structure and content.
|
|
70
|
+
|
|
71
|
+
**Actions**:
|
|
72
|
+
- Read all files in `agent/design/`
|
|
73
|
+
- Verify required sections exist (Overview, Problem, Solution)
|
|
74
|
+
- Check for proper markdown formatting
|
|
75
|
+
- Validate code blocks have language tags
|
|
76
|
+
- Verify dates are in correct format
|
|
77
|
+
- Check status values are valid
|
|
78
|
+
- Ensure no broken internal links
|
|
79
|
+
|
|
80
|
+
**Expected Outcome**: Design docs are well-formed
|
|
81
|
+
|
|
82
|
+
### 4. Validate Milestone Documents
|
|
83
|
+
|
|
84
|
+
Check milestone document structure.
|
|
85
|
+
|
|
86
|
+
**Actions**:
|
|
87
|
+
- Read all files in `agent/milestones/`
|
|
88
|
+
- Verify required sections (Overview, Deliverables, Success Criteria)
|
|
89
|
+
- Check naming convention (milestone-N-name.md)
|
|
90
|
+
- Validate task references exist
|
|
91
|
+
- Verify success criteria are checkboxes
|
|
92
|
+
- Check for proper formatting
|
|
93
|
+
|
|
94
|
+
**Expected Outcome**: Milestone docs are valid
|
|
95
|
+
|
|
96
|
+
### 5. Validate Task Documents
|
|
97
|
+
|
|
98
|
+
Check task document structure.
|
|
99
|
+
|
|
100
|
+
**Actions**:
|
|
101
|
+
- Read all files in `agent/tasks/`
|
|
102
|
+
- Verify required sections (Objective, Steps, Verification)
|
|
103
|
+
- Check naming convention (task-N-name.md)
|
|
104
|
+
- Validate milestone references
|
|
105
|
+
- Verify verification items are checkboxes
|
|
106
|
+
- Check for proper formatting
|
|
107
|
+
|
|
108
|
+
**Expected Outcome**: Task docs are valid
|
|
109
|
+
|
|
110
|
+
### 6. Validate Pattern Documents
|
|
111
|
+
|
|
112
|
+
Check pattern document structure.
|
|
113
|
+
|
|
114
|
+
**Actions**:
|
|
115
|
+
- Read all files in `agent/patterns/`
|
|
116
|
+
- Verify required sections (Overview, Implementation, Examples)
|
|
117
|
+
- Check code examples are properly formatted
|
|
118
|
+
- Validate examples have language tags
|
|
119
|
+
- Verify no broken links
|
|
120
|
+
|
|
121
|
+
**Expected Outcome**: Pattern docs are valid
|
|
122
|
+
|
|
123
|
+
### 7. Validate Command Documents
|
|
124
|
+
|
|
125
|
+
Check command document structure.
|
|
126
|
+
|
|
127
|
+
**Actions**:
|
|
128
|
+
- Read all files in `agent/commands/`
|
|
129
|
+
- Verify required sections (Purpose, Steps, Verification)
|
|
130
|
+
- Check agent directive is present
|
|
131
|
+
- Validate namespace and version fields
|
|
132
|
+
- Verify examples are complete
|
|
133
|
+
- Check related commands links work
|
|
134
|
+
|
|
135
|
+
**Expected Outcome**: Command docs are valid
|
|
136
|
+
|
|
137
|
+
### 8. Check Cross-References
|
|
138
|
+
|
|
139
|
+
Validate links between documents.
|
|
140
|
+
|
|
141
|
+
**Actions**:
|
|
142
|
+
- Extract all internal links from documents
|
|
143
|
+
- Verify linked files exist
|
|
144
|
+
- Check milestone → task references
|
|
145
|
+
- Verify task → milestone back-references
|
|
146
|
+
- Validate command → command links
|
|
147
|
+
- Note any broken links
|
|
148
|
+
|
|
149
|
+
**Expected Outcome**: All links are valid
|
|
150
|
+
|
|
151
|
+
### 9. Generate Validation Report
|
|
152
|
+
|
|
153
|
+
Summarize validation results.
|
|
154
|
+
|
|
155
|
+
**Actions**:
|
|
156
|
+
- Count total documents validated
|
|
157
|
+
- List any errors found
|
|
158
|
+
- List any warnings
|
|
159
|
+
- Provide recommendations
|
|
160
|
+
- Suggest fixes for issues
|
|
161
|
+
|
|
162
|
+
**Expected Outcome**: Validation report generated
|
|
163
|
+
|
|
164
|
+
---
|
|
165
|
+
|
|
166
|
+
## Verification
|
|
167
|
+
|
|
168
|
+
- [ ] All required directories exist
|
|
169
|
+
- [ ] progress.yaml is valid YAML
|
|
170
|
+
- [ ] progress.yaml has all required fields
|
|
171
|
+
- [ ] All design documents are well-formed
|
|
172
|
+
- [ ] All milestone documents are valid
|
|
173
|
+
- [ ] All task documents are valid
|
|
174
|
+
- [ ] All pattern documents are valid
|
|
175
|
+
- [ ] All command documents are valid
|
|
176
|
+
- [ ] No broken internal links
|
|
177
|
+
- [ ] Validation report generated
|
|
178
|
+
|
|
179
|
+
---
|
|
180
|
+
|
|
181
|
+
## Expected Output
|
|
182
|
+
|
|
183
|
+
### Files Modified
|
|
184
|
+
None - this is a read-only validation command
|
|
185
|
+
|
|
186
|
+
### Console Output
|
|
187
|
+
```
|
|
188
|
+
✓ Validating ACP Documentation
|
|
189
|
+
|
|
190
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
191
|
+
|
|
192
|
+
Directory Structure:
|
|
193
|
+
✓ agent/ directory exists
|
|
194
|
+
✓ agent/design/ exists (5 files)
|
|
195
|
+
✓ agent/milestones/ exists (2 files)
|
|
196
|
+
✓ agent/patterns/ exists (3 files)
|
|
197
|
+
✓ agent/tasks/ exists (7 files)
|
|
198
|
+
✓ agent/commands/ exists (11 files)
|
|
199
|
+
|
|
200
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
201
|
+
|
|
202
|
+
progress.yaml:
|
|
203
|
+
✓ Valid YAML syntax
|
|
204
|
+
✓ All required fields present
|
|
205
|
+
✓ Date formats correct
|
|
206
|
+
✓ Progress percentages valid (0-100)
|
|
207
|
+
✓ Status values valid
|
|
208
|
+
✓ Task/milestone references consistent
|
|
209
|
+
|
|
210
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
211
|
+
|
|
212
|
+
Design Documents (5):
|
|
213
|
+
✓ All have required sections
|
|
214
|
+
✓ Markdown formatting correct
|
|
215
|
+
✓ Code blocks properly tagged
|
|
216
|
+
⚠️ auth-design.md: Missing "Last Updated" date
|
|
217
|
+
|
|
218
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
219
|
+
|
|
220
|
+
Milestone Documents (2):
|
|
221
|
+
✓ All have required sections
|
|
222
|
+
✓ Naming convention followed
|
|
223
|
+
✓ Task references valid
|
|
224
|
+
✓ Success criteria are checkboxes
|
|
225
|
+
|
|
226
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
227
|
+
|
|
228
|
+
Task Documents (7):
|
|
229
|
+
✓ All have required sections
|
|
230
|
+
✓ Naming convention followed
|
|
231
|
+
✓ Milestone references valid
|
|
232
|
+
✓ Verification items are checkboxes
|
|
233
|
+
|
|
234
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
235
|
+
|
|
236
|
+
Pattern Documents (3):
|
|
237
|
+
✓ All have required sections
|
|
238
|
+
✓ Code examples properly formatted
|
|
239
|
+
✓ No broken links
|
|
240
|
+
|
|
241
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
242
|
+
|
|
243
|
+
Command Documents (11):
|
|
244
|
+
✓ All have required sections
|
|
245
|
+
✓ Agent directives present
|
|
246
|
+
✓ Namespace and version fields valid
|
|
247
|
+
✓ Examples complete
|
|
248
|
+
✓ Related command links valid
|
|
249
|
+
|
|
250
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
251
|
+
|
|
252
|
+
Cross-References:
|
|
253
|
+
✓ All internal links valid
|
|
254
|
+
✓ Milestone → task references correct
|
|
255
|
+
✓ Task → milestone back-references correct
|
|
256
|
+
✓ Command → command links work
|
|
257
|
+
|
|
258
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
259
|
+
|
|
260
|
+
✅ Validation Complete!
|
|
261
|
+
|
|
262
|
+
Summary:
|
|
263
|
+
- Documents validated: 28
|
|
264
|
+
- Errors: 0
|
|
265
|
+
- Warnings: 1
|
|
266
|
+
- Overall: PASS
|
|
267
|
+
|
|
268
|
+
Warnings:
|
|
269
|
+
⚠️ auth-design.md: Missing "Last Updated" date
|
|
270
|
+
|
|
271
|
+
Recommendations:
|
|
272
|
+
- Add "Last Updated" date to auth-design.md
|
|
273
|
+
- Consider adding more code examples to patterns
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
### Status Update
|
|
277
|
+
- Validation completed
|
|
278
|
+
- Issues identified (if any)
|
|
279
|
+
- Documentation quality confirmed
|
|
280
|
+
|
|
281
|
+
---
|
|
282
|
+
|
|
283
|
+
## Examples
|
|
284
|
+
|
|
285
|
+
### Example 1: Before Committing Changes
|
|
286
|
+
|
|
287
|
+
**Context**: Made changes to several docs, want to verify before commit
|
|
288
|
+
|
|
289
|
+
**Invocation**: `@acp.validate`
|
|
290
|
+
|
|
291
|
+
**Result**: Validates all docs, finds 2 broken links, reports them, you fix them before committing
|
|
292
|
+
|
|
293
|
+
### Example 2: After Creating New Documents
|
|
294
|
+
|
|
295
|
+
**Context**: Created 3 new design documents
|
|
296
|
+
|
|
297
|
+
**Invocation**: `@acp.validate`
|
|
298
|
+
|
|
299
|
+
**Result**: Validates new docs, confirms they follow proper structure, identifies missing section in one doc
|
|
300
|
+
|
|
301
|
+
### Example 3: Periodic Quality Check
|
|
302
|
+
|
|
303
|
+
**Context**: Monthly documentation review
|
|
304
|
+
|
|
305
|
+
**Invocation**: `@acp.validate`
|
|
306
|
+
|
|
307
|
+
**Result**: Validates all 50+ documents, finds minor formatting issues in 3 files, overall quality is good
|
|
308
|
+
|
|
309
|
+
---
|
|
310
|
+
|
|
311
|
+
## Related Commands
|
|
312
|
+
|
|
313
|
+
- [`@acp.sync`](acp.sync.md) - Sync documentation with code (different from validation)
|
|
314
|
+
- [`@acp.update`](acp.update.md) - Update progress tracking
|
|
315
|
+
- [`@acp.report`](acp.report.md) - Generate comprehensive report including validation results
|
|
316
|
+
- [`@acp.init`](acp.init.md) - Can include validation as part of initialization
|
|
317
|
+
|
|
318
|
+
---
|
|
319
|
+
|
|
320
|
+
## Troubleshooting
|
|
321
|
+
|
|
322
|
+
### Issue 1: YAML parsing errors
|
|
323
|
+
|
|
324
|
+
**Symptom**: progress.yaml fails to parse
|
|
325
|
+
|
|
326
|
+
**Cause**: Invalid YAML syntax (indentation, special characters)
|
|
327
|
+
|
|
328
|
+
**Solution**: Use YAML validator, check indentation (2 spaces), quote strings with special characters
|
|
329
|
+
|
|
330
|
+
### Issue 2: Many broken links reported
|
|
331
|
+
|
|
332
|
+
**Symptom**: Validation finds numerous broken links
|
|
333
|
+
|
|
334
|
+
**Cause**: Files were moved or renamed
|
|
335
|
+
|
|
336
|
+
**Solution**: Update links to reflect new file locations, use relative paths, verify files exist
|
|
337
|
+
|
|
338
|
+
### Issue 3: Validation takes too long
|
|
339
|
+
|
|
340
|
+
**Symptom**: Command runs for several minutes
|
|
341
|
+
|
|
342
|
+
**Cause**: Very large project with many documents
|
|
343
|
+
|
|
344
|
+
**Solution**: This is normal for large projects, consider validating specific directories only, run less frequently
|
|
345
|
+
|
|
346
|
+
---
|
|
347
|
+
|
|
348
|
+
## Security Considerations
|
|
349
|
+
|
|
350
|
+
### File Access
|
|
351
|
+
- **Reads**: All files in `agent/` directory
|
|
352
|
+
- **Writes**: None (read-only validation)
|
|
353
|
+
- **Executes**: None
|
|
354
|
+
|
|
355
|
+
### Network Access
|
|
356
|
+
- **APIs**: None
|
|
357
|
+
- **Repositories**: None
|
|
358
|
+
|
|
359
|
+
### Sensitive Data
|
|
360
|
+
- **Secrets**: Does not access secrets or credentials
|
|
361
|
+
- **Credentials**: Does not access credentials files
|
|
362
|
+
|
|
363
|
+
---
|
|
364
|
+
|
|
365
|
+
## Notes
|
|
366
|
+
|
|
367
|
+
- This is a read-only command - it doesn't modify files
|
|
368
|
+
- Validation should be fast (< 30 seconds for most projects)
|
|
369
|
+
- Run before committing documentation changes
|
|
370
|
+
- Integrate into CI/CD pipeline if desired
|
|
371
|
+
- Warnings are informational, not failures
|
|
372
|
+
- Errors should be fixed before proceeding
|
|
373
|
+
- Consider running after major documentation updates
|
|
374
|
+
- Can be automated as a pre-commit hook
|
|
375
|
+
|
|
376
|
+
---
|
|
377
|
+
|
|
378
|
+
**Namespace**: acp
|
|
379
|
+
**Command**: validate
|
|
380
|
+
**Version**: 1.0.0
|
|
381
|
+
**Created**: 2026-02-16
|
|
382
|
+
**Last Updated**: 2026-02-16
|
|
383
|
+
**Status**: Active
|
|
384
|
+
**Compatibility**: ACP 1.1.0+
|
|
385
|
+
**Author**: ACP Project
|
|
@@ -0,0 +1,275 @@
|
|
|
1
|
+
# Command: version-check-for-updates
|
|
2
|
+
|
|
3
|
+
> **🤖 Agent Directive**: If you are reading this file, the command `@acp-version-check-for-updates` has been invoked. Follow the steps below to execute this command.
|
|
4
|
+
|
|
5
|
+
**Namespace**: acp
|
|
6
|
+
**Version**: 1.0.0
|
|
7
|
+
**Created**: 2026-02-16
|
|
8
|
+
**Last Updated**: 2026-02-16
|
|
9
|
+
**Status**: Active
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
**Purpose**: Check if newer version of ACP is available without applying updates
|
|
14
|
+
**Category**: Maintenance
|
|
15
|
+
**Frequency**: Per Session
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## What This Command Does
|
|
20
|
+
|
|
21
|
+
This command checks if a newer version of ACP is available by running the update check script. It's a non-destructive operation that only reports whether updates exist and what changed, without modifying any files.
|
|
22
|
+
|
|
23
|
+
Use this command at the start of sessions (it's part of `@acp-init`) or when you want to see if improvements are available. It shows what's new via the CHANGELOG and lets you decide whether to update.
|
|
24
|
+
|
|
25
|
+
Unlike `@acp-version-update` which applies updates immediately, this command only checks and reports, giving you control over when to update.
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## Prerequisites
|
|
30
|
+
|
|
31
|
+
- [ ] ACP installed in project
|
|
32
|
+
- [ ] `agent/scripts/check-for-updates.sh` exists
|
|
33
|
+
- [ ] Internet connection available
|
|
34
|
+
- [ ] Git installed
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## Steps
|
|
39
|
+
|
|
40
|
+
### 1. Run Update Check Script
|
|
41
|
+
|
|
42
|
+
Execute the check-for-updates script.
|
|
43
|
+
|
|
44
|
+
**Actions**:
|
|
45
|
+
- Check if `./agent/scripts/check-for-updates.sh` exists
|
|
46
|
+
- If exists, run the script
|
|
47
|
+
- If doesn't exist, report that update checking is unavailable
|
|
48
|
+
- Capture script output
|
|
49
|
+
|
|
50
|
+
**Expected Outcome**: Update status determined
|
|
51
|
+
|
|
52
|
+
### 2. Parse Script Output
|
|
53
|
+
|
|
54
|
+
Interpret the results from the update check.
|
|
55
|
+
|
|
56
|
+
**Actions**:
|
|
57
|
+
- Check if updates are available
|
|
58
|
+
- Extract available version number (if updates exist)
|
|
59
|
+
- Note if already up to date
|
|
60
|
+
- Handle any errors from script
|
|
61
|
+
|
|
62
|
+
**Expected Outcome**: Update status understood
|
|
63
|
+
|
|
64
|
+
### 3. Display Update Status
|
|
65
|
+
|
|
66
|
+
Show whether updates are available.
|
|
67
|
+
|
|
68
|
+
**Actions**:
|
|
69
|
+
- If up to date: Display success message
|
|
70
|
+
- If updates available: Show new version number
|
|
71
|
+
- Display current version for comparison
|
|
72
|
+
- Show update availability clearly
|
|
73
|
+
|
|
74
|
+
**Expected Outcome**: User knows if updates exist
|
|
75
|
+
|
|
76
|
+
### 4. Show What Changed
|
|
77
|
+
|
|
78
|
+
If updates are available, display changelog.
|
|
79
|
+
|
|
80
|
+
**Actions**:
|
|
81
|
+
- Fetch CHANGELOG from repository
|
|
82
|
+
- Show changes between current and new version
|
|
83
|
+
- Highlight Added, Changed, Removed, Fixed sections
|
|
84
|
+
- Make it easy to understand what's new
|
|
85
|
+
|
|
86
|
+
**Expected Outcome**: User understands what would change
|
|
87
|
+
|
|
88
|
+
### 5. Prompt for Action
|
|
89
|
+
|
|
90
|
+
Ask user if they want to update.
|
|
91
|
+
|
|
92
|
+
**Actions**:
|
|
93
|
+
- If updates available: Suggest running `@acp-version-update`
|
|
94
|
+
- If up to date: No action needed
|
|
95
|
+
- Provide clear next steps
|
|
96
|
+
|
|
97
|
+
**Expected Outcome**: User knows what to do next
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
|
|
101
|
+
## Verification
|
|
102
|
+
|
|
103
|
+
- [ ] Update check script executed successfully
|
|
104
|
+
- [ ] Update status determined (up to date or updates available)
|
|
105
|
+
- [ ] If updates available, changelog displayed
|
|
106
|
+
- [ ] Clear next steps provided
|
|
107
|
+
- [ ] No files modified
|
|
108
|
+
|
|
109
|
+
---
|
|
110
|
+
|
|
111
|
+
## Expected Output
|
|
112
|
+
|
|
113
|
+
### Files Modified
|
|
114
|
+
None - this is a read-only command
|
|
115
|
+
|
|
116
|
+
### Console Output (Up to Date)
|
|
117
|
+
```
|
|
118
|
+
🔍 Checking for ACP updates...
|
|
119
|
+
|
|
120
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
121
|
+
|
|
122
|
+
✅ Your ACP is up to date!
|
|
123
|
+
|
|
124
|
+
Current Version: 1.0.3
|
|
125
|
+
Latest Version: 1.0.3
|
|
126
|
+
Released: 2026-02-13
|
|
127
|
+
|
|
128
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
129
|
+
|
|
130
|
+
ℹ️ No action needed.
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### Console Output (Updates Available)
|
|
134
|
+
```
|
|
135
|
+
🔍 Checking for ACP updates...
|
|
136
|
+
|
|
137
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
138
|
+
|
|
139
|
+
🆕 Updates Available!
|
|
140
|
+
|
|
141
|
+
Current Version: 1.0.3
|
|
142
|
+
Latest Version: 1.1.0
|
|
143
|
+
Released: 2026-02-20
|
|
144
|
+
|
|
145
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
146
|
+
|
|
147
|
+
📋 What's New in 1.1.0:
|
|
148
|
+
|
|
149
|
+
Added:
|
|
150
|
+
• ACP Commands system with 15 core commands
|
|
151
|
+
• Flat directory structure with dot notation
|
|
152
|
+
• Command template for creating custom commands
|
|
153
|
+
• Third-party command installation via @acp-install
|
|
154
|
+
|
|
155
|
+
Changed:
|
|
156
|
+
• Improved installation scripts
|
|
157
|
+
• Better autocomplete support
|
|
158
|
+
• Enhanced documentation
|
|
159
|
+
|
|
160
|
+
Fixed:
|
|
161
|
+
• Various bug fixes and improvements
|
|
162
|
+
|
|
163
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
164
|
+
|
|
165
|
+
🎯 To update, run: @acp-version-update
|
|
166
|
+
|
|
167
|
+
📚 Full changelog:
|
|
168
|
+
https://github.com/prmichaelsen/agent-context-protocol/blob/mainline/CHANGELOG.md
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
### Status Update
|
|
172
|
+
No status changes - read-only operation
|
|
173
|
+
|
|
174
|
+
---
|
|
175
|
+
|
|
176
|
+
## Examples
|
|
177
|
+
|
|
178
|
+
### Example 1: Session Start Check
|
|
179
|
+
|
|
180
|
+
**Context**: Starting work session, want to check for updates
|
|
181
|
+
|
|
182
|
+
**Invocation**: `@acp-version-check-for-updates`
|
|
183
|
+
|
|
184
|
+
**Result**: Shows you're on 1.0.3, latest is 1.1.0, displays what's new, suggests updating
|
|
185
|
+
|
|
186
|
+
### Example 2: Already Up to Date
|
|
187
|
+
|
|
188
|
+
**Context**: Checking for updates after recent update
|
|
189
|
+
|
|
190
|
+
**Invocation**: `@acp-version-check-for-updates`
|
|
191
|
+
|
|
192
|
+
**Result**: Confirms you're on latest version (1.0.3), no action needed
|
|
193
|
+
|
|
194
|
+
### Example 3: No Internet Connection
|
|
195
|
+
|
|
196
|
+
**Context**: Offline, trying to check for updates
|
|
197
|
+
|
|
198
|
+
**Invocation**: `@acp-version-check-for-updates`
|
|
199
|
+
|
|
200
|
+
**Result**: Reports cannot connect to repository, shows current version, suggests trying again when online
|
|
201
|
+
|
|
202
|
+
---
|
|
203
|
+
|
|
204
|
+
## Related Commands
|
|
205
|
+
|
|
206
|
+
- [`@acp-version-check`](acp.version-check.md) - Show current version without checking for updates
|
|
207
|
+
- [`@acp-version-update`](acp.version-update.md) - Apply updates if available
|
|
208
|
+
- [`@acp-init`](acp.init.md) - Includes update check as first step
|
|
209
|
+
|
|
210
|
+
---
|
|
211
|
+
|
|
212
|
+
## Troubleshooting
|
|
213
|
+
|
|
214
|
+
### Issue 1: Script not found
|
|
215
|
+
|
|
216
|
+
**Symptom**: Error "check-for-updates.sh not found"
|
|
217
|
+
|
|
218
|
+
**Cause**: Older ACP installation without update scripts
|
|
219
|
+
|
|
220
|
+
**Solution**: Update ACP manually by downloading latest AGENT.md, or install update scripts from repository
|
|
221
|
+
|
|
222
|
+
### Issue 2: Network error
|
|
223
|
+
|
|
224
|
+
**Symptom**: Error "Cannot connect to repository"
|
|
225
|
+
|
|
226
|
+
**Cause**: No internet connection or GitHub unavailable
|
|
227
|
+
|
|
228
|
+
**Solution**: Check internet connection and try again. Use `@acp-version-check` to see current version offline.
|
|
229
|
+
|
|
230
|
+
### Issue 3: Permission denied
|
|
231
|
+
|
|
232
|
+
**Symptom**: Error "Permission denied" when running script
|
|
233
|
+
|
|
234
|
+
**Cause**: Script not executable
|
|
235
|
+
|
|
236
|
+
**Solution**: Run `chmod +x agent/scripts/check-for-updates.sh` to make it executable
|
|
237
|
+
|
|
238
|
+
---
|
|
239
|
+
|
|
240
|
+
## Security Considerations
|
|
241
|
+
|
|
242
|
+
### File Access
|
|
243
|
+
- **Reads**: `AGENT.md`, `CHANGELOG.md`
|
|
244
|
+
- **Writes**: None (read-only command)
|
|
245
|
+
- **Executes**: `./agent/scripts/check-for-updates.sh`
|
|
246
|
+
|
|
247
|
+
### Network Access
|
|
248
|
+
- **APIs**: GitHub API (via check-for-updates script)
|
|
249
|
+
- **Repositories**: Accesses ACP repository to check latest version
|
|
250
|
+
|
|
251
|
+
### Sensitive Data
|
|
252
|
+
- **Secrets**: Does not access any secrets or credentials
|
|
253
|
+
- **Credentials**: Does not access any credentials
|
|
254
|
+
|
|
255
|
+
---
|
|
256
|
+
|
|
257
|
+
## Notes
|
|
258
|
+
|
|
259
|
+
- Non-destructive operation - only checks, doesn't modify files
|
|
260
|
+
- Requires internet connection to check for updates
|
|
261
|
+
- Part of `@acp-init` workflow
|
|
262
|
+
- Safe to run multiple times
|
|
263
|
+
- Update check script may cache results briefly
|
|
264
|
+
- Shows changelog diff between versions
|
|
265
|
+
|
|
266
|
+
---
|
|
267
|
+
|
|
268
|
+
**Namespace**: acp
|
|
269
|
+
**Command**: version-check-for-updates
|
|
270
|
+
**Version**: 1.0.0
|
|
271
|
+
**Created**: 2026-02-16
|
|
272
|
+
**Last Updated**: 2026-02-16
|
|
273
|
+
**Status**: Active
|
|
274
|
+
**Compatibility**: ACP 1.0.3+
|
|
275
|
+
**Author**: ACP Project
|