@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,392 @@
|
|
|
1
|
+
# Command: report
|
|
2
|
+
|
|
3
|
+
> **🤖 Agent Directive**: If you are reading this file, the command `@acp.report` 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**: Generate a comprehensive project status report including progress, accomplishments, and next steps
|
|
14
|
+
**Category**: Documentation
|
|
15
|
+
**Frequency**: As Needed
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## What This Command Does
|
|
20
|
+
|
|
21
|
+
This command generates a comprehensive markdown report summarizing the project's current status, progress, accomplishments, and plans. It reads all ACP documentation and creates a formatted report suitable for sharing with stakeholders, team members, or for project records.
|
|
22
|
+
|
|
23
|
+
Use this command when you need to communicate project status, before milestone reviews, for weekly/monthly updates, or when onboarding new team members. The report provides a complete snapshot of the project at a point in time.
|
|
24
|
+
|
|
25
|
+
Unlike `@acp.status` which provides a quick console summary, `@acp.report` generates a detailed markdown document that can be saved, shared, or archived.
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## Prerequisites
|
|
30
|
+
|
|
31
|
+
- [ ] ACP installed in project
|
|
32
|
+
- [ ] `agent/progress.yaml` exists and is current
|
|
33
|
+
- [ ] Documentation exists in `agent/` directory
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## Steps
|
|
38
|
+
|
|
39
|
+
### 1. Read Project Information
|
|
40
|
+
|
|
41
|
+
Load basic project details from progress.yaml.
|
|
42
|
+
|
|
43
|
+
**Actions**:
|
|
44
|
+
- Read `agent/progress.yaml`
|
|
45
|
+
- Extract project name, version, start date
|
|
46
|
+
- Note current status and milestone
|
|
47
|
+
- Get project description
|
|
48
|
+
|
|
49
|
+
**Expected Outcome**: Project basics loaded
|
|
50
|
+
|
|
51
|
+
### 2. Gather Milestone Information
|
|
52
|
+
|
|
53
|
+
Collect data about all milestones.
|
|
54
|
+
|
|
55
|
+
**Actions**:
|
|
56
|
+
- Read all milestone documents
|
|
57
|
+
- Extract milestone goals and deliverables
|
|
58
|
+
- Note progress percentages
|
|
59
|
+
- Identify completed vs in-progress vs not-started
|
|
60
|
+
- Calculate overall project progress
|
|
61
|
+
|
|
62
|
+
**Expected Outcome**: Milestone data collected
|
|
63
|
+
|
|
64
|
+
### 3. Gather Task Information
|
|
65
|
+
|
|
66
|
+
Collect data about all tasks.
|
|
67
|
+
|
|
68
|
+
**Actions**:
|
|
69
|
+
- Read task data from progress.yaml
|
|
70
|
+
- Count total tasks, completed, in-progress
|
|
71
|
+
- Calculate completion percentages
|
|
72
|
+
- Identify current task
|
|
73
|
+
- Note any blocked tasks
|
|
74
|
+
|
|
75
|
+
**Expected Outcome**: Task data collected
|
|
76
|
+
|
|
77
|
+
### 4. Summarize Recent Work
|
|
78
|
+
|
|
79
|
+
Extract recent accomplishments.
|
|
80
|
+
|
|
81
|
+
**Actions**:
|
|
82
|
+
- Read recent_work from progress.yaml
|
|
83
|
+
- Format accomplishments by date
|
|
84
|
+
- Highlight major achievements
|
|
85
|
+
- Note any significant milestones reached
|
|
86
|
+
|
|
87
|
+
**Expected Outcome**: Recent work summarized
|
|
88
|
+
|
|
89
|
+
### 5. Identify Next Steps
|
|
90
|
+
|
|
91
|
+
Extract and prioritize next steps.
|
|
92
|
+
|
|
93
|
+
**Actions**:
|
|
94
|
+
- Read next_steps from progress.yaml
|
|
95
|
+
- Read current task for immediate next steps
|
|
96
|
+
- Identify upcoming milestones
|
|
97
|
+
- Note any dependencies
|
|
98
|
+
|
|
99
|
+
**Expected Outcome**: Next steps identified
|
|
100
|
+
|
|
101
|
+
### 6. Document Blockers and Risks
|
|
102
|
+
|
|
103
|
+
List current blockers and risks.
|
|
104
|
+
|
|
105
|
+
**Actions**:
|
|
106
|
+
- Read current_blockers from progress.yaml
|
|
107
|
+
- Note any risks mentioned in milestone docs
|
|
108
|
+
- Identify dependencies on external factors
|
|
109
|
+
- Assess impact of blockers
|
|
110
|
+
|
|
111
|
+
**Expected Outcome**: Blockers documented
|
|
112
|
+
|
|
113
|
+
### 7. Generate Statistics
|
|
114
|
+
|
|
115
|
+
Calculate project metrics.
|
|
116
|
+
|
|
117
|
+
**Actions**:
|
|
118
|
+
- Total milestones and completion rate
|
|
119
|
+
- Total tasks and completion rate
|
|
120
|
+
- Overall project progress percentage
|
|
121
|
+
- Time elapsed since project start
|
|
122
|
+
- Estimated time remaining (if available)
|
|
123
|
+
- Documentation count (design docs, patterns, etc.)
|
|
124
|
+
|
|
125
|
+
**Expected Outcome**: Metrics calculated
|
|
126
|
+
|
|
127
|
+
### 8. Format Report
|
|
128
|
+
|
|
129
|
+
Create formatted markdown report.
|
|
130
|
+
|
|
131
|
+
**Actions**:
|
|
132
|
+
- Create report header with project info
|
|
133
|
+
- Add executive summary
|
|
134
|
+
- Include progress section with charts/percentages
|
|
135
|
+
- List milestones with status
|
|
136
|
+
- Summarize recent accomplishments
|
|
137
|
+
- Document next steps
|
|
138
|
+
- List blockers and risks
|
|
139
|
+
- Include statistics
|
|
140
|
+
- Add footer with generation date
|
|
141
|
+
|
|
142
|
+
**Expected Outcome**: Report formatted
|
|
143
|
+
|
|
144
|
+
### 9. Save Report
|
|
145
|
+
|
|
146
|
+
Write report to file.
|
|
147
|
+
|
|
148
|
+
**Actions**:
|
|
149
|
+
- Generate filename with date (e.g., `report-2026-02-16.md`)
|
|
150
|
+
- Save to `agent/reports/` directory (create if needed)
|
|
151
|
+
- Confirm file written successfully
|
|
152
|
+
- Display report location
|
|
153
|
+
|
|
154
|
+
**Expected Outcome**: Report saved
|
|
155
|
+
|
|
156
|
+
---
|
|
157
|
+
|
|
158
|
+
## Verification
|
|
159
|
+
|
|
160
|
+
- [ ] Project information extracted
|
|
161
|
+
- [ ] Milestone data collected
|
|
162
|
+
- [ ] Task data collected
|
|
163
|
+
- [ ] Recent work summarized
|
|
164
|
+
- [ ] Next steps identified
|
|
165
|
+
- [ ] Blockers documented
|
|
166
|
+
- [ ] Statistics calculated
|
|
167
|
+
- [ ] Report formatted as markdown
|
|
168
|
+
- [ ] Report saved to file
|
|
169
|
+
- [ ] Report location displayed
|
|
170
|
+
|
|
171
|
+
---
|
|
172
|
+
|
|
173
|
+
## Expected Output
|
|
174
|
+
|
|
175
|
+
### Files Modified
|
|
176
|
+
- `agent/reports/report-YYYY-MM-DD.md` - Generated report file
|
|
177
|
+
|
|
178
|
+
### Console Output
|
|
179
|
+
```
|
|
180
|
+
📊 Generating Project Report
|
|
181
|
+
|
|
182
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
183
|
+
|
|
184
|
+
Gathering project information...
|
|
185
|
+
✓ Project: agent-context-protocol v1.1.0
|
|
186
|
+
✓ Started: 2026-02-16
|
|
187
|
+
✓ Current milestone: M2
|
|
188
|
+
|
|
189
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
190
|
+
|
|
191
|
+
Collecting milestone data...
|
|
192
|
+
✓ Milestone 1: Complete (100%)
|
|
193
|
+
✓ Milestone 2: In Progress (60%)
|
|
194
|
+
|
|
195
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
196
|
+
|
|
197
|
+
Analyzing tasks...
|
|
198
|
+
✓ Total tasks: 7
|
|
199
|
+
✓ Completed: 5 (71%)
|
|
200
|
+
✓ In progress: 1
|
|
201
|
+
✓ Not started: 1
|
|
202
|
+
|
|
203
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
204
|
+
|
|
205
|
+
Calculating statistics...
|
|
206
|
+
✓ Overall progress: 75%
|
|
207
|
+
✓ Documentation: 8 design docs, 3 patterns
|
|
208
|
+
✓ Commands: 11 implemented
|
|
209
|
+
|
|
210
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
211
|
+
|
|
212
|
+
Formatting report...
|
|
213
|
+
✓ Report generated (2,500 words)
|
|
214
|
+
|
|
215
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
216
|
+
|
|
217
|
+
✅ Report Complete!
|
|
218
|
+
|
|
219
|
+
Saved to: agent/reports/report-2026-02-16.md
|
|
220
|
+
|
|
221
|
+
Summary:
|
|
222
|
+
- Overall progress: 75%
|
|
223
|
+
- Milestones: 1 complete, 1 in progress
|
|
224
|
+
- Tasks: 5/7 complete
|
|
225
|
+
- Blockers: 0
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
### Report Structure
|
|
229
|
+
```markdown
|
|
230
|
+
# Project Status Report
|
|
231
|
+
## agent-context-protocol
|
|
232
|
+
|
|
233
|
+
**Generated**: 2026-02-16
|
|
234
|
+
**Version**: 1.1.0
|
|
235
|
+
**Status**: In Progress
|
|
236
|
+
|
|
237
|
+
---
|
|
238
|
+
|
|
239
|
+
## Executive Summary
|
|
240
|
+
|
|
241
|
+
[2-3 paragraph summary of project status]
|
|
242
|
+
|
|
243
|
+
---
|
|
244
|
+
|
|
245
|
+
## Progress Overview
|
|
246
|
+
|
|
247
|
+
**Overall Progress**: 75%
|
|
248
|
+
|
|
249
|
+
### Milestones
|
|
250
|
+
- ✅ Milestone 1: ACP Commands Infrastructure (100%)
|
|
251
|
+
- 🔄 Milestone 2: Documentation & Utility Commands (60%)
|
|
252
|
+
|
|
253
|
+
### Tasks
|
|
254
|
+
- Total: 7
|
|
255
|
+
- Completed: 5 (71%)
|
|
256
|
+
- In Progress: 1
|
|
257
|
+
- Not Started: 1
|
|
258
|
+
|
|
259
|
+
---
|
|
260
|
+
|
|
261
|
+
## Recent Accomplishments
|
|
262
|
+
|
|
263
|
+
[List of recent work with dates]
|
|
264
|
+
|
|
265
|
+
---
|
|
266
|
+
|
|
267
|
+
## Next Steps
|
|
268
|
+
|
|
269
|
+
[Prioritized list of next steps]
|
|
270
|
+
|
|
271
|
+
---
|
|
272
|
+
|
|
273
|
+
## Current Blockers
|
|
274
|
+
|
|
275
|
+
[List of blockers, or "None"]
|
|
276
|
+
|
|
277
|
+
---
|
|
278
|
+
|
|
279
|
+
## Statistics
|
|
280
|
+
|
|
281
|
+
[Detailed metrics and counts]
|
|
282
|
+
|
|
283
|
+
---
|
|
284
|
+
|
|
285
|
+
**Report generated by ACP v1.1.0**
|
|
286
|
+
```
|
|
287
|
+
|
|
288
|
+
---
|
|
289
|
+
|
|
290
|
+
## Examples
|
|
291
|
+
|
|
292
|
+
### Example 1: Weekly Status Report
|
|
293
|
+
|
|
294
|
+
**Context**: End of week, need to report progress
|
|
295
|
+
|
|
296
|
+
**Invocation**: `@acp.report`
|
|
297
|
+
|
|
298
|
+
**Result**: Generates comprehensive report showing week's accomplishments, current status, and next week's plans
|
|
299
|
+
|
|
300
|
+
### Example 2: Milestone Review
|
|
301
|
+
|
|
302
|
+
**Context**: Just completed milestone 1, need review document
|
|
303
|
+
|
|
304
|
+
**Invocation**: `@acp.report`
|
|
305
|
+
|
|
306
|
+
**Result**: Report highlights milestone 1 completion, shows deliverables achieved, documents lessons learned
|
|
307
|
+
|
|
308
|
+
### Example 3: Stakeholder Update
|
|
309
|
+
|
|
310
|
+
**Context**: Monthly update for stakeholders
|
|
311
|
+
|
|
312
|
+
**Invocation**: `@acp.report`
|
|
313
|
+
|
|
314
|
+
**Result**: Executive-friendly report with high-level progress, key achievements, and timeline
|
|
315
|
+
|
|
316
|
+
---
|
|
317
|
+
|
|
318
|
+
## Related Commands
|
|
319
|
+
|
|
320
|
+
- [`@acp.status`](acp.status.md) - Quick console status (not a full report)
|
|
321
|
+
- [`@acp.update`](acp.update.md) - Update progress before generating report
|
|
322
|
+
- [`@acp.validate`](acp.validate.md) - Validate documentation before reporting
|
|
323
|
+
- [`@acp.sync`](acp.sync.md) - Sync docs before generating report
|
|
324
|
+
|
|
325
|
+
---
|
|
326
|
+
|
|
327
|
+
## Troubleshooting
|
|
328
|
+
|
|
329
|
+
### Issue 1: Report is empty or incomplete
|
|
330
|
+
|
|
331
|
+
**Symptom**: Generated report missing sections
|
|
332
|
+
|
|
333
|
+
**Cause**: progress.yaml not up to date or missing data
|
|
334
|
+
|
|
335
|
+
**Solution**: Run `@acp.update` first to ensure progress.yaml is current, then generate report
|
|
336
|
+
|
|
337
|
+
### Issue 2: Statistics don't match reality
|
|
338
|
+
|
|
339
|
+
**Symptom**: Numbers in report seem wrong
|
|
340
|
+
|
|
341
|
+
**Cause**: Progress tracking out of sync
|
|
342
|
+
|
|
343
|
+
**Solution**: Review and update progress.yaml manually, verify task counts, then regenerate report
|
|
344
|
+
|
|
345
|
+
### Issue 3: Report too long or too short
|
|
346
|
+
|
|
347
|
+
**Symptom**: Report length not appropriate
|
|
348
|
+
|
|
349
|
+
**Cause**: Too much or too little detail
|
|
350
|
+
|
|
351
|
+
**Solution**: Adjust report generation to include/exclude sections, customize for audience
|
|
352
|
+
|
|
353
|
+
---
|
|
354
|
+
|
|
355
|
+
## Security Considerations
|
|
356
|
+
|
|
357
|
+
### File Access
|
|
358
|
+
- **Reads**: All files in `agent/` directory, especially `agent/progress.yaml`
|
|
359
|
+
- **Writes**: `agent/reports/report-YYYY-MM-DD.md` (creates report file)
|
|
360
|
+
- **Executes**: None
|
|
361
|
+
|
|
362
|
+
### Network Access
|
|
363
|
+
- **APIs**: None
|
|
364
|
+
- **Repositories**: None
|
|
365
|
+
|
|
366
|
+
### Sensitive Data
|
|
367
|
+
- **Secrets**: Does not access secrets or credentials
|
|
368
|
+
- **Credentials**: Does not access credentials files
|
|
369
|
+
|
|
370
|
+
---
|
|
371
|
+
|
|
372
|
+
## Notes
|
|
373
|
+
|
|
374
|
+
- Reports are saved with date in filename for easy tracking
|
|
375
|
+
- Reports are markdown for easy sharing and version control
|
|
376
|
+
- Generate reports regularly for historical record
|
|
377
|
+
- Customize report format for different audiences
|
|
378
|
+
- Include reports in project documentation
|
|
379
|
+
- Consider automating report generation (weekly/monthly)
|
|
380
|
+
- Reports can be converted to PDF or HTML if needed
|
|
381
|
+
- Keep reports in version control for history
|
|
382
|
+
|
|
383
|
+
---
|
|
384
|
+
|
|
385
|
+
**Namespace**: acp
|
|
386
|
+
**Command**: report
|
|
387
|
+
**Version**: 1.0.0
|
|
388
|
+
**Created**: 2026-02-16
|
|
389
|
+
**Last Updated**: 2026-02-16
|
|
390
|
+
**Status**: Active
|
|
391
|
+
**Compatibility**: ACP 1.1.0+
|
|
392
|
+
**Author**: ACP Project
|
|
@@ -0,0 +1,280 @@
|
|
|
1
|
+
# Command: status
|
|
2
|
+
|
|
3
|
+
> **🤖 Agent Directive**: If you are reading this file, the command `@acp-status` 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**: Display current project status including milestone progress, current task, recent work, and next steps
|
|
14
|
+
**Category**: Workflow
|
|
15
|
+
**Frequency**: As Needed
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## What This Command Does
|
|
20
|
+
|
|
21
|
+
This command provides a comprehensive overview of the current project status by reading `agent/progress.yaml` and presenting key information in an organized format. It shows where the project stands, what's been accomplished recently, and what needs to be done next.
|
|
22
|
+
|
|
23
|
+
Use this command when you need to quickly understand the current state of the project without performing a full initialization. It's ideal for checking progress during a session, before starting new work, or when reporting status to stakeholders.
|
|
24
|
+
|
|
25
|
+
Unlike `@acp-init` which performs a full context load and updates documentation, `@acp-status` is a read-only operation that simply reports the current state as recorded in progress tracking.
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## Prerequisites
|
|
30
|
+
|
|
31
|
+
- [ ] ACP installed in project
|
|
32
|
+
- [ ] `agent/progress.yaml` exists and is up to date
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## Steps
|
|
37
|
+
|
|
38
|
+
### 1. Read Progress Tracking
|
|
39
|
+
|
|
40
|
+
Read the `agent/progress.yaml` file to get current project state.
|
|
41
|
+
|
|
42
|
+
**Actions**:
|
|
43
|
+
- Open and parse `agent/progress.yaml`
|
|
44
|
+
- Extract key information: current milestone, current task, progress percentages
|
|
45
|
+
- Note any errors or missing data
|
|
46
|
+
|
|
47
|
+
**Expected Outcome**: Progress data loaded successfully
|
|
48
|
+
|
|
49
|
+
### 2. Display Current Milestone
|
|
50
|
+
|
|
51
|
+
Show the current milestone information.
|
|
52
|
+
|
|
53
|
+
**Actions**:
|
|
54
|
+
- Display milestone ID and name
|
|
55
|
+
- Show milestone progress percentage
|
|
56
|
+
- Show tasks completed vs total tasks
|
|
57
|
+
- Display milestone status (not_started, in_progress, completed)
|
|
58
|
+
|
|
59
|
+
**Expected Outcome**: User sees current milestone summary
|
|
60
|
+
|
|
61
|
+
### 3. Display Current Task
|
|
62
|
+
|
|
63
|
+
Show the current task being worked on.
|
|
64
|
+
|
|
65
|
+
**Actions**:
|
|
66
|
+
- Display task ID and name
|
|
67
|
+
- Show task status
|
|
68
|
+
- Display task file path
|
|
69
|
+
- Show estimated hours and completion date (if completed)
|
|
70
|
+
|
|
71
|
+
**Expected Outcome**: User sees current task details
|
|
72
|
+
|
|
73
|
+
### 4. Display Recent Work
|
|
74
|
+
|
|
75
|
+
List recent work completed.
|
|
76
|
+
|
|
77
|
+
**Actions**:
|
|
78
|
+
- Show recent work entries from `progress.yaml`
|
|
79
|
+
- Display dates and descriptions
|
|
80
|
+
- Show completed items with checkmarks
|
|
81
|
+
|
|
82
|
+
**Expected Outcome**: User sees what was recently accomplished
|
|
83
|
+
|
|
84
|
+
### 5. Display Next Steps
|
|
85
|
+
|
|
86
|
+
Show what needs to be done next.
|
|
87
|
+
|
|
88
|
+
**Actions**:
|
|
89
|
+
- List next steps from `progress.yaml`
|
|
90
|
+
- Prioritize by order in the list
|
|
91
|
+
- Highlight any urgent items
|
|
92
|
+
|
|
93
|
+
**Expected Outcome**: User knows what to work on next
|
|
94
|
+
|
|
95
|
+
### 6. Display Blockers
|
|
96
|
+
|
|
97
|
+
Show any current blockers or issues.
|
|
98
|
+
|
|
99
|
+
**Actions**:
|
|
100
|
+
- List current blockers from `progress.yaml`
|
|
101
|
+
- Highlight critical blockers
|
|
102
|
+
- Note if no blockers exist
|
|
103
|
+
|
|
104
|
+
**Expected Outcome**: User is aware of any obstacles
|
|
105
|
+
|
|
106
|
+
---
|
|
107
|
+
|
|
108
|
+
## Verification
|
|
109
|
+
|
|
110
|
+
- [ ] `agent/progress.yaml` read successfully
|
|
111
|
+
- [ ] Current milestone displayed with progress percentage
|
|
112
|
+
- [ ] Current task displayed with status
|
|
113
|
+
- [ ] Recent work listed (if any exists)
|
|
114
|
+
- [ ] Next steps listed
|
|
115
|
+
- [ ] Blockers displayed (or noted as none)
|
|
116
|
+
- [ ] Output is clear and well-formatted
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
## Expected Output
|
|
121
|
+
|
|
122
|
+
### Files Modified
|
|
123
|
+
None - this is a read-only command
|
|
124
|
+
|
|
125
|
+
### Console Output
|
|
126
|
+
```
|
|
127
|
+
📊 Project Status
|
|
128
|
+
|
|
129
|
+
Project: example-project (v0.1.0)
|
|
130
|
+
Status: in_progress
|
|
131
|
+
Started: 2026-01-15
|
|
132
|
+
|
|
133
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
134
|
+
|
|
135
|
+
📍 Current Milestone: M1 - Foundation
|
|
136
|
+
Progress: 40% (2/5 tasks completed)
|
|
137
|
+
Status: in_progress
|
|
138
|
+
Started: 2026-01-15
|
|
139
|
+
|
|
140
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
141
|
+
|
|
142
|
+
📋 Current Task: task-3-implement-core-logic
|
|
143
|
+
Status: in_progress
|
|
144
|
+
File: agent/tasks/task-3-implement-core-logic.md
|
|
145
|
+
Estimated: 4 hours
|
|
146
|
+
|
|
147
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
148
|
+
|
|
149
|
+
✅ Recent Work:
|
|
150
|
+
2026-02-15:
|
|
151
|
+
- ✅ Completed task-2 (database setup)
|
|
152
|
+
- ✅ Updated progress tracking
|
|
153
|
+
- 📋 Started task-3
|
|
154
|
+
|
|
155
|
+
2026-02-14:
|
|
156
|
+
- ✅ Completed task-1 (project structure)
|
|
157
|
+
|
|
158
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
159
|
+
|
|
160
|
+
🎯 Next Steps:
|
|
161
|
+
1. Complete task-3 (implement core logic)
|
|
162
|
+
2. Begin task-4 (add tests)
|
|
163
|
+
3. Review milestone-1 success criteria
|
|
164
|
+
|
|
165
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
166
|
+
|
|
167
|
+
⚠️ Current Blockers:
|
|
168
|
+
None
|
|
169
|
+
|
|
170
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
171
|
+
|
|
172
|
+
Overall Progress: 35% complete
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
### Status Update
|
|
176
|
+
No status changes - read-only operation
|
|
177
|
+
|
|
178
|
+
---
|
|
179
|
+
|
|
180
|
+
## Examples
|
|
181
|
+
|
|
182
|
+
### Example 1: Checking Status Mid-Session
|
|
183
|
+
|
|
184
|
+
**Context**: You're in the middle of working and want to see where things stand
|
|
185
|
+
|
|
186
|
+
**Invocation**: `@acp-status`
|
|
187
|
+
|
|
188
|
+
**Result**: Displays current milestone (M1, 40% complete), current task (task-3, in progress), recent work (completed task-2 yesterday), and next steps (finish task-3, start task-4)
|
|
189
|
+
|
|
190
|
+
### Example 2: Starting a New Session
|
|
191
|
+
|
|
192
|
+
**Context**: Beginning work after a break, want to see project state before diving in
|
|
193
|
+
|
|
194
|
+
**Invocation**: `@acp-status`
|
|
195
|
+
|
|
196
|
+
**Result**: Shows you're on milestone 2, 60% through, currently on task-7, with 3 tasks completed this week and 2 blockers to address
|
|
197
|
+
|
|
198
|
+
### Example 3: Reporting to Stakeholders
|
|
199
|
+
|
|
200
|
+
**Context**: Need to provide a quick status update
|
|
201
|
+
|
|
202
|
+
**Invocation**: `@acp-status`
|
|
203
|
+
|
|
204
|
+
**Result**: Clean, formatted output showing overall progress (65%), current phase (Testing), and upcoming milestones
|
|
205
|
+
|
|
206
|
+
---
|
|
207
|
+
|
|
208
|
+
## Related Commands
|
|
209
|
+
|
|
210
|
+
- [`@acp-init`](acp.init.md) - Use for full context initialization at session start
|
|
211
|
+
- [`@acp-proceed`](acp.proceed.md) - Use after checking status to continue with current task
|
|
212
|
+
- [`@acp-update`](acp.update.md) - Use to update progress.yaml after completing work
|
|
213
|
+
- [`@acp-sync`](acp.sync.md) - Use to sync documentation with code changes
|
|
214
|
+
|
|
215
|
+
---
|
|
216
|
+
|
|
217
|
+
## Troubleshooting
|
|
218
|
+
|
|
219
|
+
### Issue 1: progress.yaml not found
|
|
220
|
+
|
|
221
|
+
**Symptom**: Error message "Cannot read file: agent/progress.yaml"
|
|
222
|
+
|
|
223
|
+
**Cause**: Progress tracking file doesn't exist yet
|
|
224
|
+
|
|
225
|
+
**Solution**: Create progress.yaml from template: `cp agent/progress.template.yaml agent/progress.yaml`, then fill in initial project information
|
|
226
|
+
|
|
227
|
+
### Issue 2: Empty or incomplete output
|
|
228
|
+
|
|
229
|
+
**Symptom**: Status shows "No data" or missing sections
|
|
230
|
+
|
|
231
|
+
**Cause**: progress.yaml is not properly filled out
|
|
232
|
+
|
|
233
|
+
**Solution**: Review progress.yaml and ensure all required fields are populated (project name, current milestone, current task, etc.)
|
|
234
|
+
|
|
235
|
+
### Issue 3: Outdated information displayed
|
|
236
|
+
|
|
237
|
+
**Symptom**: Status shows old task or milestone that's already completed
|
|
238
|
+
|
|
239
|
+
**Cause**: progress.yaml hasn't been updated after recent work
|
|
240
|
+
|
|
241
|
+
**Solution**: Run `@acp-update` to refresh progress tracking, or manually update progress.yaml
|
|
242
|
+
|
|
243
|
+
---
|
|
244
|
+
|
|
245
|
+
## Security Considerations
|
|
246
|
+
|
|
247
|
+
### File Access
|
|
248
|
+
- **Reads**: `agent/progress.yaml` only
|
|
249
|
+
- **Writes**: None (read-only command)
|
|
250
|
+
- **Executes**: None
|
|
251
|
+
|
|
252
|
+
### Network Access
|
|
253
|
+
- **APIs**: None
|
|
254
|
+
- **Repositories**: None
|
|
255
|
+
|
|
256
|
+
### Sensitive Data
|
|
257
|
+
- **Secrets**: Does not access any secrets or credentials
|
|
258
|
+
- **Credentials**: Does not access any credentials
|
|
259
|
+
|
|
260
|
+
---
|
|
261
|
+
|
|
262
|
+
## Notes
|
|
263
|
+
|
|
264
|
+
- This is a read-only command that doesn't modify any files
|
|
265
|
+
- For best results, keep `agent/progress.yaml` up to date
|
|
266
|
+
- Use `@acp-update` after completing tasks to ensure status is accurate
|
|
267
|
+
- Status output is designed to be human-readable and suitable for reports
|
|
268
|
+
- Can be run multiple times per session without side effects
|
|
269
|
+
- Faster than `@acp-init` since it only reads one file
|
|
270
|
+
|
|
271
|
+
---
|
|
272
|
+
|
|
273
|
+
**Namespace**: acp
|
|
274
|
+
**Command**: status
|
|
275
|
+
**Version**: 1.0.0
|
|
276
|
+
**Created**: 2026-02-16
|
|
277
|
+
**Last Updated**: 2026-02-16
|
|
278
|
+
**Status**: Active
|
|
279
|
+
**Compatibility**: ACP 1.0.3+
|
|
280
|
+
**Author**: ACP Project
|