@synth-coder/memhub 0.2.2 → 0.2.3

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 (71) hide show
  1. package/.eslintrc.cjs +45 -45
  2. package/.factory/commands/opsx-apply.md +150 -0
  3. package/.factory/commands/opsx-archive.md +155 -0
  4. package/.factory/commands/opsx-explore.md +171 -0
  5. package/.factory/commands/opsx-propose.md +104 -0
  6. package/.factory/skills/openspec-apply-change/SKILL.md +156 -0
  7. package/.factory/skills/openspec-archive-change/SKILL.md +114 -0
  8. package/.factory/skills/openspec-explore/SKILL.md +288 -0
  9. package/.factory/skills/openspec-propose/SKILL.md +110 -0
  10. package/.github/workflows/ci.yml +74 -74
  11. package/.iflow/commands/opsx-apply.md +152 -152
  12. package/.iflow/commands/opsx-archive.md +157 -157
  13. package/.iflow/commands/opsx-explore.md +173 -173
  14. package/.iflow/commands/opsx-propose.md +106 -106
  15. package/.iflow/skills/openspec-apply-change/SKILL.md +156 -156
  16. package/.iflow/skills/openspec-archive-change/SKILL.md +114 -114
  17. package/.iflow/skills/openspec-explore/SKILL.md +288 -288
  18. package/.iflow/skills/openspec-propose/SKILL.md +110 -110
  19. package/.prettierrc +11 -11
  20. package/AGENTS.md +169 -26
  21. package/README.md +195 -195
  22. package/README.zh-CN.md +193 -193
  23. package/dist/src/contracts/mcp.js +34 -34
  24. package/dist/src/server/mcp-server.d.ts +8 -0
  25. package/dist/src/server/mcp-server.d.ts.map +1 -1
  26. package/dist/src/server/mcp-server.js +23 -2
  27. package/dist/src/server/mcp-server.js.map +1 -1
  28. package/dist/src/services/memory-service.d.ts +1 -0
  29. package/dist/src/services/memory-service.d.ts.map +1 -1
  30. package/dist/src/services/memory-service.js +125 -82
  31. package/dist/src/services/memory-service.js.map +1 -1
  32. package/docs/architecture-diagrams.md +368 -0
  33. package/docs/architecture.md +381 -349
  34. package/docs/contracts.md +190 -119
  35. package/docs/prompt-template.md +33 -79
  36. package/docs/proposals/mcp-typescript-sdk-refactor.md +568 -568
  37. package/docs/proposals/proposal-close-gates.md +58 -58
  38. package/docs/tool-calling-policy.md +101 -107
  39. package/docs/vector-search.md +306 -0
  40. package/package.json +59 -58
  41. package/src/contracts/index.ts +12 -12
  42. package/src/contracts/mcp.ts +222 -222
  43. package/src/contracts/schemas.ts +307 -307
  44. package/src/contracts/types.ts +410 -410
  45. package/src/index.ts +8 -8
  46. package/src/server/index.ts +5 -5
  47. package/src/server/mcp-server.ts +185 -161
  48. package/src/services/embedding-service.ts +114 -114
  49. package/src/services/index.ts +5 -5
  50. package/src/services/memory-service.ts +663 -621
  51. package/src/storage/frontmatter-parser.ts +243 -243
  52. package/src/storage/index.ts +6 -6
  53. package/src/storage/markdown-storage.ts +236 -236
  54. package/src/storage/vector-index.ts +160 -160
  55. package/src/utils/index.ts +5 -5
  56. package/src/utils/slugify.ts +63 -63
  57. package/test/contracts/schemas.test.ts +313 -313
  58. package/test/contracts/types.test.ts +21 -21
  59. package/test/frontmatter-parser-more.test.ts +94 -94
  60. package/test/server/mcp-server.test.ts +210 -169
  61. package/test/services/memory-service-edge.test.ts +248 -248
  62. package/test/services/memory-service.test.ts +278 -278
  63. package/test/storage/frontmatter-parser.test.ts +222 -222
  64. package/test/storage/markdown-storage.test.ts +216 -216
  65. package/test/storage/storage-edge.test.ts +238 -238
  66. package/test/storage/vector-index.test.ts +153 -153
  67. package/test/utils/slugify-edge.test.ts +94 -94
  68. package/test/utils/slugify.test.ts +68 -68
  69. package/tsconfig.json +25 -25
  70. package/tsconfig.test.json +8 -8
  71. package/vitest.config.ts +29 -29
