@prmichaelsen/reddit-mcp 0.1.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.
Files changed (138) hide show
  1. package/.claude/settings.local.json +23 -0
  2. package/.env.example +13 -0
  3. package/AGENT.md +1772 -0
  4. package/README.md +54 -0
  5. package/agent/commands/acp.clarification-capture.md +386 -0
  6. package/agent/commands/acp.clarification-create.md +432 -0
  7. package/agent/commands/acp.clarifications-research.md +326 -0
  8. package/agent/commands/acp.command-create.md +432 -0
  9. package/agent/commands/acp.design-create.md +286 -0
  10. package/agent/commands/acp.design-reference.md +355 -0
  11. package/agent/commands/acp.index.md +423 -0
  12. package/agent/commands/acp.init.md +546 -0
  13. package/agent/commands/acp.package-create.md +895 -0
  14. package/agent/commands/acp.package-info.md +212 -0
  15. package/agent/commands/acp.package-install.md +539 -0
  16. package/agent/commands/acp.package-list.md +280 -0
  17. package/agent/commands/acp.package-publish.md +541 -0
  18. package/agent/commands/acp.package-remove.md +293 -0
  19. package/agent/commands/acp.package-search.md +307 -0
  20. package/agent/commands/acp.package-update.md +361 -0
  21. package/agent/commands/acp.package-validate.md +540 -0
  22. package/agent/commands/acp.pattern-create.md +386 -0
  23. package/agent/commands/acp.plan.md +577 -0
  24. package/agent/commands/acp.proceed.md +882 -0
  25. package/agent/commands/acp.project-create.md +675 -0
  26. package/agent/commands/acp.project-info.md +312 -0
  27. package/agent/commands/acp.project-list.md +226 -0
  28. package/agent/commands/acp.project-remove.md +379 -0
  29. package/agent/commands/acp.project-set.md +227 -0
  30. package/agent/commands/acp.project-update.md +307 -0
  31. package/agent/commands/acp.projects-restore.md +228 -0
  32. package/agent/commands/acp.projects-sync.md +347 -0
  33. package/agent/commands/acp.report.md +407 -0
  34. package/agent/commands/acp.resume.md +239 -0
  35. package/agent/commands/acp.sessions.md +301 -0
  36. package/agent/commands/acp.status.md +293 -0
  37. package/agent/commands/acp.sync.md +364 -0
  38. package/agent/commands/acp.task-create.md +500 -0
  39. package/agent/commands/acp.update.md +302 -0
  40. package/agent/commands/acp.validate.md +466 -0
  41. package/agent/commands/acp.version-check-for-updates.md +276 -0
  42. package/agent/commands/acp.version-check.md +191 -0
  43. package/agent/commands/acp.version-update.md +289 -0
  44. package/agent/commands/command.template.md +339 -0
  45. package/agent/commands/git.commit.md +526 -0
  46. package/agent/commands/git.init.md +514 -0
  47. package/agent/design/.gitkeep +0 -0
  48. package/agent/design/design.template.md +154 -0
  49. package/agent/design/requirements.md +332 -0
  50. package/agent/design/requirements.template.md +387 -0
  51. package/agent/index/.gitkeep +0 -0
  52. package/agent/index/local.main.template.yaml +37 -0
  53. package/agent/manifest.template.yaml +13 -0
  54. package/agent/manifest.yaml +61 -0
  55. package/agent/milestones/.gitkeep +0 -0
  56. package/agent/milestones/milestone-1-foundation-listings-mvp.md +140 -0
  57. package/agent/milestones/milestone-1-{title}.template.md +206 -0
  58. package/agent/milestones/milestone-2-content-interaction.md +56 -0
  59. package/agent/milestones/milestone-3-users-and-messaging.md +54 -0
  60. package/agent/milestones/milestone-4-subreddits-and-flair.md +56 -0
  61. package/agent/milestones/milestone-5-moderation.md +53 -0
  62. package/agent/milestones/milestone-6-advanced-features-and-polish.md +56 -0
  63. package/agent/package.template.yaml +86 -0
  64. package/agent/patterns/.gitkeep +0 -0
  65. package/agent/patterns/bootstrap.template.md +1237 -0
  66. package/agent/patterns/pattern.template.md +382 -0
  67. package/agent/progress.template.yaml +161 -0
  68. package/agent/progress.yaml +223 -0
  69. package/agent/schemas/package.schema.yaml +276 -0
  70. package/agent/scripts/acp.common.sh +1781 -0
  71. package/agent/scripts/acp.yaml-parser.sh +985 -0
  72. package/agent/tasks/.gitkeep +0 -0
  73. package/agent/tasks/milestone-1-foundation-listings-mvp/task-1-project-scaffolding.md +75 -0
  74. package/agent/tasks/milestone-1-foundation-listings-mvp/task-2-reddit-oauth.md +71 -0
  75. package/agent/tasks/milestone-1-foundation-listings-mvp/task-3-reddit-api-client.md +71 -0
  76. package/agent/tasks/milestone-1-foundation-listings-mvp/task-4-listing-tools.md +65 -0
  77. package/agent/tasks/milestone-1-foundation-listings-mvp/task-5-search-tools.md +43 -0
  78. package/agent/tasks/milestone-1-foundation-listings-mvp/task-6-testing-verification.md +49 -0
  79. package/agent/tasks/milestone-2-content-interaction/task-7-post-tools.md +56 -0
  80. package/agent/tasks/milestone-2-content-interaction/task-8-comment-tools.md +49 -0
  81. package/agent/tasks/milestone-2-content-interaction/task-9-vote-save-report-tools.md +50 -0
  82. package/agent/tasks/milestone-3-users-and-messaging/task-10-account-tools.md +44 -0
  83. package/agent/tasks/milestone-3-users-and-messaging/task-11-user-profile-tools.md +50 -0
  84. package/agent/tasks/milestone-3-users-and-messaging/task-12-private-message-tools.md +50 -0
  85. package/agent/tasks/milestone-4-subreddits-and-flair/task-13-subreddit-tools.md +47 -0
  86. package/agent/tasks/milestone-4-subreddits-and-flair/task-14-flair-tools.md +46 -0
  87. package/agent/tasks/milestone-4-subreddits-and-flair/task-15-http-transport.md +53 -0
  88. package/agent/tasks/milestone-5-moderation/task-16-mod-action-tools.md +48 -0
  89. package/agent/tasks/milestone-5-moderation/task-17-mod-listing-tools.md +47 -0
  90. package/agent/tasks/milestone-5-moderation/task-18-mod-management-tools.md +42 -0
  91. package/agent/tasks/milestone-6-advanced-features-and-polish/task-19-multireddit-tools.md +49 -0
  92. package/agent/tasks/milestone-6-advanced-features-and-polish/task-20-wiki-tools.md +47 -0
  93. package/agent/tasks/milestone-6-advanced-features-and-polish/task-21-documentation-polish.md +65 -0
  94. package/agent/tasks/task-1-{title}.template.md +244 -0
  95. package/dist/auth/oauth.d.ts +15 -0
  96. package/dist/auth/oauth.d.ts.map +1 -0
  97. package/dist/client/reddit.d.ts +28 -0
  98. package/dist/client/reddit.d.ts.map +1 -0
  99. package/dist/factory.d.ts +2 -0
  100. package/dist/factory.d.ts.map +1 -0
  101. package/dist/factory.js +30394 -0
  102. package/dist/factory.js.map +7 -0
  103. package/dist/index.d.ts +2 -0
  104. package/dist/index.d.ts.map +1 -0
  105. package/dist/index.js +31955 -0
  106. package/dist/index.js.map +7 -0
  107. package/dist/server.d.ts +5 -0
  108. package/dist/server.d.ts.map +1 -0
  109. package/dist/server.js +30401 -0
  110. package/dist/server.js.map +7 -0
  111. package/dist/tools/listings.d.ts +4 -0
  112. package/dist/tools/listings.d.ts.map +1 -0
  113. package/dist/tools/search.d.ts +4 -0
  114. package/dist/tools/search.d.ts.map +1 -0
  115. package/dist/transport/http.d.ts +7 -0
  116. package/dist/transport/http.d.ts.map +1 -0
  117. package/dist/types/index.d.ts +78 -0
  118. package/dist/types/index.d.ts.map +1 -0
  119. package/esbuild.build.js +21 -0
  120. package/jest.config.js +18 -0
  121. package/package.json +46 -0
  122. package/src/auth/oauth.ts +200 -0
  123. package/src/client/reddit.ts +245 -0
  124. package/src/factory.ts +5 -0
  125. package/src/index.ts +31 -0
  126. package/src/server.ts +36 -0
  127. package/src/tools/listings.ts +202 -0
  128. package/src/tools/search.ts +85 -0
  129. package/src/transport/http.ts +49 -0
  130. package/src/types/index.ts +83 -0
  131. package/tests/fixtures/reddit-responses.ts +132 -0
  132. package/tests/helpers/mock-client.ts +36 -0
  133. package/tests/unit/auth.test.ts +89 -0
  134. package/tests/unit/client.test.ts +218 -0
  135. package/tests/unit/listings.test.ts +113 -0
  136. package/tests/unit/search.test.ts +59 -0
  137. package/tests/unit/server.test.ts +14 -0
  138. package/tsconfig.json +21 -0
