@prmichaelsen/remember-mcp 2.2.1 → 2.3.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/AGENT.md +4 -4
- package/CHANGELOG.md +45 -0
- package/README.md +43 -3
- package/agent/commands/acp.init.md +376 -0
- package/agent/commands/acp.proceed.md +311 -0
- package/agent/commands/acp.status.md +280 -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/design/core-memory-user-profile.md +1253 -0
- package/agent/design/ghost-profiles-pseudonymous-identity.md +194 -0
- package/agent/design/publish-tools-confirmation-flow.md +922 -0
- package/agent/milestones/milestone-10-shared-spaces.md +169 -0
- package/agent/progress.yaml +90 -4
- package/agent/scripts/install.sh +118 -0
- package/agent/scripts/update.sh +22 -10
- package/agent/scripts/version.sh +35 -0
- package/agent/tasks/task-27-implement-llm-provider-interface.md +51 -0
- package/agent/tasks/task-28-implement-llm-provider-factory.md +64 -0
- package/agent/tasks/task-29-update-config-for-llm.md +71 -0
- package/agent/tasks/task-30-implement-bedrock-provider.md +147 -0
- package/agent/tasks/task-31-implement-background-job-service.md +120 -0
- package/agent/tasks/task-32-test-llm-provider-integration.md +152 -0
- package/agent/tasks/task-34-create-confirmation-token-service.md +191 -0
- package/agent/tasks/task-35-create-space-memory-types-schema.md +183 -0
- package/agent/tasks/task-36-implement-remember-publish.md +227 -0
- package/agent/tasks/task-37-implement-remember-confirm.md +225 -0
- package/agent/tasks/task-38-implement-remember-deny.md +161 -0
- package/agent/tasks/task-39-implement-remember-search-space.md +188 -0
- package/agent/tasks/task-40-implement-remember-query-space.md +193 -0
- package/agent/tasks/task-41-configure-firestore-ttl.md +188 -0
- package/agent/tasks/task-42-create-tests-shared-spaces.md +216 -0
- package/agent/tasks/task-43-update-documentation.md +255 -0
- package/dist/llm/types.d.ts +1 -0
- package/dist/server-factory.js +914 -1
- package/dist/server.js +916 -3
- package/dist/services/confirmation-token.service.d.ts +99 -0
- package/dist/services/confirmation-token.service.spec.d.ts +5 -0
- package/dist/tools/confirm.d.ts +20 -0
- package/dist/tools/deny.d.ts +19 -0
- package/dist/tools/publish.d.ts +22 -0
- package/dist/tools/query-space.d.ts +28 -0
- package/dist/tools/search-space.d.ts +29 -0
- package/dist/types/space-memory.d.ts +80 -0
- package/dist/weaviate/space-schema.d.ts +59 -0
- package/dist/weaviate/space-schema.spec.d.ts +5 -0
- package/package.json +1 -1
- package/src/llm/types.ts +0 -0
- package/src/server-factory.ts +33 -0
- package/src/server.ts +33 -0
- package/src/services/confirmation-token.service.spec.ts +254 -0
- package/src/services/confirmation-token.service.ts +232 -0
- package/src/tools/confirm.ts +176 -0
- package/src/tools/deny.ts +70 -0
- package/src/tools/publish.ts +167 -0
- package/src/tools/query-space.ts +197 -0
- package/src/tools/search-space.ts +189 -0
- package/src/types/space-memory.ts +94 -0
- package/src/weaviate/space-schema.spec.ts +131 -0
- package/src/weaviate/space-schema.ts +275 -0
|
@@ -0,0 +1,288 @@
|
|
|
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
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
**Purpose**: Update ACP files (AGENT.md, templates, scripts) to the latest version
|
|
14
|
+
**Category**: Maintenance
|
|
15
|
+
**Frequency**: When Updates Available
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## What This Command Does
|
|
20
|
+
|
|
21
|
+
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.
|
|
22
|
+
|
|
23
|
+
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.
|
|
24
|
+
|
|
25
|
+
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.
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## Prerequisites
|
|
30
|
+
|
|
31
|
+
- [ ] ACP installed in project
|
|
32
|
+
- [ ] `agent/scripts/update.sh` exists
|
|
33
|
+
- [ ] Internet connection available
|
|
34
|
+
- [ ] Git repository initialized (recommended for easy rollback)
|
|
35
|
+
- [ ] Changes committed (recommended)
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## Steps
|
|
40
|
+
|
|
41
|
+
### 1. Verify Prerequisites
|
|
42
|
+
|
|
43
|
+
Check that update can proceed safely.
|
|
44
|
+
|
|
45
|
+
**Actions**:
|
|
46
|
+
- Verify `./agent/scripts/update.sh` exists
|
|
47
|
+
- Check internet connection
|
|
48
|
+
- Recommend committing changes if git repo exists
|
|
49
|
+
- Warn user that files will be updated
|
|
50
|
+
|
|
51
|
+
**Expected Outcome**: Prerequisites confirmed or user warned
|
|
52
|
+
|
|
53
|
+
### 2. Run Update Script
|
|
54
|
+
|
|
55
|
+
Execute the update script.
|
|
56
|
+
|
|
57
|
+
**Actions**:
|
|
58
|
+
- Run `./agent/scripts/update.sh`
|
|
59
|
+
- Script will:
|
|
60
|
+
- Clone latest ACP repository
|
|
61
|
+
- Update AGENT.md
|
|
62
|
+
- Update all template files
|
|
63
|
+
- Update utility scripts
|
|
64
|
+
- Preserve your project files (non-templates)
|
|
65
|
+
|
|
66
|
+
**Expected Outcome**: Update script completes successfully
|
|
67
|
+
|
|
68
|
+
### 3. Review Changes
|
|
69
|
+
|
|
70
|
+
Show what was updated.
|
|
71
|
+
|
|
72
|
+
**Actions**:
|
|
73
|
+
- List files that were updated
|
|
74
|
+
- Show version change (old → new)
|
|
75
|
+
- Highlight major changes from CHANGELOG
|
|
76
|
+
- Note any breaking changes
|
|
77
|
+
|
|
78
|
+
**Expected Outcome**: User understands what changed
|
|
79
|
+
|
|
80
|
+
### 4. Verify Update Success
|
|
81
|
+
|
|
82
|
+
Confirm update completed correctly.
|
|
83
|
+
|
|
84
|
+
**Actions**:
|
|
85
|
+
- Check AGENT.md version number updated
|
|
86
|
+
- Verify template files updated
|
|
87
|
+
- Confirm scripts updated
|
|
88
|
+
- Test that ACP still works
|
|
89
|
+
|
|
90
|
+
**Expected Outcome**: Update verified successful
|
|
91
|
+
|
|
92
|
+
### 5. Suggest Next Actions
|
|
93
|
+
|
|
94
|
+
Provide recommendations after update.
|
|
95
|
+
|
|
96
|
+
**Actions**:
|
|
97
|
+
- Suggest reviewing changes: `git diff`
|
|
98
|
+
- Recommend reading CHANGELOG for details
|
|
99
|
+
- Suggest running `@acp-init` to reload context
|
|
100
|
+
- Note any action items from update
|
|
101
|
+
|
|
102
|
+
**Expected Outcome**: User knows what to do next
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
106
|
+
## Verification
|
|
107
|
+
|
|
108
|
+
- [ ] Update script executed successfully
|
|
109
|
+
- [ ] AGENT.md updated to new version
|
|
110
|
+
- [ ] Template files updated
|
|
111
|
+
- [ ] Scripts updated
|
|
112
|
+
- [ ] Project-specific files preserved (not overwritten)
|
|
113
|
+
- [ ] No errors encountered
|
|
114
|
+
- [ ] Git shows clean diff of changes
|
|
115
|
+
|
|
116
|
+
---
|
|
117
|
+
|
|
118
|
+
## Expected Output
|
|
119
|
+
|
|
120
|
+
### Files Modified
|
|
121
|
+
- `AGENT.md` - Updated to latest version
|
|
122
|
+
- `agent/design/*.template.md` - Updated templates
|
|
123
|
+
- `agent/milestones/*.template.md` - Updated templates
|
|
124
|
+
- `agent/patterns/*.template.md` - Updated templates
|
|
125
|
+
- `agent/tasks/*.template.md` - Updated templates
|
|
126
|
+
- `agent/commands/command.template.md` - Updated template
|
|
127
|
+
- `agent/commands/acp.*.md` - Updated core commands (if any)
|
|
128
|
+
- `agent/progress.template.yaml` - Updated template
|
|
129
|
+
- `agent/scripts/*.sh` - Updated utility scripts
|
|
130
|
+
|
|
131
|
+
### Console Output
|
|
132
|
+
```
|
|
133
|
+
🔄 Updating ACP to latest version...
|
|
134
|
+
|
|
135
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
136
|
+
|
|
137
|
+
📥 Fetching latest files...
|
|
138
|
+
✓ Latest files fetched
|
|
139
|
+
|
|
140
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
141
|
+
|
|
142
|
+
📝 Updating files...
|
|
143
|
+
✓ Updated AGENT.md (1.0.3 → 1.1.0)
|
|
144
|
+
✓ Updated design templates
|
|
145
|
+
✓ Updated milestone templates
|
|
146
|
+
✓ Updated pattern templates
|
|
147
|
+
✓ Updated task templates
|
|
148
|
+
✓ Updated command template
|
|
149
|
+
✓ Updated core commands (3 files)
|
|
150
|
+
✓ Updated progress template
|
|
151
|
+
✓ Updated utility scripts
|
|
152
|
+
|
|
153
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
154
|
+
|
|
155
|
+
✅ Update complete!
|
|
156
|
+
|
|
157
|
+
Version: 1.0.3 → 1.1.0
|
|
158
|
+
Files updated: 15
|
|
159
|
+
|
|
160
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
161
|
+
|
|
162
|
+
🎯 Next steps:
|
|
163
|
+
1. Review changes: git diff
|
|
164
|
+
2. See what changed: git status
|
|
165
|
+
3. Revert if needed: git checkout <file>
|
|
166
|
+
4. Read changelog: @acp-version-check
|
|
167
|
+
|
|
168
|
+
📚 Full changelog:
|
|
169
|
+
https://github.com/prmichaelsen/agent-context-protocol/blob/mainline/CHANGELOG.md
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
### Status Update
|
|
173
|
+
- ACP version: 1.0.3 → 1.1.0
|
|
174
|
+
- Template files updated
|
|
175
|
+
- Scripts updated
|
|
176
|
+
|
|
177
|
+
---
|
|
178
|
+
|
|
179
|
+
## Examples
|
|
180
|
+
|
|
181
|
+
### Example 1: Applying Available Update
|
|
182
|
+
|
|
183
|
+
**Context**: `@acp-version-check-for-updates` reported version 1.1.0 available
|
|
184
|
+
|
|
185
|
+
**Invocation**: `@acp-version-update`
|
|
186
|
+
|
|
187
|
+
**Result**: Updates from 1.0.3 to 1.1.0, shows 15 files updated, suggests reviewing changes with git diff
|
|
188
|
+
|
|
189
|
+
### Example 2: Already Up to Date
|
|
190
|
+
|
|
191
|
+
**Context**: Running update when already on latest version
|
|
192
|
+
|
|
193
|
+
**Invocation**: `@acp-version-update`
|
|
194
|
+
|
|
195
|
+
**Result**: Script reports already up to date, no files modified
|
|
196
|
+
|
|
197
|
+
### Example 3: Update with Git Review
|
|
198
|
+
|
|
199
|
+
**Context**: Want to see exactly what changed
|
|
200
|
+
|
|
201
|
+
**Invocation**: `@acp-version-update` then `git diff`
|
|
202
|
+
|
|
203
|
+
**Result**: Updates applied, git diff shows line-by-line changes, can revert specific files if needed
|
|
204
|
+
|
|
205
|
+
---
|
|
206
|
+
|
|
207
|
+
## Related Commands
|
|
208
|
+
|
|
209
|
+
- [`@acp-version-check-for-updates`](acp.version-check-for-updates.md) - Check before updating
|
|
210
|
+
- [`@acp-version-check`](acp.version-check.md) - Verify version after updating
|
|
211
|
+
- [`@acp-init`](acp.init.md) - Reload context after updating
|
|
212
|
+
|
|
213
|
+
---
|
|
214
|
+
|
|
215
|
+
## Troubleshooting
|
|
216
|
+
|
|
217
|
+
### Issue 1: Script not found
|
|
218
|
+
|
|
219
|
+
**Symptom**: Error "update.sh not found"
|
|
220
|
+
|
|
221
|
+
**Cause**: Older ACP installation without update scripts
|
|
222
|
+
|
|
223
|
+
**Solution**: Manually download latest AGENT.md from repository, or install update scripts
|
|
224
|
+
|
|
225
|
+
### Issue 2: Network error
|
|
226
|
+
|
|
227
|
+
**Symptom**: Error "Cannot fetch repository"
|
|
228
|
+
|
|
229
|
+
**Cause**: No internet connection or GitHub unavailable
|
|
230
|
+
|
|
231
|
+
**Solution**: Check internet connection and try again later
|
|
232
|
+
|
|
233
|
+
### Issue 3: Permission denied
|
|
234
|
+
|
|
235
|
+
**Symptom**: Error "Permission denied" when running script
|
|
236
|
+
|
|
237
|
+
**Cause**: Script not executable
|
|
238
|
+
|
|
239
|
+
**Solution**: Run `chmod +x agent/scripts/update.sh` to make it executable
|
|
240
|
+
|
|
241
|
+
### Issue 4: Merge conflicts
|
|
242
|
+
|
|
243
|
+
**Symptom**: Git reports conflicts after update
|
|
244
|
+
|
|
245
|
+
**Cause**: Local modifications to template files
|
|
246
|
+
|
|
247
|
+
**Solution**: Review conflicts, keep your changes or accept updates, resolve conflicts manually
|
|
248
|
+
|
|
249
|
+
---
|
|
250
|
+
|
|
251
|
+
## Security Considerations
|
|
252
|
+
|
|
253
|
+
### File Access
|
|
254
|
+
- **Reads**: Current ACP files to determine what to update
|
|
255
|
+
- **Writes**: AGENT.md, all template files, utility scripts
|
|
256
|
+
- **Executes**: `./agent/scripts/update.sh`
|
|
257
|
+
|
|
258
|
+
### Network Access
|
|
259
|
+
- **APIs**: GitHub API (via update script)
|
|
260
|
+
- **Repositories**: Clones ACP repository to temporary directory
|
|
261
|
+
|
|
262
|
+
### Sensitive Data
|
|
263
|
+
- **Secrets**: Does not access any secrets or credentials
|
|
264
|
+
- **Credentials**: Does not access any credentials
|
|
265
|
+
- **Project Files**: Does not modify your project-specific files (non-templates)
|
|
266
|
+
|
|
267
|
+
---
|
|
268
|
+
|
|
269
|
+
## Notes
|
|
270
|
+
|
|
271
|
+
- **Backup recommended**: Commit changes before updating
|
|
272
|
+
- **Reversible**: Use `git checkout <file>` to revert specific files
|
|
273
|
+
- **Template-only**: Only updates `.template.md` files and core ACP files
|
|
274
|
+
- **Preserves your work**: Your project-specific files are not touched
|
|
275
|
+
- **Safe operation**: Can be reverted via git
|
|
276
|
+
- **Git-friendly**: Creates clean diffs for review
|
|
277
|
+
- **Run after update**: Consider running `@acp-init` to reload context
|
|
278
|
+
|
|
279
|
+
---
|
|
280
|
+
|
|
281
|
+
**Namespace**: acp
|
|
282
|
+
**Command**: version-update
|
|
283
|
+
**Version**: 1.0.0
|
|
284
|
+
**Created**: 2026-02-16
|
|
285
|
+
**Last Updated**: 2026-02-16
|
|
286
|
+
**Status**: Active
|
|
287
|
+
**Compatibility**: ACP 1.0.3+
|
|
288
|
+
**Author**: ACP Project
|
|
@@ -0,0 +1,273 @@
|
|
|
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
|
+
|
|
5
|
+
**Namespace**: {namespace}
|
|
6
|
+
**Version**: 1.0.0
|
|
7
|
+
**Created**: YYYY-MM-DD
|
|
8
|
+
**Last Updated**: YYYY-MM-DD
|
|
9
|
+
**Status**: [Draft | Active | Deprecated]
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
**Purpose**: [One-line description of what this command does]
|
|
14
|
+
**Category**: [Workflow | Documentation | Maintenance | Creation | Custom]
|
|
15
|
+
**Frequency**: [Once | Per Session | As Needed | Continuous]
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## What This Command Does
|
|
20
|
+
|
|
21
|
+
[2-3 paragraph explanation of:
|
|
22
|
+
- What the command accomplishes
|
|
23
|
+
- When to use it
|
|
24
|
+
- What problems it solves
|
|
25
|
+
- Any important context]
|
|
26
|
+
|
|
27
|
+
**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."
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## Prerequisites
|
|
32
|
+
|
|
33
|
+
[List any requirements before running this command:]
|
|
34
|
+
|
|
35
|
+
- [ ] Prerequisite 1 (e.g., "Docker must be installed")
|
|
36
|
+
- [ ] Prerequisite 2 (e.g., "AWS credentials configured")
|
|
37
|
+
- [ ] Prerequisite 3 (e.g., "Build completed successfully")
|
|
38
|
+
|
|
39
|
+
**Example** (for a deployment command):
|
|
40
|
+
- [ ] Docker installed and running
|
|
41
|
+
- [ ] AWS CLI configured with valid credentials
|
|
42
|
+
- [ ] Application built successfully (`npm run build` completed)
|
|
43
|
+
- [ ] Environment variables configured in `.env.production`
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## Steps
|
|
48
|
+
|
|
49
|
+
[Detailed, sequential steps the agent should follow:]
|
|
50
|
+
|
|
51
|
+
### 1. [Step Name]
|
|
52
|
+
|
|
53
|
+
[Description of what to do in this step]
|
|
54
|
+
|
|
55
|
+
**Actions**:
|
|
56
|
+
- Action item 1
|
|
57
|
+
- Action item 2
|
|
58
|
+
- Action item 3
|
|
59
|
+
|
|
60
|
+
**Expected Outcome**: [What should happen after this step]
|
|
61
|
+
|
|
62
|
+
**Example**:
|
|
63
|
+
```bash
|
|
64
|
+
# If shell commands needed
|
|
65
|
+
command --with-flags
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
```typescript
|
|
69
|
+
// If code examples needed
|
|
70
|
+
const example = "code";
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### 2. [Next Step]
|
|
74
|
+
|
|
75
|
+
[Description of what to do]
|
|
76
|
+
|
|
77
|
+
**Actions**:
|
|
78
|
+
- Action item 1
|
|
79
|
+
- Action item 2
|
|
80
|
+
|
|
81
|
+
**Expected Outcome**: [What should happen]
|
|
82
|
+
|
|
83
|
+
### 3. [Next Step]
|
|
84
|
+
|
|
85
|
+
[Continue with additional steps as needed]
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
## Verification
|
|
90
|
+
|
|
91
|
+
[Checklist to confirm command executed successfully:]
|
|
92
|
+
|
|
93
|
+
- [ ] Verification item 1: [Specific condition to check]
|
|
94
|
+
- [ ] Verification item 2: [Specific condition to check]
|
|
95
|
+
- [ ] Verification item 3: [Specific condition to check]
|
|
96
|
+
- [ ] Verification item 4: [Specific condition to check]
|
|
97
|
+
|
|
98
|
+
**Example**:
|
|
99
|
+
- [ ] All agent files read successfully
|
|
100
|
+
- [ ] Key source files identified and reviewed
|
|
101
|
+
- [ ] `agent/progress.yaml` updated with current status
|
|
102
|
+
- [ ] No errors encountered during execution
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
106
|
+
## Expected Output
|
|
107
|
+
|
|
108
|
+
[Describe what the user should see after command execution:]
|
|
109
|
+
|
|
110
|
+
### Files Modified
|
|
111
|
+
- `path/to/file1` - [What changed]
|
|
112
|
+
- `path/to/file2` - [What changed]
|
|
113
|
+
|
|
114
|
+
### Console Output
|
|
115
|
+
```
|
|
116
|
+
Example output message or status report
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
### Status Update
|
|
120
|
+
[Description of any status changes in progress.yaml or other tracking]
|
|
121
|
+
|
|
122
|
+
**Example**:
|
|
123
|
+
|
|
124
|
+
### Files Modified
|
|
125
|
+
- `agent/progress.yaml` - Updated current status and recent work
|
|
126
|
+
|
|
127
|
+
### Console Output
|
|
128
|
+
```
|
|
129
|
+
✓ Read 15 agent files
|
|
130
|
+
✓ Reviewed 8 source files
|
|
131
|
+
✓ Updated progress tracking
|
|
132
|
+
✓ Ready to proceed with task-3
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### Status Update
|
|
136
|
+
- Current milestone: M1 (Foundation)
|
|
137
|
+
- Current task: task-3 (Implement core logic)
|
|
138
|
+
- Progress: 40% complete
|
|
139
|
+
|
|
140
|
+
---
|
|
141
|
+
|
|
142
|
+
## Examples
|
|
143
|
+
|
|
144
|
+
### Example 1: [Scenario Name]
|
|
145
|
+
|
|
146
|
+
**Context**: [When you'd use this command in this way]
|
|
147
|
+
|
|
148
|
+
**Invocation**: `@{namespace}-{command-name}`
|
|
149
|
+
|
|
150
|
+
**Result**: [What happens]
|
|
151
|
+
|
|
152
|
+
**Example**:
|
|
153
|
+
|
|
154
|
+
### Example 1: Starting Fresh Session
|
|
155
|
+
|
|
156
|
+
**Context**: Beginning work on a project after a break
|
|
157
|
+
|
|
158
|
+
**Invocation**: `@acp-init`
|
|
159
|
+
|
|
160
|
+
**Result**: Agent reads all documentation, reviews source code, updates progress tracking, and reports current status with next steps.
|
|
161
|
+
|
|
162
|
+
### Example 2: [Another Scenario]
|
|
163
|
+
|
|
164
|
+
**Context**: [Different use case]
|
|
165
|
+
|
|
166
|
+
**Invocation**: `@{namespace}-{command-name}`
|
|
167
|
+
|
|
168
|
+
**Result**: [What happens]
|
|
169
|
+
|
|
170
|
+
---
|
|
171
|
+
|
|
172
|
+
## Related Commands
|
|
173
|
+
|
|
174
|
+
[Link to related commands and explain relationships:]
|
|
175
|
+
|
|
176
|
+
- [`@{namespace}-{related-command}`](../{namespace}/{related-command}.md) - [When to use instead or in combination]
|
|
177
|
+
- [`@{namespace}-{another-command}`](../{namespace}/{another-command}.md) - [How it relates]
|
|
178
|
+
|
|
179
|
+
**Example**:
|
|
180
|
+
- [`@acp-proceed`](../acp/proceed.md) - Use after `@acp-init` to start working on tasks
|
|
181
|
+
- [`@acp-status`](../acp/status.md) - Use to check current status without full initialization
|
|
182
|
+
- [`@acp-sync`](../acp/sync.md) - Use to update documentation after code changes
|
|
183
|
+
|
|
184
|
+
---
|
|
185
|
+
|
|
186
|
+
## Troubleshooting
|
|
187
|
+
|
|
188
|
+
### Issue 1: [Common Problem]
|
|
189
|
+
|
|
190
|
+
**Symptom**: [What the user sees]
|
|
191
|
+
|
|
192
|
+
**Cause**: [Why this happens]
|
|
193
|
+
|
|
194
|
+
**Solution**: [How to fix it]
|
|
195
|
+
|
|
196
|
+
**Example** (for a deployment command):
|
|
197
|
+
|
|
198
|
+
### Issue 1: Deployment fails with authentication error
|
|
199
|
+
|
|
200
|
+
**Symptom**: Error message "AWS credentials not found"
|
|
201
|
+
|
|
202
|
+
**Cause**: AWS CLI not configured or credentials expired
|
|
203
|
+
|
|
204
|
+
**Solution**: Run `aws configure` to set up credentials, or refresh your AWS SSO session with `aws sso login`
|
|
205
|
+
|
|
206
|
+
### Issue 2: [Another Common Problem]
|
|
207
|
+
|
|
208
|
+
**Symptom**: [What the user sees]
|
|
209
|
+
|
|
210
|
+
**Cause**: [Why this happens]
|
|
211
|
+
|
|
212
|
+
**Solution**: [How to fix it]
|
|
213
|
+
|
|
214
|
+
---
|
|
215
|
+
|
|
216
|
+
## Security Considerations
|
|
217
|
+
|
|
218
|
+
[Document any security implications of this command:]
|
|
219
|
+
|
|
220
|
+
### File Access
|
|
221
|
+
- **Reads**: [What files this command reads]
|
|
222
|
+
- **Writes**: [What files this command modifies]
|
|
223
|
+
- **Executes**: [Any scripts or commands this executes]
|
|
224
|
+
|
|
225
|
+
### Network Access
|
|
226
|
+
- **APIs**: [Any external APIs called]
|
|
227
|
+
- **Repositories**: [Any git operations]
|
|
228
|
+
|
|
229
|
+
### Sensitive Data
|
|
230
|
+
- **Secrets**: [How this command handles secrets - should never read them]
|
|
231
|
+
- **Credentials**: [How this command handles credentials]
|
|
232
|
+
|
|
233
|
+
**Example**:
|
|
234
|
+
|
|
235
|
+
### File Access
|
|
236
|
+
- **Reads**: All files in `agent/` directory, key source files in `src/`
|
|
237
|
+
- **Writes**: `agent/progress.yaml` only
|
|
238
|
+
- **Executes**: None
|
|
239
|
+
|
|
240
|
+
### Network Access
|
|
241
|
+
- **APIs**: None
|
|
242
|
+
- **Repositories**: None
|
|
243
|
+
|
|
244
|
+
### Sensitive Data
|
|
245
|
+
- **Secrets**: Never reads `.env` files or credential files
|
|
246
|
+
- **Credentials**: Does not access any credentials
|
|
247
|
+
|
|
248
|
+
---
|
|
249
|
+
|
|
250
|
+
## Notes
|
|
251
|
+
|
|
252
|
+
[Any additional context, warnings, or considerations:]
|
|
253
|
+
|
|
254
|
+
- Note 1: [Important information]
|
|
255
|
+
- Note 2: [Important information]
|
|
256
|
+
- Note 3: [Important information]
|
|
257
|
+
|
|
258
|
+
**Example**:
|
|
259
|
+
- This command should be run at the start of each session
|
|
260
|
+
- Reading all agent files may take 30-60 seconds for large projects
|
|
261
|
+
- If source code is very large, consider specifying which files to review
|
|
262
|
+
- Always review the output to ensure context was loaded correctly
|
|
263
|
+
|
|
264
|
+
---
|
|
265
|
+
|
|
266
|
+
**Namespace**: {namespace}
|
|
267
|
+
**Command**: {command-name}
|
|
268
|
+
**Version**: 1.0.0
|
|
269
|
+
**Created**: YYYY-MM-DD
|
|
270
|
+
**Last Updated**: YYYY-MM-DD
|
|
271
|
+
**Status**: [Draft | Active | Deprecated]
|
|
272
|
+
**Compatibility**: ACP 1.1.0+
|
|
273
|
+
**Author**: [Your name or organization]
|