@@ -1,106 +1,106 @@
1
- ---
2
- name: /opsx-propose
3
- id: opsx-propose
4
- category: Workflow
5
- description: Propose a new change - create it and generate all artifacts in one step
6
- ---
7
-
8
- Propose a new change - create the change and generate all artifacts in one step.
9
-
10
- I'll create a change with artifacts:
11
- - proposal.md (what & why)
12
- - design.md (how)
13
- - tasks.md (implementation steps)
14
-
15
- When ready to implement, run /opsx:apply
16
-
17
- ---
18
-
19
- **Input**: The argument after `/opsx:propose` is the change name (kebab-case), OR a description of what the user wants to build.
20
-
21
- **Steps**
22
-
23
- 1. **If no input provided, ask what they want to build**
24
-
25
- Use the **AskUserQuestion tool** (open-ended, no preset options) to ask:
26
- > "What change do you want to work on? Describe what you want to build or fix."
27
-
28
- From their description, derive a kebab-case name (e.g., "add user authentication" → `add-user-auth`).
29
-
30
- **IMPORTANT**: Do NOT proceed without understanding what the user wants to build.
31
-
32
- 2. **Create the change directory**
33
- ```bash
34
- openspec new change "<name>"
35
- ```
36
- This creates a scaffolded change at `openspec/changes/<name>/` with `.openspec.yaml`.
37
-
38
- 3. **Get the artifact build order**
39
- ```bash
40
- openspec status --change "<name>" --json
41
- ```
42
- Parse the JSON to get:
43
- - `applyRequires`: array of artifact IDs needed before implementation (e.g., `["tasks"]`)
44
- - `artifacts`: list of all artifacts with their status and dependencies
45
-
46
- 4. **Create artifacts in sequence until apply-ready**
47
-
48
- Use the **TodoWrite tool** to track progress through the artifacts.
49
-
50
- Loop through artifacts in dependency order (artifacts with no pending dependencies first):
51
-
52
- a. **For each artifact that is `ready` (dependencies satisfied)**:
53
- - Get instructions:
54
- ```bash
55
- openspec instructions <artifact-id> --change "<name>" --json
56
- ```
57
- - The instructions JSON includes:
58
- - `context`: Project background (constraints for you - do NOT include in output)
59
- - `rules`: Artifact-specific rules (constraints for you - do NOT include in output)
60
- - `template`: The structure to use for your output file
61
- - `instruction`: Schema-specific guidance for this artifact type
62
- - `outputPath`: Where to write the artifact
63
- - `dependencies`: Completed artifacts to read for context
64
- - Read any completed dependency files for context
65
- - Create the artifact file using `template` as the structure
66
- - Apply `context` and `rules` as constraints - but do NOT copy them into the file
67
- - Show brief progress: "Created <artifact-id>"
68
-
69
- b. **Continue until all `applyRequires` artifacts are complete**
70
- - After creating each artifact, re-run `openspec status --change "<name>" --json`
71
- - Check if every artifact ID in `applyRequires` has `status: "done"` in the artifacts array
72
- - Stop when all `applyRequires` artifacts are done
73
-
74
- c. **If an artifact requires user input** (unclear context):
75
- - Use **AskUserQuestion tool** to clarify
76
- - Then continue with creation
77
-
78
- 5. **Show final status**
79
- ```bash
80
- openspec status --change "<name>"
81
- ```
82
-
83
- **Output**
84
-
85
- After completing all artifacts, summarize:
86
- - Change name and location
87
- - List of artifacts created with brief descriptions
88
- - What's ready: "All artifacts created! Ready for implementation."
89
- - Prompt: "Run `/opsx:apply` to start implementing."
90
-
91
- **Artifact Creation Guidelines**
92
-
93
- - Follow the `instruction` field from `openspec instructions` for each artifact type
94
- - The schema defines what each artifact should contain - follow it
95
- - Read dependency artifacts for context before creating new ones
96
- - Use `template` as the structure for your output file - fill in its sections
97
- - **IMPORTANT**: `context` and `rules` are constraints for YOU, not content for the file
98
- - Do NOT copy `<context>`, `<rules>`, `<project_context>` blocks into the artifact
99
- - These guide what you write, but should never appear in the output
100
-
101
- **Guardrails**
102
- - Create ALL artifacts needed for implementation (as defined by schema's `apply.requires`)
103
- - Always read dependency artifacts before creating a new one
104
- - If context is critically unclear, ask the user - but prefer making reasonable decisions to keep momentum
105
- - If a change with that name already exists, ask if user wants to continue it or create a new one
106
- - Verify each artifact file exists after writing before proceeding to next
1
+ ---
2
+ name: /opsx-propose
3
+ id: opsx-propose
4
+ category: Workflow
5
+ description: Propose a new change - create it and generate all artifacts in one step
6
+ ---
7
+
8
+ Propose a new change - create the change and generate all artifacts in one step.
9
+
10
+ I'll create a change with artifacts:
11
+ - proposal.md (what & why)
12
+ - design.md (how)
13
+ - tasks.md (implementation steps)
14
+
15
+ When ready to implement, run /opsx:apply
16
+
17
+ ---
18
+
19
+ **Input**: The argument after `/opsx:propose` is the change name (kebab-case), OR a description of what the user wants to build.
20
+
21
+ **Steps**
22
+
23
+ 1. **If no input provided, ask what they want to build**
24
+
25
+ Use the **AskUserQuestion tool** (open-ended, no preset options) to ask:
26
+ > "What change do you want to work on? Describe what you want to build or fix."
27
+
28
+ From their description, derive a kebab-case name (e.g., "add user authentication" → `add-user-auth`).
29
+
30
+ **IMPORTANT**: Do NOT proceed without understanding what the user wants to build.
31
+
32
+ 2. **Create the change directory**
33
+ ```bash
34
+ openspec new change "<name>"
35
+ ```
36
+ This creates a scaffolded change at `openspec/changes/<name>/` with `.openspec.yaml`.
37
+
38
+ 3. **Get the artifact build order**
39
+ ```bash
40
+ openspec status --change "<name>" --json
41
+ ```
42
+ Parse the JSON to get:
43
+ - `applyRequires`: array of artifact IDs needed before implementation (e.g., `["tasks"]`)
44
+ - `artifacts`: list of all artifacts with their status and dependencies
45
+
46
+ 4. **Create artifacts in sequence until apply-ready**
47
+
48
+ Use the **TodoWrite tool** to track progress through the artifacts.
49
+
50
+ Loop through artifacts in dependency order (artifacts with no pending dependencies first):
51
+
52
+ a. **For each artifact that is `ready` (dependencies satisfied)**:
53
+ - Get instructions:
54
+ ```bash
55
+ openspec instructions <artifact-id> --change "<name>" --json
56
+ ```
57
+ - The instructions JSON includes:
58
+ - `context`: Project background (constraints for you - do NOT include in output)
59
+ - `rules`: Artifact-specific rules (constraints for you - do NOT include in output)
60
+ - `template`: The structure to use for your output file
61
+ - `instruction`: Schema-specific guidance for this artifact type
62
+ - `outputPath`: Where to write the artifact
63
+ - `dependencies`: Completed artifacts to read for context
64
+ - Read any completed dependency files for context
65
+ - Create the artifact file using `template` as the structure
66
+ - Apply `context` and `rules` as constraints - but do NOT copy them into the file
67
+ - Show brief progress: "Created <artifact-id>"
68
+
69
+ b. **Continue until all `applyRequires` artifacts are complete**
70
+ - After creating each artifact, re-run `openspec status --change "<name>" --json`
71
+ - Check if every artifact ID in `applyRequires` has `status: "done"` in the artifacts array
72
+ - Stop when all `applyRequires` artifacts are done
73
+
74
+ c. **If an artifact requires user input** (unclear context):
75
+ - Use **AskUserQuestion tool** to clarify
76
+ - Then continue with creation
77
+
78
+ 5. **Show final status**
79
+ ```bash
80
+ openspec status --change "<name>"
81
+ ```
82
+
83
+ **Output**
84
+
85
+ After completing all artifacts, summarize:
86
+ - Change name and location
87
+ - List of artifacts created with brief descriptions
88
+ - What's ready: "All artifacts created! Ready for implementation."
89
+ - Prompt: "Run `/opsx:apply` to start implementing."
90
+
91
+ **Artifact Creation Guidelines**
92
+
93
+ - Follow the `instruction` field from `openspec instructions` for each artifact type
94
+ - The schema defines what each artifact should contain - follow it
95
+ - Read dependency artifacts for context before creating new ones
96
+ - Use `template` as the structure for your output file - fill in its sections
97
+ - **IMPORTANT**: `context` and `rules` are constraints for YOU, not content for the file
98
+ - Do NOT copy `<context>`, `<rules>`, `<project_context>` blocks into the artifact
99
+ - These guide what you write, but should never appear in the output
100
+
101
+ **Guardrails**
102
+ - Create ALL artifacts needed for implementation (as defined by schema's `apply.requires`)
103
+ - Always read dependency artifacts before creating a new one
104
+ - If context is critically unclear, ask the user - but prefer making reasonable decisions to keep momentum
105
+ - If a change with that name already exists, ask if user wants to continue it or create a new one
106
+ - Verify each artifact file exists after writing before proceeding to next
@@ -1,156 +1,156 @@
1
- ---
2
- name: openspec-apply-change
3
- description: Implement tasks from an OpenSpec change. Use when the user wants to start implementing, continue implementation, or work through tasks.
4
- license: MIT
5
- compatibility: Requires openspec CLI.
6
- metadata:
7
- author: openspec
8
- version: "1.0"
9
- generatedBy: "1.2.0"
10
- ---
11
-
12
- Implement tasks from an OpenSpec change.
13
-
14
- **Input**: Optionally specify a change name. If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
15
-
16
- **Steps**
17
-
18
- 1. **Select the change**
19
-
20
- If a name is provided, use it. Otherwise:
21
- - Infer from conversation context if the user mentioned a change
22
- - Auto-select if only one active change exists
23
- - If ambiguous, run `openspec list --json` to get available changes and use the **AskUserQuestion tool** to let the user select
24
-
25
- Always announce: "Using change: <name>" and how to override (e.g., `/opsx:apply <other>`).
26
-
27
- 2. **Check status to understand the schema**
28
- ```bash
29
- openspec status --change "<name>" --json
30
- ```
31
- Parse the JSON to understand:
32
- - `schemaName`: The workflow being used (e.g., "spec-driven")
33
- - Which artifact contains the tasks (typically "tasks" for spec-driven, check status for others)
34
-
35
- 3. **Get apply instructions**
36
-
37
- ```bash
38
- openspec instructions apply --change "<name>" --json
39
- ```
40
-
41
- This returns:
42
- - Context file paths (varies by schema - could be proposal/specs/design/tasks or spec/tests/implementation/docs)
43
- - Progress (total, complete, remaining)
44
- - Task list with status
45
- - Dynamic instruction based on current state
46
-
47
- **Handle states:**
48
- - If `state: "blocked"` (missing artifacts): show message, suggest using openspec-continue-change
49
- - If `state: "all_done"`: congratulate, suggest archive
50
- - Otherwise: proceed to implementation
51
-
52
- 4. **Read context files**
53
-
54
- Read the files listed in `contextFiles` from the apply instructions output.
55
- The files depend on the schema being used:
56
- - **spec-driven**: proposal, specs, design, tasks
57
- - Other schemas: follow the contextFiles from CLI output
58
-
59
- 5. **Show current progress**
60
-
61
- Display:
62
- - Schema being used
63
- - Progress: "N/M tasks complete"
64
- - Remaining tasks overview
65
- - Dynamic instruction from CLI
66
-
67
- 6. **Implement tasks (loop until done or blocked)**
68
-
69
- For each pending task:
70
- - Show which task is being worked on
71
- - Make the code changes required
72
- - Keep changes minimal and focused
73
- - Mark task complete in the tasks file: `- [ ]` → `- [x]`
74
- - Continue to next task
75
-
76
- **Pause if:**
77
- - Task is unclear → ask for clarification
78
- - Implementation reveals a design issue → suggest updating artifacts
79
- - Error or blocker encountered → report and wait for guidance
80
- - User interrupts
81
-
82
- 7. **On completion or pause, show status**
83
-
84
- Display:
85
- - Tasks completed this session
86
- - Overall progress: "N/M tasks complete"
87
- - If all done: suggest archive
88
- - If paused: explain why and wait for guidance
89
-
90
- **Output During Implementation**
91
-
92
- ```
93
- ## Implementing: <change-name> (schema: <schema-name>)
94
-
95
- Working on task 3/7: <task description>
96
- [...implementation happening...]
97
- ✓ Task complete
98
-
99
- Working on task 4/7: <task description>
100
- [...implementation happening...]
101
- ✓ Task complete
102
- ```
103
-
104
- **Output On Completion**
105
-
106
- ```
107
- ## Implementation Complete
108
-
109
- **Change:** <change-name>
110
- **Schema:** <schema-name>
111
- **Progress:** 7/7 tasks complete ✓
112
-
113
- ### Completed This Session
114
- - [x] Task 1
115
- - [x] Task 2
116
- ...
117
-
118
- All tasks complete! Ready to archive this change.
119
- ```
120
-
121
- **Output On Pause (Issue Encountered)**
122
-
123
- ```
124
- ## Implementation Paused
125
-
126
- **Change:** <change-name>
127
- **Schema:** <schema-name>
128
- **Progress:** 4/7 tasks complete
129
-
130
- ### Issue Encountered
131
- <description of the issue>
132
-
133
- **Options:**
134
- 1. <option 1>
135
- 2. <option 2>
136
- 3. Other approach
137
-
138
- What would you like to do?
139
- ```
140
-
141
- **Guardrails**
142
- - Keep going through tasks until done or blocked
143
- - Always read context files before starting (from the apply instructions output)
144
- - If task is ambiguous, pause and ask before implementing
145
- - If implementation reveals issues, pause and suggest artifact updates
146
- - Keep code changes minimal and scoped to each task
147
- - Update task checkbox immediately after completing each task
148
- - Pause on errors, blockers, or unclear requirements - don't guess
149
- - Use contextFiles from CLI output, don't assume specific file names
150
-
151
- **Fluid Workflow Integration**
152
-
153
- This skill supports the "actions on a change" model:
154
-
155
- - **Can be invoked anytime**: Before all artifacts are done (if tasks exist), after partial implementation, interleaved with other actions
156
- - **Allows artifact updates**: If implementation reveals design issues, suggest updating artifacts - not phase-locked, work fluidly
1
+ ---
2
+ name: openspec-apply-change
3
+ description: Implement tasks from an OpenSpec change. Use when the user wants to start implementing, continue implementation, or work through tasks.
4
+ license: MIT
5
+ compatibility: Requires openspec CLI.
6
+ metadata:
7
+ author: openspec
8
+ version: "1.0"
9
+ generatedBy: "1.2.0"
10
+ ---
11
+
12
+ Implement tasks from an OpenSpec change.
13
+
14
+ **Input**: Optionally specify a change name. If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
15
+
16
+ **Steps**
17
+
18
+ 1. **Select the change**
19
+
20
+ If a name is provided, use it. Otherwise:
21
+ - Infer from conversation context if the user mentioned a change
22
+ - Auto-select if only one active change exists
23
+ - If ambiguous, run `openspec list --json` to get available changes and use the **AskUserQuestion tool** to let the user select
24
+
25
+ Always announce: "Using change: <name>" and how to override (e.g., `/opsx:apply <other>`).
26
+
27
+ 2. **Check status to understand the schema**
28
+ ```bash
29
+ openspec status --change "<name>" --json
30
+ ```
31
+ Parse the JSON to understand:
32
+ - `schemaName`: The workflow being used (e.g., "spec-driven")
33
+ - Which artifact contains the tasks (typically "tasks" for spec-driven, check status for others)
34
+
35
+ 3. **Get apply instructions**
36
+
37
+ ```bash
38
+ openspec instructions apply --change "<name>" --json
39
+ ```
40
+
41
+ This returns:
42
+ - Context file paths (varies by schema - could be proposal/specs/design/tasks or spec/tests/implementation/docs)
43
+ - Progress (total, complete, remaining)
44
+ - Task list with status
45
+ - Dynamic instruction based on current state
46
+
47
+ **Handle states:**
48
+ - If `state: "blocked"` (missing artifacts): show message, suggest using openspec-continue-change
49
+ - If `state: "all_done"`: congratulate, suggest archive
50
+ - Otherwise: proceed to implementation
51
+
52
+ 4. **Read context files**
53
+
54
+ Read the files listed in `contextFiles` from the apply instructions output.
55
+ The files depend on the schema being used:
56
+ - **spec-driven**: proposal, specs, design, tasks
57
+ - Other schemas: follow the contextFiles from CLI output
58
+
59
+ 5. **Show current progress**
60
+
61
+ Display:
62
+ - Schema being used
63
+ - Progress: "N/M tasks complete"
64
+ - Remaining tasks overview
65
+ - Dynamic instruction from CLI
66
+
67
+ 6. **Implement tasks (loop until done or blocked)**
68
+
69
+ For each pending task:
70
+ - Show which task is being worked on
71
+ - Make the code changes required
72
+ - Keep changes minimal and focused
73
+ - Mark task complete in the tasks file: `- [ ]` → `- [x]`
74
+ - Continue to next task
75
+
76
+ **Pause if:**
77
+ - Task is unclear → ask for clarification
78
+ - Implementation reveals a design issue → suggest updating artifacts
79
+ - Error or blocker encountered → report and wait for guidance
80
+ - User interrupts
81
+
82
+ 7. **On completion or pause, show status**
83
+
84
+ Display:
85
+ - Tasks completed this session
86
+ - Overall progress: "N/M tasks complete"
87
+ - If all done: suggest archive
88
+ - If paused: explain why and wait for guidance
89
+
90
+ **Output During Implementation**
91
+
92
+ ```
93
+ ## Implementing: <change-name> (schema: <schema-name>)
94
+
95
+ Working on task 3/7: <task description>
96
+ [...implementation happening...]
97
+ ✓ Task complete
98
+
99
+ Working on task 4/7: <task description>
100
+ [...implementation happening...]
101
+ ✓ Task complete
102
+ ```
103
+
104
+ **Output On Completion**
105
+
106
+ ```
107
+ ## Implementation Complete
108
+
109
+ **Change:** <change-name>
110
+ **Schema:** <schema-name>
111
+ **Progress:** 7/7 tasks complete ✓
112
+
113
+ ### Completed This Session
114
+ - [x] Task 1
115
+ - [x] Task 2
116
+ ...
117
+
118
+ All tasks complete! Ready to archive this change.
119
+ ```
120
+
121
+ **Output On Pause (Issue Encountered)**
122
+
123
+ ```
124
+ ## Implementation Paused
125
+
126
+ **Change:** <change-name>
127
+ **Schema:** <schema-name>
128
+ **Progress:** 4/7 tasks complete
129
+
130
+ ### Issue Encountered
131
+ <description of the issue>
132
+
133
+ **Options:**
134
+ 1. <option 1>
135
+ 2. <option 2>
136
+ 3. Other approach
137
+
138
+ What would you like to do?
139
+ ```
140
+
141
+ **Guardrails**
142
+ - Keep going through tasks until done or blocked
143
+ - Always read context files before starting (from the apply instructions output)
144
+ - If task is ambiguous, pause and ask before implementing
145
+ - If implementation reveals issues, pause and suggest artifact updates
146
+ - Keep code changes minimal and scoped to each task
147
+ - Update task checkbox immediately after completing each task
148
+ - Pause on errors, blockers, or unclear requirements - don't guess
149
+ - Use contextFiles from CLI output, don't assume specific file names
150
+
151
+ **Fluid Workflow Integration**
152
+
153
+ This skill supports the "actions on a change" model:
154
+
155
+ - **Can be invoked anytime**: Before all artifacts are done (if tasks exist), after partial implementation, interleaved with other actions
156
+ - **Allows artifact updates**: If implementation reveals design issues, suggest updating artifacts - not phase-locked, work fluidly