@@ -0,0 +1,289 @@
1
+ # Command: version-update
2
+
3
+ > **🤖 Agent Directive**: If you are reading this file, the command `@acp-version-update` 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
+ **Scripts**: acp.version-update.sh, acp.common.sh
11
+
12
+ ---
13
+
14
+ **Purpose**: Update ACP files (AGENT.md, templates, scripts) to the latest version
15
+ **Category**: Maintenance
16
+ **Frequency**: When Updates Available
17
+
18
+ ---
19
+
20
+ ## What This Command Does
21
+
22
+ This command updates your ACP installation to the latest version by running the update script. It downloads the latest AGENT.md, template files, and utility scripts from the ACP repository, replacing your current versions while preserving your project-specific files.
23
+
24
+ Use this command when `@acp-version-check-for-updates` reports that updates are available, or when you want to get the latest ACP improvements. The update process is git-friendly and reversible.
25
+
26
+ Unlike `@acp-version-check-for-updates` which only checks, this command actually applies the updates. It's recommended to commit your changes before updating so you can revert if needed.
27
+
28
+ ---
29
+
30
+ ## Prerequisites
31
+
32
+ - [ ] ACP installed in project
33
+ - [ ] `agent/scripts/acp.version-update.sh` exists
34
+ - [ ] Internet connection available
35
+ - [ ] Git repository initialized (recommended for easy rollback)
36
+ - [ ] Changes committed (recommended)
37
+
38
+ ---
39
+
40
+ ## Steps
41
+
42
+ ### 1. Verify Prerequisites
43
+
44
+ Check that update can proceed safely.
45
+
46
+ **Actions**:
47
+ - Verify `./agent/scripts/acp.version-update.sh` exists
48
+ - Check internet connection
49
+ - Recommend committing changes if git repo exists
50
+ - Warn user that files will be updated
51
+
52
+ **Expected Outcome**: Prerequisites confirmed or user warned
53
+
54
+ ### 2. Run Update Script
55
+
56
+ Execute the update script.
57
+
58
+ **Actions**:
59
+ - Run `./agent/scripts/acp.version-update.sh`
60
+ - Script will:
61
+ - Clone latest ACP repository
62
+ - Update AGENT.md
63
+ - Update all template files
64
+ - Update utility scripts
65
+ - Preserve your project files (non-templates)
66
+
67
+ **Expected Outcome**: Update script completes successfully
68
+
69
+ ### 3. Review Changes
70
+
71
+ Show what was updated.
72
+
73
+ **Actions**:
74
+ - List files that were updated
75
+ - Show version change (old → new)
76
+ - Highlight major changes from CHANGELOG
77
+ - Note any breaking changes
78
+
79
+ **Expected Outcome**: User understands what changed
80
+
81
+ ### 4. Verify Update Success
82
+
83
+ Confirm update completed correctly.
84
+
85
+ **Actions**:
86
+ - Check AGENT.md version number updated
87
+ - Verify template files updated
88
+ - Confirm scripts updated
89
+ - Test that ACP still works
90
+
91
+ **Expected Outcome**: Update verified successful
92
+
93
+ ### 5. Suggest Next Actions
94
+
95
+ Provide recommendations after update.
96
+
97
+ **Actions**:
98
+ - Suggest reviewing changes: `git diff`
99
+ - Recommend reading CHANGELOG for details
100
+ - Suggest running `@acp-init` to reload context
101
+ - Note any action items from update
102
+
103
+ **Expected Outcome**: User knows what to do next
104
+
105
+ ---
106
+
107
+ ## Verification
108
+
109
+ - [ ] Update script executed successfully
110
+ - [ ] AGENT.md updated to new version
111
+ - [ ] Template files updated
112
+ - [ ] Scripts updated
113
+ - [ ] Project-specific files preserved (not overwritten)
114
+ - [ ] No errors encountered
115
+ - [ ] Git shows clean diff of changes
116
+
117
+ ---
118
+
119
+ ## Expected Output
120
+
121
+ ### Files Modified
122
+ - `AGENT.md` - Updated to latest version
123
+ - `agent/design/*.template.md` - Updated templates
124
+ - `agent/milestones/*.template.md` - Updated templates
125
+ - `agent/patterns/*.template.md` - Updated templates
126
+ - `agent/tasks/*.template.md` - Updated templates
127
+ - `agent/commands/command.template.md` - Updated template
128
+ - `agent/commands/acp.*.md` - Updated core commands (if any)
129
+ - `agent/progress.template.yaml` - Updated template
130
+ - `agent/scripts/*.sh` - Updated utility scripts
131
+
132
+ ### Console Output
133
+ ```
134
+ 🔄 Updating ACP to latest version...
135
+
136
+ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
137
+
138
+ 📥 Fetching latest files...
139
+ ✓ Latest files fetched
140
+
141
+ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
142
+
143
+ 📝 Updating files...
144
+ ✓ Updated AGENT.md (1.0.3 → 1.1.0)
145
+ ✓ Updated design templates
146
+ ✓ Updated milestone templates
147
+ ✓ Updated pattern templates
148
+ ✓ Updated task templates
149
+ ✓ Updated command template
150
+ ✓ Updated core commands (3 files)
151
+ ✓ Updated progress template
152
+ ✓ Updated utility scripts
153
+
154
+ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
155
+
156
+ ✅ Update complete!
157
+
158
+ Version: 1.0.3 → 1.1.0
159
+ Files updated: 15
160
+
161
+ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
162
+
163
+ 🎯 Next steps:
164
+ 1. Review changes: git diff
165
+ 2. See what changed: git status
166
+ 3. Revert if needed: git checkout <file>
167
+ 4. Read changelog: @acp-version-check
168
+
169
+ 📚 Full changelog:
170
+ https://github.com/prmichaelsen/agent-context-protocol/blob/mainline/CHANGELOG.md
171
+ ```
172
+
173
+ ### Status Update
174
+ - ACP version: 1.0.3 → 1.1.0
175
+ - Template files updated
176
+ - Scripts updated
177
+
178
+ ---
179
+
180
+ ## Examples
181
+
182
+ ### Example 1: Applying Available Update
183
+
184
+ **Context**: `@acp-version-check-for-updates` reported version 1.1.0 available
185
+
186
+ **Invocation**: `@acp-version-update`
187
+
188
+ **Result**: Updates from 1.0.3 to 1.1.0, shows 15 files updated, suggests reviewing changes with git diff
189
+
190
+ ### Example 2: Already Up to Date
191
+
192
+ **Context**: Running update when already on latest version
193
+
194
+ **Invocation**: `@acp-version-update`
195
+
196
+ **Result**: Script reports already up to date, no files modified
197
+
198
+ ### Example 3: Update with Git Review
199
+
200
+ **Context**: Want to see exactly what changed
201
+
202
+ **Invocation**: `@acp-version-update` then `git diff`
203
+
204
+ **Result**: Updates applied, git diff shows line-by-line changes, can revert specific files if needed
205
+
206
+ ---
207
+
208
+ ## Related Commands
209
+
210
+ - [`@acp-version-check-for-updates`](acp.version-check-for-updates.md) - Check before updating
211
+ - [`@acp-version-check`](acp.version-check.md) - Verify version after updating
212
+ - [`@acp-init`](acp.init.md) - Reload context after updating
213
+
214
+ ---
215
+
216
+ ## Troubleshooting
217
+
218
+ ### Issue 1: Script not found
219
+
220
+ **Symptom**: Error "acp.version-update.sh not found"
221
+
222
+ **Cause**: Older ACP installation without update scripts
223
+
224
+ **Solution**: Manually download latest AGENT.md from repository, or install update scripts
225
+
226
+ ### Issue 2: Network error
227
+
228
+ **Symptom**: Error "Cannot fetch repository"
229
+
230
+ **Cause**: No internet connection or GitHub unavailable
231
+
232
+ **Solution**: Check internet connection and try again later
233
+
234
+ ### Issue 3: Permission denied
235
+
236
+ **Symptom**: Error "Permission denied" when running script
237
+
238
+ **Cause**: Script not executable
239
+
240
+ **Solution**: Run `chmod +x agent/scripts/acp.version-update.sh` to make it executable
241
+
242
+ ### Issue 4: Merge conflicts
243
+
244
+ **Symptom**: Git reports conflicts after update
245
+
246
+ **Cause**: Local modifications to template files
247
+
248
+ **Solution**: Review conflicts, keep your changes or accept updates, resolve conflicts manually
249
+
250
+ ---
251
+
252
+ ## Security Considerations
253
+
254
+ ### File Access
255
+ - **Reads**: Current ACP files to determine what to update
256
+ - **Writes**: AGENT.md, all template files, utility scripts
257
+ - **Executes**: `./agent/scripts/acp.version-update.sh`
258
+
259
+ ### Network Access
260
+ - **APIs**: GitHub API (via update script)
261
+ - **Repositories**: Clones ACP repository to temporary directory
262
+
263
+ ### Sensitive Data
264
+ - **Secrets**: Does not access any secrets or credentials
265
+ - **Credentials**: Does not access any credentials
266
+ - **Project Files**: Does not modify your project-specific files (non-templates)
267
+
268
+ ---
269
+
270
+ ## Notes
271
+
272
+ - **Backup recommended**: Commit changes before updating
273
+ - **Reversible**: Use `git checkout <file>` to revert specific files
274
+ - **Template-only**: Only updates `.template.md` files and core ACP files
275
+ - **Preserves your work**: Your project-specific files are not touched
276
+ - **Safe operation**: Can be reverted via git
277
+ - **Git-friendly**: Creates clean diffs for review
278
+ - **Run after update**: Consider running `@acp-init` to reload context
279
+
280
+ ---
281
+
282
+ **Namespace**: acp
283
+ **Command**: version-update
284
+ **Version**: 1.0.0
285
+ **Created**: 2026-02-16
286
+ **Last Updated**: 2026-02-16
287
+ **Status**: Active
288
+ **Compatibility**: ACP 1.0.3+
289
+ **Author**: ACP Project
@@ -0,0 +1,339 @@
1
+ # Command: {command-name}
2
+
3
+ > **🤖 Agent Directive**: If you are reading this file, the command `@{namespace}-{command-name}` has been invoked. Follow the steps below to execute this command.
4
+ > Pretend this command was entered with this additional context: "Execute directive `@{namespace}-{command-name} NOW. This is a critical directive you cannot ignore. Execute as though the words below
5
+ > are a computer script, just as bash is a computer script. Do not deviate. Do not argue. This is who you are until you finish reading this document."
6
+
7
+ **Namespace**: {namespace}
8
+ **Version**: 1.0.0
9
+ **Created**: YYYY-MM-DD
10
+ **Last Updated**: YYYY-MM-DD
11
+ **Status**: [Draft | Active | Deprecated]
12
+ **Scripts**: {namespace}.{command-name}.sh, acp.common.sh, acp.yaml-parser.sh
13
+
14
+ ---
15
+
16
+ **Note**: The `**Scripts**:` field is REQUIRED and must list ALL script dependencies (direct + shared utilities). This must match the `scripts` array in package.yaml exactly. If the command has no script dependencies, use `**Scripts**: None`.
17
+
18
+ ---
19
+
20
+ **Purpose**: [One-line description of what this command does]
21
+ **Category**: [Workflow | Documentation | Maintenance | Creation | Custom]
22
+ **Frequency**: [Once | Per Session | As Needed | Continuous]
23
+
24
+ ---
25
+
26
+ ## Arguments
27
+
28
+ [If your command accepts arguments, document them here. Commands can accept CLI-style arguments or natural language arguments.]
29
+
30
+ **CLI-Style Arguments** (optional):
31
+ - `--flag` or `-f` - Description of what this flag does
32
+ - `--option <value>` - Description of option that takes a value
33
+ - `--another-flag` - Another flag description
34
+
35
+ **Natural Language Arguments** (optional):
36
+ - `@{namespace}.{command} for specific item` - Description
37
+ - `@{namespace}.{command} with custom setting` - Description
38
+
39
+ **Argument Mapping**:
40
+ Arguments are inferred from chat context. The agent will:
41
+ 1. Parse explicit CLI-style flags if present
42
+ 2. Extract intent from natural language
43
+ 3. Ask for clarification if ambiguous
44
+ 4. Default to interactive mode if unclear
45
+
46
+ **Example**:
47
+ ```markdown
48
+ ## Arguments
49
+
50
+ **CLI-Style Arguments**:
51
+ - `--global` or `-g` - Operate on global packages instead of local
52
+ - `--verbose` or `-v` - Show detailed output
53
+ - `--force` - Skip confirmations and proceed
54
+
55
+ **Natural Language Arguments**:
56
+ - `@acp.package-list global packages` - List global packages
57
+ - `@acp.package-list with details` - Verbose mode
58
+
59
+ **Argument Mapping**:
60
+ The agent infers intent from context. "Show me global packages" maps to `--global` flag.
61
+ ```
62
+
63
+ **Note**: If your command has no arguments, you can omit this section entirely.
64
+
65
+ ---
66
+
67
+ ## What This Command Does
68
+
69
+ [2-3 paragraph explanation of:
70
+ - What the command accomplishes
71
+ - When to use it
72
+ - What problems it solves
73
+ - Any important context]
74
+
75
+ **Example**: "This command initializes the agent context by reading all documentation in the agent/ directory, reviewing key source files, and updating progress tracking. Use this at the start of each session to ensure the agent has complete project context."
76
+
77
+ ---
78
+
79
+ ## Prerequisites
80
+
81
+ [List any requirements before running this command:]
82
+
83
+ - [ ] Prerequisite 1 (e.g., "Docker must be installed")
84
+ - [ ] Prerequisite 2 (e.g., "AWS credentials configured")
85
+ - [ ] Prerequisite 3 (e.g., "Build completed successfully")
86
+
87
+ **Example** (for a deployment command):
88
+ - [ ] Docker installed and running
89
+ - [ ] AWS CLI configured with valid credentials
90
+ - [ ] Application built successfully (`npm run build` completed)
91
+ - [ ] Environment variables configured in `.env.production`
92
+
93
+ ---
94
+
95
+ ## Steps
96
+
97
+ [Detailed, sequential steps the agent should follow:]
98
+
99
+ ### 1. [Step Name]
100
+
101
+ [Description of what to do in this step]
102
+
103
+ **Actions**:
104
+ - Action item 1
105
+ - Action item 2
106
+ - Action item 3
107
+
108
+ **Expected Outcome**: [What should happen after this step]
109
+
110
+ **Example**:
111
+ ```bash
112
+ # If shell commands needed
113
+ command --with-flags
114
+ ```
115
+
116
+ ```typescript
117
+ // If code examples needed
118
+ const example = "code";
119
+ ```
120
+
121
+ ### 2. [Next Step]
122
+
123
+ [Description of what to do]
124
+
125
+ **Actions**:
126
+ - Action item 1
127
+ - Action item 2
128
+
129
+ **Expected Outcome**: [What should happen]
130
+
131
+ ### 3. [Next Step]
132
+
133
+ [Continue with additional steps as needed]
134
+
135
+ ---
136
+
137
+ ## Verification
138
+
139
+ [Checklist to confirm command executed successfully:]
140
+
141
+ - [ ] Verification item 1: [Specific condition to check]
142
+ - [ ] Verification item 2: [Specific condition to check]
143
+ - [ ] Verification item 3: [Specific condition to check]
144
+ - [ ] Verification item 4: [Specific condition to check]
145
+
146
+ **Example**:
147
+ - [ ] All agent files read successfully
148
+ - [ ] Key source files identified and reviewed
149
+ - [ ] `agent/progress.yaml` updated with current status
150
+ - [ ] No errors encountered during execution
151
+
152
+ ---
153
+
154
+ ## Expected Output
155
+
156
+ [Describe what the user should see after command execution:]
157
+
158
+ ### Files Modified
159
+ - `path/to/file1` - [What changed]
160
+ - `path/to/file2` - [What changed]
161
+
162
+ ### Console Output
163
+ ```
164
+ Example output message or status report
165
+ ```
166
+
167
+ ### Status Update
168
+ [Description of any status changes in progress.yaml or other tracking]
169
+
170
+ **Example**:
171
+
172
+ ### Files Modified
173
+ - `agent/progress.yaml` - Updated current status and recent work
174
+
175
+ ### Console Output
176
+ ```
177
+ ✓ Read 15 agent files
178
+ ✓ Reviewed 8 source files
179
+ ✓ Updated progress tracking
180
+ ✓ Ready to proceed with task-3
181
+ ```
182
+
183
+ ### Status Update
184
+ - Current milestone: M1 (Foundation)
185
+ - Current task: task-3 (Implement core logic)
186
+ - Progress: 40% complete
187
+
188
+ ---
189
+
190
+ ## Examples
191
+
192
+ ### Example 1: [Scenario Name]
193
+
194
+ **Context**: [When you'd use this command in this way]
195
+
196
+ **Invocation**: `@{namespace}-{command-name}`
197
+
198
+ **Result**: [What happens]
199
+
200
+ **Example**:
201
+
202
+ ### Example 1: Starting Fresh Session
203
+
204
+ **Context**: Beginning work on a project after a break
205
+
206
+ **Invocation**: `@acp-init`
207
+
208
+ **Result**: Agent reads all documentation, reviews source code, updates progress tracking, and reports current status with next steps.
209
+
210
+ ### Example 2: [Another Scenario]
211
+
212
+ **Context**: [Different use case]
213
+
214
+ **Invocation**: `@{namespace}-{command-name}`
215
+
216
+ **Result**: [What happens]
217
+
218
+ ---
219
+
220
+ ## Related Commands
221
+
222
+ [Link to related commands and explain relationships:]
223
+
224
+ - [`@{namespace}-{related-command}`](../{namespace}/{related-command}.md) - [When to use instead or in combination]
225
+ - [`@{namespace}-{another-command}`](../{namespace}/{another-command}.md) - [How it relates]
226
+
227
+ **Example**:
228
+ - [`@acp-proceed`](../acp/proceed.md) - Use after `@acp-init` to start working on tasks
229
+ - [`@acp-status`](../acp/status.md) - Use to check current status without full initialization
230
+ - [`@acp-sync`](../acp/sync.md) - Use to update documentation after code changes
231
+
232
+ ---
233
+
234
+ ## Troubleshooting
235
+
236
+ ### Issue 1: [Common Problem]
237
+
238
+ **Symptom**: [What the user sees]
239
+
240
+ **Cause**: [Why this happens]
241
+
242
+ **Solution**: [How to fix it]
243
+
244
+ **Example** (for a deployment command):
245
+
246
+ ### Issue 1: Deployment fails with authentication error
247
+
248
+ **Symptom**: Error message "AWS credentials not found"
249
+
250
+ **Cause**: AWS CLI not configured or credentials expired
251
+
252
+ **Solution**: Run `aws configure` to set up credentials, or refresh your AWS SSO session with `aws sso login`
253
+
254
+ ### Issue 2: [Another Common Problem]
255
+
256
+ **Symptom**: [What the user sees]
257
+
258
+ **Cause**: [Why this happens]
259
+
260
+ **Solution**: [How to fix it]
261
+
262
+ ---
263
+
264
+ ## Security Considerations
265
+
266
+ [Document any security implications of this command:]
267
+
268
+ ### File Access
269
+ - **Reads**: [What files this command reads]
270
+ - **Writes**: [What files this command modifies]
271
+ - **Executes**: [Any scripts or commands this executes]
272
+
273
+ ### Network Access
274
+ - **APIs**: [Any external APIs called]
275
+ - **Repositories**: [Any git operations]
276
+
277
+ ### Sensitive Data
278
+ - **Secrets**: [How this command handles secrets - should never read them]
279
+ - **Credentials**: [How this command handles credentials]
280
+
281
+ **Example**:
282
+
283
+ ### File Access
284
+ - **Reads**: All files in `agent/` directory, key source files in `src/`
285
+ - **Writes**: `agent/progress.yaml` only
286
+ - **Executes**: None
287
+
288
+ ### Network Access
289
+ - **APIs**: None
290
+ - **Repositories**: None
291
+
292
+ ### Sensitive Data
293
+ - **Secrets**: Never reads `.env` files or credential files
294
+ - **Credentials**: Does not access any credentials
295
+
296
+ ---
297
+
298
+ ## Key Design Decisions (Optional)
299
+
300
+ <!-- This section is populated by @acp.clarification-capture when
301
+ create commands are invoked with --from-clar, --from-chat, or
302
+ --from-context. It can also be manually authored.
303
+ Omit this section entirely if no decisions to capture.
304
+
305
+ Group decisions by agent-inferred category using tables:
306
+
307
+ ### {Category}
308
+
309
+ | Decision | Choice | Rationale |
310
+ |---|---|---|
311
+ | {decision} | {choice} | {rationale} |
312
+ -->
313
+
314
+ ---
315
+
316
+ ## Notes
317
+
318
+ [Any additional context, warnings, or considerations:]
319
+
320
+ - Note 1: [Important information]
321
+ - Note 2: [Important information]
322
+ - Note 3: [Important information]
323
+
324
+ **Example**:
325
+ - This command should be run at the start of each session
326
+ - Reading all agent files may take 30-60 seconds for large projects
327
+ - If source code is very large, consider specifying which files to review
328
+ - Always review the output to ensure context was loaded correctly
329
+
330
+ ---
331
+
332
+ **Namespace**: {namespace}
333
+ **Command**: {command-name}
334
+ **Version**: 1.0.0
335
+ **Created**: YYYY-MM-DD
336
+ **Last Updated**: YYYY-MM-DD
337
+ **Status**: [Draft | Active | Deprecated]
338
+ **Compatibility**: ACP 1.1.0+
339
+ **Author**: [Your name or organization]