Skip to content

Commit d92c4e1

Browse files
docs: add memory agent to CUSTOM-AGENTS.md (#359)
Fixes #311 This PR documents the `memory` agent in CUSTOM-AGENTS.md. - Added a new Utility Agents category - Documented the memory agent purpose, workflow, and constraints - Followed existing formatting and structure --------- Co-authored-by: Bill Berry <[email protected]>
1 parent 4bb857d commit d92c4e1

1 file changed

Lines changed: 96 additions & 63 deletions

File tree

.github/CUSTOM-AGENTS.md

Lines changed: 96 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -38,52 +38,58 @@ Select from the **agent picker dropdown** in the Chat view:
3838

3939
The Research-Plan-Implement (RPI) workflow provides a structured approach to complex development tasks.
4040

41-
| Agent | Purpose | Key Constraint |
42-
| ----- | ------- | -------------- |
43-
| **rpi-agent** | Autonomous agent with subagent delegation for complex tasks | Requires `runSubagent` tool enabled |
44-
| **task-researcher** | Produces research documents with evidence-based recommendations | Research-only; never plans or implements |
45-
| **task-planner** | Creates 3-file plan sets (plan, details, prompt) | Requires research first; never implements code |
46-
| **task-implementor** | Executes implementation plans with subagent delegation | Requires completed plan files |
47-
| **task-reviewer** | Validates implementation against research and plan specifications | Requires research/plan artifacts |
41+
| Agent | Purpose | Key Constraint |
42+
|----------------------|-------------------------------------------------------------------|------------------------------------------------|
43+
| **rpi-agent** | Autonomous agent with subagent delegation for complex tasks | Requires `runSubagent` tool enabled |
44+
| **task-researcher** | Produces research documents with evidence-based recommendations | Research-only; never plans or implements |
45+
| **task-planner** | Creates 3-file plan sets (plan, details, prompt) | Requires research first; never implements code |
46+
| **task-implementor** | Executes implementation plans with subagent delegation | Requires completed plan files |
47+
| **task-reviewer** | Validates implementation against research and plan specifications | Requires research/plan artifacts |
4848

4949
### Documentation and Planning Agents
5050

51-
| Agent | Purpose | Key Constraint |
52-
| ----- | ------- | -------------- |
53-
| **prd-builder** | Creates Product Requirements Documents through guided Q&A | Iterative questioning; state-tracked sessions |
54-
| **brd-builder** | Creates Business Requirements Documents with reference integration | Solution-agnostic requirements focus |
55-
| **adr-creation** | Interactive ADR coaching with guided discovery | Socratic coaching approach |
56-
| **security-plan-creator** | Creates comprehensive cloud security plans from blueprints | Blueprint-driven threat modeling |
57-
| **doc-ops** | Documentation operations and maintenance | Does not modify source code |
51+
| Agent | Purpose | Key Constraint |
52+
|---------------------------|--------------------------------------------------------------------|-----------------------------------------------|
53+
| **prd-builder** | Creates Product Requirements Documents through guided Q&A | Iterative questioning; state-tracked sessions |
54+
| **brd-builder** | Creates Business Requirements Documents with reference integration | Solution-agnostic requirements focus |
55+
| **adr-creation** | Interactive ADR coaching with guided discovery | Socratic coaching approach |
56+
| **security-plan-creator** | Creates comprehensive cloud security plans from blueprints | Blueprint-driven threat modeling |
57+
| **doc-ops** | Documentation operations and maintenance | Does not modify source code |
58+
59+
### Utility Agents
60+
61+
| Agent | Purpose | Key Constraint |
62+
|------------|--------------------------------------------|---------------------------------------|
63+
| **memory** | Persists repository facts for future tasks | Stores only durable, actionable facts |
5864

5965
### Code and Review Agents
6066

61-
| Agent | Purpose | Key Constraint |
62-
| ----- | ------- | -------------- |
63-
| **pr-review** | 4-phase PR review with tracking artifacts | Review-only; never modifies code |
67+
| Agent | Purpose | Key Constraint |
68+
|--------------------|--------------------------------------------------|---------------------------------------|
69+
| **pr-review** | 4-phase PR review with tracking artifacts | Review-only; never modifies code |
6470
| **prompt-builder** | Engineers and validates instruction/prompt files | Dual-persona system with auto-testing |
6571

6672
### Generator Agents
6773

68-
| Agent | Purpose | Key Constraint |
69-
| ----- | ------- | -------------- |
70-
| **gen-jupyter-notebook** | Creates structured EDA notebooks from data sources | Requires data dictionaries |
71-
| **gen-streamlit-dashboard** | Develops multi-page Streamlit dashboards | Uses Context7 for documentation |
72-
| **gen-data-spec** | Generates data dictionaries and profiles | Produces JSON and markdown artifacts |
73-
| **arch-diagram-builder** | Builds ASCII block diagrams from Azure IaC | Parses Terraform, Bicep, ARM scripts |
74+
| Agent | Purpose | Key Constraint |
75+
|-----------------------------|----------------------------------------------------|--------------------------------------|
76+
| **gen-jupyter-notebook** | Creates structured EDA notebooks from data sources | Requires data dictionaries |
77+
| **gen-streamlit-dashboard** | Develops multi-page Streamlit dashboards | Uses Context7 for documentation |
78+
| **gen-data-spec** | Generates data dictionaries and profiles | Produces JSON and markdown artifacts |
79+
| **arch-diagram-builder** | Builds ASCII block diagrams from Azure IaC | Parses Terraform, Bicep, ARM scripts |
7480

7581
### Platform Integration Agents
7682

77-
| Agent | Purpose | Key Constraint |
78-
| ----- | ------- | -------------- |
79-
| **github-issue-manager** | Interactive GitHub issue filing and navigation | Uses MCP GitHub tools |
80-
| **ado-prd-to-wit** | Analyzes PRDs and plans Azure DevOps work item hierarchies | Planning-only; does not create work items |
81-
| **hve-core-installer** | Decision-driven HVE-Core installation with 6 methods | Environment detection and validation |
83+
| Agent | Purpose | Key Constraint |
84+
|--------------------------|------------------------------------------------------------|-------------------------------------------|
85+
| **github-issue-manager** | Interactive GitHub issue filing and navigation | Uses MCP GitHub tools |
86+
| **ado-prd-to-wit** | Analyzes PRDs and plans Azure DevOps work item hierarchies | Planning-only; does not create work items |
87+
| **hve-core-installer** | Decision-driven HVE-Core installation with 6 methods | Environment detection and validation |
8288

8389
### Testing Agents
8490

85-
| Agent | Purpose | Key Constraint |
86-
| ----- | ------- | -------------- |
91+
| Agent | Purpose | Key Constraint |
92+
|------------------------------|---------------------------------------------|----------------------------------------|
8793
| **test-streamlit-dashboard** | Automated Streamlit testing with Playwright | Requires running Streamlit application |
8894

8995
## Agent Details
@@ -102,8 +108,8 @@ The Research-Plan-Implement (RPI) workflow provides a structured approach to com
102108

103109
**Creates:** Single authoritative research document:
104110

105-
* `.copilot-tracking/research/{{YYYY-MM-DD}}-topic-research.md`
106-
* `.copilot-tracking/subagent/{{YYYY-MM-DD}}/task-research.md`
111+
* `.copilot-tracking/research/{{YYYY-MM-DD}}-topic-research.md` (primary research with evidence-based recommendations)
112+
* `.copilot-tracking/subagent/{{YYYY-MM-DD}}/task-research.md` (subagent research outputs when delegating)
107113

108114
**Workflow:** Deep tool-based research → Document findings → Consolidate to one approach → Hand off to planner
109115

@@ -113,8 +119,8 @@ The Research-Plan-Implement (RPI) workflow provides a structured approach to com
113119

114120
**Creates:** Two interconnected files per task:
115121

116-
* `.copilot-tracking/plans/{{YYYY-MM-DD}}-task-plan.instructions.md`
117-
* `.copilot-tracking/details/{{YYYY-MM-DD}}-task-details.md`
122+
* `.copilot-tracking/plans/{{YYYY-MM-DD}}-task-plan.instructions.md` (implementation plan with checklist items)
123+
* `.copilot-tracking/details/{{YYYY-MM-DD}}-task-details.md` (step-by-step execution details)
118124

119125
**Workflow:** Validates research → Creates plan files → User implements separately
120126

@@ -124,7 +130,7 @@ The Research-Plan-Implement (RPI) workflow provides a structured approach to com
124130

125131
**Creates:** Change tracking logs:
126132

127-
* `.copilot-tracking/changes/{{YYYY-MM-DD}}-task-changes.md`
133+
* `.copilot-tracking/changes/{{YYYY-MM-DD}}-task-changes.md` (chronological log with Added/Modified/Removed sections)
128134

129135
**Workflow:** Analyze plan → Dispatch subagents per phase → Track progress → Validate
130136

@@ -134,7 +140,7 @@ The Research-Plan-Implement (RPI) workflow provides a structured approach to com
134140

135141
**Creates:** Review validation logs:
136142

137-
* `.copilot-tracking/reviews/{{YYYY-MM-DD}}-<topic>-review.md`
143+
* `.copilot-tracking/reviews/{{YYYY-MM-DD}}-{{topic}}-review.md` (findings with severity levels and follow-up work)
138144

139145
**Workflow:** Locate artifacts → Extract checklist → Validate items → Run commands → Document findings
140146

@@ -146,8 +152,10 @@ The Research-Plan-Implement (RPI) workflow provides a structured approach to com
146152

147153
**Creates:** Instruction files and prompt files:
148154

149-
* `.github/instructions/*.instructions.md`
150-
* `.github/prompts/*.prompt.md`
155+
* `.github/instructions/*.instructions.md` (coding guidelines and conventions)
156+
* `.github/prompts/*.prompt.md` (reusable workflow prompts)
157+
* `.copilot-tracking/sandbox/{{YYYY-MM-DD}}-{{prompt-name}}-{{run-number}}/execution-log.md` (test execution trace)
158+
* `.copilot-tracking/sandbox/{{YYYY-MM-DD}}-{{prompt-name}}-{{run-number}}/evaluation-log.md` (quality validation results)
151159

152160
**Workflow:** Research sources → Draft → Auto-validate with Prompt Tester → Iterate (up to 3 cycles)
153161

@@ -157,9 +165,9 @@ The Research-Plan-Implement (RPI) workflow provides a structured approach to com
157165

158166
**Creates:** Review tracking files in normalized branch folders:
159167

160-
* `.copilot-tracking/pr/review/{normalized-branch}/in-progress-review.md`
161-
* `.copilot-tracking/pr/review/{normalized-branch}/pr-reference.xml`
162-
* `.copilot-tracking/pr/review/{normalized-branch}/handoff.md`
168+
* `.copilot-tracking/pr/review/{normalized-branch}/in-progress-review.md` (living review document with findings)
169+
* `.copilot-tracking/pr/review/{normalized-branch}/pr-reference.xml` (PR metadata and diff summary)
170+
* `.copilot-tracking/pr/review/{normalized-branch}/handoff.md` (finalized comments for PR submission)
163171

164172
**Workflow:** 4 phases (Initialize → Analyze → Collaborative Review → Finalize)
165173

@@ -169,8 +177,8 @@ The Research-Plan-Implement (RPI) workflow provides a structured approach to com
169177

170178
**Creates:** Product requirements documents with session state:
171179

172-
* `docs/prds/<kebab-case-name>.md`
173-
* `.copilot-tracking/prd-sessions/<kebab-case-name>.state.json`
180+
* `docs/prds/<kebab-case-name>.md` (PRD document with requirements)
181+
* `.copilot-tracking/prd-sessions/<kebab-case-name>.state.json` (session state for resume capability)
174182

175183
**Workflow:** Assess → Discover → Create → Build → Integrate → Validate → Finalize
176184

@@ -180,8 +188,8 @@ The Research-Plan-Implement (RPI) workflow provides a structured approach to com
180188

181189
**Creates:** Business requirements documents with session state:
182190

183-
* `docs/brds/<kebab-case-name>-brd.md`
184-
* `.copilot-tracking/brd-sessions/<kebab-case-name>.state.json`
191+
* `docs/brds/<kebab-case-name>-brd.md` (BRD document with business objectives)
192+
* `.copilot-tracking/brd-sessions/<kebab-case-name>.state.json` (session state for resume capability)
185193

186194
**Workflow:** Assess → Discover → Create → Elicit → Integrate → Validate → Finalize
187195

@@ -200,7 +208,9 @@ The Research-Plan-Implement (RPI) workflow provides a structured approach to com
200208

201209
### doc-ops
202210

203-
**Creates:** Documentation updates and maintenance artifacts
211+
**Creates:** Documentation updates and maintenance artifacts:
212+
213+
* `.copilot-tracking/doc-ops/{{YYYY-MM-DD}}-session.md` (session tracking for documentation operations)
204214

205215
**Workflow:**
206216

@@ -210,12 +220,24 @@ The Research-Plan-Implement (RPI) workflow provides a structured approach to com
210220

211221
**Critical:** Operates strictly on documentation files and does not modify application or source code
212222

223+
### memory
224+
225+
**Creates:** Repository memory records and session context:
226+
227+
* `.copilot-tracking/memory/{{YYYY-MM-DD}}/{{short-description}}-memory.md` (session continuity context)
228+
* `.copilot-tracking/memory/{{YYYY-MM-DD}}/{{short-description}}-artifacts/` (optional companion files)
229+
* `/memories/repo/<descriptive-name>.jsonl` (durable repository facts for future tasks)
230+
231+
**Workflow:** Identify actionable repository fact → Validate durability → Store with context → Available for future tasks
232+
233+
**Critical:** Stores only durable, reusable facts. Does not store transient discussion, personal preferences, or speculative information.
234+
213235
### security-plan-creator
214236

215237
**Creates:** Security plans and implementation artifacts:
216238

217-
* `security-plan-outputs/security-plan-{blueprint-name}.md`
218-
* `.copilot-tracking/plans/security-plan-{blueprint-name}.plan.md`
239+
* `.copilot-tracking/plans/security-plan-{blueprint-name}.plan.md` (planning artifacts and threat analysis)
240+
* `security-plan-outputs/security-plan-{blueprint-name}.md` (final security plan document)
219241

220242
**Workflow:** Blueprint Selection → Architecture Analysis → Threat Assessment → Plan Generation → Validation
221243

@@ -225,7 +247,8 @@ The Research-Plan-Implement (RPI) workflow provides a structured approach to com
225247

226248
**Creates:** Exploratory data analysis notebooks:
227249

228-
* `notebooks/*.ipynb`
250+
* `notebooks/*.ipynb` (EDA notebooks with parameterized data loading)
251+
* `data/processed/*.parquet` (derived datasets with semantic naming)
229252

230253
**Workflow:** Context Gathering → Notebook Generation → Validation
231254

@@ -235,7 +258,9 @@ The Research-Plan-Implement (RPI) workflow provides a structured approach to com
235258

236259
**Creates:** Multi-page Streamlit applications:
237260

238-
* Dashboard pages and components
261+
* `app.py` (main entry point with page navigation)
262+
* `pages/*.py` (summary statistics, univariate/multivariate analysis, time series)
263+
* `requirements.txt` (pinned dependencies)
239264

240265
**Workflow:** Project Setup → Core Dashboard Development → Advanced Features → Refinement
241266

@@ -245,10 +270,10 @@ The Research-Plan-Implement (RPI) workflow provides a structured approach to com
245270

246271
**Creates:** Data documentation artifacts:
247272

248-
* `outputs/data-dictionary-{{dataset}}-{{YYYY-MM-DD}}.md`
249-
* `outputs/data-profile-{{dataset}}-{{YYYY-MM-DD}}.json`
250-
* `outputs/data-objectives-{{dataset}}-{{YYYY-MM-DD}}.json`
251-
* `outputs/data-summary-{{dataset}}-{{YYYY-MM-DD}}.md`
273+
* `outputs/data-dictionary-{{dataset}}-{{YYYY-MM-DD}}.md` (column definitions and semantics)
274+
* `outputs/data-profile-{{dataset}}-{{YYYY-MM-DD}}.json` (statistical profile for downstream tools)
275+
* `outputs/data-objectives-{{dataset}}-{{YYYY-MM-DD}}.json` (analysis goals and constraints)
276+
* `outputs/data-summary-{{dataset}}-{{YYYY-MM-DD}}.md` (human-readable overview)
252277

253278
**Workflow:** Confirm Scope → Discover Data → Sample & Infer Schema → Profile → Clarify → Emit Artifacts
254279

@@ -258,7 +283,8 @@ The Research-Plan-Implement (RPI) workflow provides a structured approach to com
258283

259284
**Creates:** ASCII architecture diagrams in markdown:
260285

261-
* Inline diagrams with legend and key relationships
286+
* Inline ASCII block diagrams embedded in markdown (pure ASCII for consistent alignment)
287+
* Component legend and relationship key
262288

263289
**Workflow:** Discovery → Parsing → Relationship Mapping → Generation
264290

@@ -268,8 +294,12 @@ The Research-Plan-Implement (RPI) workflow provides a structured approach to com
268294

269295
**Creates:** Issue tracking artifacts:
270296

271-
* `.copilot-tracking/github-issues/issue-{number}.md`
272-
* `.copilot-tracking/github-issues/session-state.md`
297+
* `.copilot-tracking/github-issues/issue-{number}.md` (issue creation logs with API responses)
298+
* `.copilot-tracking/github-issues/issues-list-{timestamp}.md` (navigation session results)
299+
* `.copilot-tracking/github-issues/search-{timestamp}.md` (search query results)
300+
* `.copilot-tracking/github-issues/session-state.md` (active context and filter state)
301+
* `.copilot-tracking/github-issues/draft-issue.md` (working draft before submission)
302+
* `.copilot-tracking/github-issues/current-filters.md` (saved filter configurations)
273303

274304
**Workflow:** Issue Creation | Issue Navigation | Issue Search
275305

@@ -279,9 +309,10 @@ The Research-Plan-Implement (RPI) workflow provides a structured approach to com
279309

280310
**Creates:** Work item planning files:
281311

282-
* `.copilot-tracking/workitems/prds/<artifact-normalized-name>/planning-log.md`
283-
* `.copilot-tracking/workitems/prds/<artifact-normalized-name>/work-items.md`
284-
* `.copilot-tracking/workitems/prds/<artifact-normalized-name>/handoff.md`
312+
* `.copilot-tracking/workitems/prds/<artifact-normalized-name>/planning-log.md` (session activity and decisions)
313+
* `.copilot-tracking/workitems/prds/<artifact-normalized-name>/artifact-analysis.md` (PRD parsing and extraction)
314+
* `.copilot-tracking/workitems/prds/<artifact-normalized-name>/work-items.md` (Epic/Feature/Story hierarchy)
315+
* `.copilot-tracking/workitems/prds/<artifact-normalized-name>/handoff.md` (final handoff for ADO creation)
285316

286317
**Workflow:** Analyze PRD → Discover Codebase → Discover Related Work Items → Refine → Finalize Handoff
287318

@@ -292,7 +323,8 @@ The Research-Plan-Implement (RPI) workflow provides a structured approach to com
292323
**Creates:** Installation configuration and tracking:
293324

294325
* `.hve-tracking.json` (for agent copy tracking)
295-
* Settings updates in `.vscode/settings.json`
326+
* Settings updates in `.vscode/settings.json` (VS Code configuration)
327+
* `.vscode/mcp.json` (MCP server configuration when applicable)
296328

297329
**Workflow:** Environment Detection → Decision Matrix → Installation → Validation → Agent Customization
298330

@@ -302,8 +334,9 @@ The Research-Plan-Implement (RPI) workflow provides a structured approach to com
302334

303335
**Creates:** Test reports and issue documentation:
304336

305-
* Test results summary
306-
* Issue registry with reproduction steps
337+
* Test results summary (pass/fail counts by category)
338+
* Issue registry with reproduction steps (severity-categorized findings)
339+
* Performance metrics (page load times, render benchmarks)
307340

308341
**Workflow:** Environment Setup → Functional Testing → Data Validation → Performance Assessment → Issue Reporting
309342

0 commit comments

Comments
 (0)