retestkit 1.4.1

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 (327) hide show
  1. package/.claude/commands/openspec/apply.md +23 -0
  2. package/.claude/commands/openspec/archive.md +27 -0
  3. package/.claude/commands/openspec/proposal.md +28 -0
  4. package/.gemini/commands/openspec/apply.toml +21 -0
  5. package/.gemini/commands/openspec/archive.toml +25 -0
  6. package/.gemini/commands/openspec/proposal.toml +26 -0
  7. package/.github/prompts/openspec-apply.prompt.md +22 -0
  8. package/.github/prompts/openspec-archive.prompt.md +26 -0
  9. package/.github/prompts/openspec-proposal.prompt.md +27 -0
  10. package/.github/workflows/release.yml +33 -0
  11. package/.kilocode/workflows/openspec-apply.md +17 -0
  12. package/.kilocode/workflows/openspec-archive.md +21 -0
  13. package/.kilocode/workflows/openspec-proposal.md +22 -0
  14. package/.mcp.json +23 -0
  15. package/.opencode/command/openspec-apply.md +25 -0
  16. package/.opencode/command/openspec-archive.md +28 -0
  17. package/.opencode/command/openspec-proposal.md +30 -0
  18. package/.roo/commands/openspec-apply.md +20 -0
  19. package/.roo/commands/openspec-archive.md +24 -0
  20. package/.roo/commands/openspec-proposal.md +25 -0
  21. package/.vscode/mcp.json +23 -0
  22. package/AGENTS.md +18 -0
  23. package/CLAUDE.md +18 -0
  24. package/LICENSE +65 -0
  25. package/README.md +303 -0
  26. package/dist/config.d.ts +4 -0
  27. package/dist/config.d.ts.map +1 -0
  28. package/dist/config.js +27 -0
  29. package/dist/config.js.map +1 -0
  30. package/dist/elicitation/index.d.ts +17 -0
  31. package/dist/elicitation/index.d.ts.map +1 -0
  32. package/dist/elicitation/index.js +118 -0
  33. package/dist/elicitation/index.js.map +1 -0
  34. package/dist/elicitation/types.d.ts +35 -0
  35. package/dist/elicitation/types.d.ts.map +1 -0
  36. package/dist/elicitation/types.js +39 -0
  37. package/dist/elicitation/types.js.map +1 -0
  38. package/dist/index.d.ts +3 -0
  39. package/dist/index.d.ts.map +1 -0
  40. package/dist/index.js +76 -0
  41. package/dist/index.js.map +1 -0
  42. package/dist/lifecycle/index.d.ts +31 -0
  43. package/dist/lifecycle/index.d.ts.map +1 -0
  44. package/dist/lifecycle/index.js +61 -0
  45. package/dist/lifecycle/index.js.map +1 -0
  46. package/dist/logger.d.ts +21 -0
  47. package/dist/logger.d.ts.map +1 -0
  48. package/dist/logger.js +182 -0
  49. package/dist/logger.js.map +1 -0
  50. package/dist/playwright-client/index.d.ts +29 -0
  51. package/dist/playwright-client/index.d.ts.map +1 -0
  52. package/dist/playwright-client/index.js +288 -0
  53. package/dist/playwright-client/index.js.map +1 -0
  54. package/dist/playwright-client/types.d.ts +44 -0
  55. package/dist/playwright-client/types.d.ts.map +1 -0
  56. package/dist/playwright-client/types.js +49 -0
  57. package/dist/playwright-client/types.js.map +1 -0
  58. package/dist/progress/index.d.ts +39 -0
  59. package/dist/progress/index.d.ts.map +1 -0
  60. package/dist/progress/index.js +106 -0
  61. package/dist/progress/index.js.map +1 -0
  62. package/dist/progress/types.d.ts +24 -0
  63. package/dist/progress/types.d.ts.map +1 -0
  64. package/dist/progress/types.js +2 -0
  65. package/dist/progress/types.js.map +1 -0
  66. package/dist/prompts/index.d.ts +19 -0
  67. package/dist/prompts/index.d.ts.map +1 -0
  68. package/dist/prompts/index.js +207 -0
  69. package/dist/prompts/index.js.map +1 -0
  70. package/dist/prompts/loader.d.ts +20 -0
  71. package/dist/prompts/loader.d.ts.map +1 -0
  72. package/dist/prompts/loader.js +47 -0
  73. package/dist/prompts/loader.js.map +1 -0
  74. package/dist/resources/index.d.ts +27 -0
  75. package/dist/resources/index.d.ts.map +1 -0
  76. package/dist/resources/index.js +186 -0
  77. package/dist/resources/index.js.map +1 -0
  78. package/dist/resources/subscriptions.d.ts +10 -0
  79. package/dist/resources/subscriptions.d.ts.map +1 -0
  80. package/dist/resources/subscriptions.js +23 -0
  81. package/dist/resources/subscriptions.js.map +1 -0
  82. package/dist/sampling/index.d.ts +11 -0
  83. package/dist/sampling/index.d.ts.map +1 -0
  84. package/dist/sampling/index.js +201 -0
  85. package/dist/sampling/index.js.map +1 -0
  86. package/dist/sampling/prompts.d.ts +56 -0
  87. package/dist/sampling/prompts.d.ts.map +1 -0
  88. package/dist/sampling/prompts.js +124 -0
  89. package/dist/sampling/prompts.js.map +1 -0
  90. package/dist/sampling/types.d.ts +57 -0
  91. package/dist/sampling/types.d.ts.map +1 -0
  92. package/dist/sampling/types.js +2 -0
  93. package/dist/sampling/types.js.map +1 -0
  94. package/dist/schemas/config.d.ts +40 -0
  95. package/dist/schemas/config.d.ts.map +1 -0
  96. package/dist/schemas/config.js +30 -0
  97. package/dist/schemas/config.js.map +1 -0
  98. package/dist/security/index.d.ts +38 -0
  99. package/dist/security/index.d.ts.map +1 -0
  100. package/dist/security/index.js +281 -0
  101. package/dist/security/index.js.map +1 -0
  102. package/dist/server.d.ts +9 -0
  103. package/dist/server.d.ts.map +1 -0
  104. package/dist/server.js +142 -0
  105. package/dist/server.js.map +1 -0
  106. package/dist/test-utils/index.d.ts +6 -0
  107. package/dist/test-utils/index.d.ts.map +1 -0
  108. package/dist/test-utils/index.js +6 -0
  109. package/dist/test-utils/index.js.map +1 -0
  110. package/dist/test-utils/mock-context.d.ts +64 -0
  111. package/dist/test-utils/mock-context.d.ts.map +1 -0
  112. package/dist/test-utils/mock-context.js +347 -0
  113. package/dist/test-utils/mock-context.js.map +1 -0
  114. package/dist/test-utils/mock-playwright-client.d.ts +62 -0
  115. package/dist/test-utils/mock-playwright-client.d.ts.map +1 -0
  116. package/dist/test-utils/mock-playwright-client.js +315 -0
  117. package/dist/test-utils/mock-playwright-client.js.map +1 -0
  118. package/dist/tools/index.d.ts +4 -0
  119. package/dist/tools/index.d.ts.map +1 -0
  120. package/dist/tools/index.js +8 -0
  121. package/dist/tools/index.js.map +1 -0
  122. package/dist/tools/webtest/crawl.d.ts +46 -0
  123. package/dist/tools/webtest/crawl.d.ts.map +1 -0
  124. package/dist/tools/webtest/crawl.js +678 -0
  125. package/dist/tools/webtest/crawl.js.map +1 -0
  126. package/dist/tools/webtest/discover-features.d.ts +30 -0
  127. package/dist/tools/webtest/discover-features.d.ts.map +1 -0
  128. package/dist/tools/webtest/discover-features.js +343 -0
  129. package/dist/tools/webtest/discover-features.js.map +1 -0
  130. package/dist/tools/webtest/discover-flows.d.ts +29 -0
  131. package/dist/tools/webtest/discover-flows.d.ts.map +1 -0
  132. package/dist/tools/webtest/discover-flows.js +341 -0
  133. package/dist/tools/webtest/discover-flows.js.map +1 -0
  134. package/dist/tools/webtest/generate-tests.d.ts +54 -0
  135. package/dist/tools/webtest/generate-tests.d.ts.map +1 -0
  136. package/dist/tools/webtest/generate-tests.js +364 -0
  137. package/dist/tools/webtest/generate-tests.js.map +1 -0
  138. package/dist/tools/webtest/index.d.ts +8 -0
  139. package/dist/tools/webtest/index.d.ts.map +1 -0
  140. package/dist/tools/webtest/index.js +8 -0
  141. package/dist/tools/webtest/index.js.map +1 -0
  142. package/dist/tools/webtest/run-test-case.d.ts +28 -0
  143. package/dist/tools/webtest/run-test-case.d.ts.map +1 -0
  144. package/dist/tools/webtest/run-test-case.js +420 -0
  145. package/dist/tools/webtest/run-test-case.js.map +1 -0
  146. package/dist/tools/webtest/schemas.d.ts +175 -0
  147. package/dist/tools/webtest/schemas.d.ts.map +1 -0
  148. package/dist/tools/webtest/schemas.js +156 -0
  149. package/dist/tools/webtest/schemas.js.map +1 -0
  150. package/dist/tools/webtest/start-analysis.d.ts +16 -0
  151. package/dist/tools/webtest/start-analysis.d.ts.map +1 -0
  152. package/dist/tools/webtest/start-analysis.js +137 -0
  153. package/dist/tools/webtest/start-analysis.js.map +1 -0
  154. package/dist/transports/http.d.ts +8 -0
  155. package/dist/transports/http.d.ts.map +1 -0
  156. package/dist/transports/http.js +9 -0
  157. package/dist/transports/http.js.map +1 -0
  158. package/dist/transports/index.d.ts +14 -0
  159. package/dist/transports/index.d.ts.map +1 -0
  160. package/dist/transports/index.js +20 -0
  161. package/dist/transports/index.js.map +1 -0
  162. package/dist/transports/stdio.d.ts +4 -0
  163. package/dist/transports/stdio.d.ts.map +1 -0
  164. package/dist/transports/stdio.js +6 -0
  165. package/dist/transports/stdio.js.map +1 -0
  166. package/dist/types/capabilities.d.ts +18 -0
  167. package/dist/types/capabilities.d.ts.map +1 -0
  168. package/dist/types/capabilities.js +35 -0
  169. package/dist/types/capabilities.js.map +1 -0
  170. package/dist/types/context.d.ts +20 -0
  171. package/dist/types/context.d.ts.map +1 -0
  172. package/dist/types/context.js +2 -0
  173. package/dist/types/context.js.map +1 -0
  174. package/dist/types/tool.d.ts +10 -0
  175. package/dist/types/tool.d.ts.map +1 -0
  176. package/dist/types/tool.js +2 -0
  177. package/dist/types/tool.js.map +1 -0
  178. package/dist/workspace/index.d.ts +99 -0
  179. package/dist/workspace/index.d.ts.map +1 -0
  180. package/dist/workspace/index.js +648 -0
  181. package/dist/workspace/index.js.map +1 -0
  182. package/dist/workspace/markdown.d.ts +50 -0
  183. package/dist/workspace/markdown.d.ts.map +1 -0
  184. package/dist/workspace/markdown.js +210 -0
  185. package/dist/workspace/markdown.js.map +1 -0
  186. package/dist/workspace/types.d.ts +173 -0
  187. package/dist/workspace/types.d.ts.map +1 -0
  188. package/dist/workspace/types.js +2 -0
  189. package/dist/workspace/types.js.map +1 -0
  190. package/openspec/AGENTS.md +456 -0
  191. package/openspec/changes/archive/2025-12-18-add-hybrid-artifact-paths/proposal.md +33 -0
  192. package/openspec/changes/archive/2025-12-18-add-hybrid-artifact-paths/specs/webtest-resources/spec.md +27 -0
  193. package/openspec/changes/archive/2025-12-18-add-hybrid-artifact-paths/specs/webtest-tools/spec.md +304 -0
  194. package/openspec/changes/archive/2025-12-18-add-hybrid-artifact-paths/tasks.md +43 -0
  195. package/openspec/changes/archive/2025-12-18-add-mcp-server-foundation/design.md +209 -0
  196. package/openspec/changes/archive/2025-12-18-add-mcp-server-foundation/proposal.md +41 -0
  197. package/openspec/changes/archive/2025-12-18-add-mcp-server-foundation/specs/mcp-server-core/spec.md +183 -0
  198. package/openspec/changes/archive/2025-12-18-add-mcp-server-foundation/tasks.md +112 -0
  199. package/openspec/changes/archive/2025-12-18-add-webtest-orchestrator/design.md +333 -0
  200. package/openspec/changes/archive/2025-12-18-add-webtest-orchestrator/proposal.md +66 -0
  201. package/openspec/changes/archive/2025-12-18-add-webtest-orchestrator/specs/mcp-server-core/spec.md +129 -0
  202. package/openspec/changes/archive/2025-12-18-add-webtest-orchestrator/specs/webtest-lifecycle/spec.md +138 -0
  203. package/openspec/changes/archive/2025-12-18-add-webtest-orchestrator/specs/webtest-logging/spec.md +211 -0
  204. package/openspec/changes/archive/2025-12-18-add-webtest-orchestrator/specs/webtest-prompts/spec.md +157 -0
  205. package/openspec/changes/archive/2025-12-18-add-webtest-orchestrator/specs/webtest-resources/spec.md +213 -0
  206. package/openspec/changes/archive/2025-12-18-add-webtest-orchestrator/specs/webtest-sampling/spec.md +257 -0
  207. package/openspec/changes/archive/2025-12-18-add-webtest-orchestrator/specs/webtest-tools/spec.md +501 -0
  208. package/openspec/changes/archive/2025-12-18-add-webtest-orchestrator/tasks.md +264 -0
  209. package/openspec/changes/archive/2025-12-18-allow-analysis-of-incomplete-crawls/proposal.md +24 -0
  210. package/openspec/changes/archive/2025-12-18-allow-analysis-of-incomplete-crawls/specs/webtest-tools/spec.md +80 -0
  211. package/openspec/changes/archive/2025-12-18-allow-analysis-of-incomplete-crawls/tasks.md +8 -0
  212. package/openspec/changes/archive/2025-12-18-fix-crawl-loop-stability/design.md +90 -0
  213. package/openspec/changes/archive/2025-12-18-fix-crawl-loop-stability/proposal.md +28 -0
  214. package/openspec/changes/archive/2025-12-18-fix-crawl-loop-stability/specs/webtest-sampling/spec.md +90 -0
  215. package/openspec/changes/archive/2025-12-18-fix-crawl-loop-stability/tasks.md +33 -0
  216. package/openspec/changes/archive/2025-12-18-use-markdown-artifacts/design.md +558 -0
  217. package/openspec/changes/archive/2025-12-18-use-markdown-artifacts/proposal.md +119 -0
  218. package/openspec/changes/archive/2025-12-18-use-markdown-artifacts/specs/webtest-resources/spec.md +109 -0
  219. package/openspec/changes/archive/2025-12-18-use-markdown-artifacts/specs/webtest-tools/spec.md +121 -0
  220. package/openspec/changes/archive/2025-12-18-use-markdown-artifacts/tasks.md +133 -0
  221. package/openspec/changes/extract-prompts-to-markdown/design.md +86 -0
  222. package/openspec/changes/extract-prompts-to-markdown/proposal.md +50 -0
  223. package/openspec/changes/extract-prompts-to-markdown/specs/webtest-prompts/spec.md +74 -0
  224. package/openspec/changes/extract-prompts-to-markdown/tasks.md +40 -0
  225. package/openspec/changes/refactor-webtest-naming/design.md +95 -0
  226. package/openspec/changes/refactor-webtest-naming/proposal.md +66 -0
  227. package/openspec/changes/refactor-webtest-naming/specs/webtest-prompts/spec.md +79 -0
  228. package/openspec/changes/refactor-webtest-naming/specs/webtest-resources/spec.md +80 -0
  229. package/openspec/changes/refactor-webtest-naming/specs/webtest-sampling/spec.md +122 -0
  230. package/openspec/changes/refactor-webtest-naming/specs/webtest-tools/spec.md +113 -0
  231. package/openspec/changes/refactor-webtest-naming/tasks.md +119 -0
  232. package/openspec/changes/rename-package-to-retest/proposal.md +52 -0
  233. package/openspec/changes/rename-package-to-retest/specs/mcp-server-core/spec.md +53 -0
  234. package/openspec/changes/rename-package-to-retest/specs/retest-lifecycle/spec.md +68 -0
  235. package/openspec/changes/rename-package-to-retest/specs/retest-logging/spec.md +35 -0
  236. package/openspec/changes/rename-package-to-retest/specs/retest-prompts/spec.md +159 -0
  237. package/openspec/changes/rename-package-to-retest/specs/retest-resources/spec.md +251 -0
  238. package/openspec/changes/rename-package-to-retest/specs/retest-sampling/spec.md +99 -0
  239. package/openspec/changes/rename-package-to-retest/specs/retest-tools/spec.md +295 -0
  240. package/openspec/changes/rename-package-to-retest/tasks.md +71 -0
  241. package/openspec/project.md +31 -0
  242. package/openspec/specs/mcp-server-core/spec.md +178 -0
  243. package/openspec/specs/webtest-lifecycle/spec.md +136 -0
  244. package/openspec/specs/webtest-logging/spec.md +209 -0
  245. package/openspec/specs/webtest-prompts/spec.md +155 -0
  246. package/openspec/specs/webtest-resources/spec.md +248 -0
  247. package/openspec/specs/webtest-sampling/spec.md +344 -0
  248. package/openspec/specs/webtest-tools/spec.md +282 -0
  249. package/package.json +54 -0
  250. package/release.config.js +9 -0
  251. package/src/config.test.ts +96 -0
  252. package/src/config.ts +32 -0
  253. package/src/elicitation/index.test.ts +399 -0
  254. package/src/elicitation/index.ts +171 -0
  255. package/src/elicitation/types.ts +68 -0
  256. package/src/index.ts +83 -0
  257. package/src/lifecycle/index.test.ts +260 -0
  258. package/src/lifecycle/index.ts +101 -0
  259. package/src/logger.redaction.test.ts +322 -0
  260. package/src/logger.test.ts +123 -0
  261. package/src/logger.ts +229 -0
  262. package/src/playwright-client/index.ts +392 -0
  263. package/src/playwright-client/types.ts +99 -0
  264. package/src/progress/index.test.ts +327 -0
  265. package/src/progress/index.ts +170 -0
  266. package/src/progress/types.ts +25 -0
  267. package/src/prompts/index.test.ts +451 -0
  268. package/src/prompts/index.ts +246 -0
  269. package/src/prompts/loader.test.ts +100 -0
  270. package/src/prompts/loader.ts +59 -0
  271. package/src/prompts/templates/mcp/webtest-crawl.md +7 -0
  272. package/src/prompts/templates/mcp/webtest-discover-flows.md +11 -0
  273. package/src/prompts/templates/mcp/webtest-discover.md +12 -0
  274. package/src/prompts/templates/mcp/webtest-full-workflow.md +12 -0
  275. package/src/prompts/templates/mcp/webtest-generate-tests.md +11 -0
  276. package/src/prompts/templates/mcp/webtest-run-test.md +11 -0
  277. package/src/prompts/templates/mcp/webtest-start.md +8 -0
  278. package/src/prompts/templates/sampling/crawl-action.md +35 -0
  279. package/src/prompts/templates/sampling/feature-discovery.md +27 -0
  280. package/src/prompts/templates/sampling/flow-discovery.md +29 -0
  281. package/src/prompts/templates/sampling/page-content-wrapper.md +5 -0
  282. package/src/prompts/templates/sampling/system-prefix.md +12 -0
  283. package/src/prompts/templates/sampling/test-evaluation.md +17 -0
  284. package/src/prompts/templates/sampling/test-generation.md +31 -0
  285. package/src/resources/index.ts +250 -0
  286. package/src/resources/subscriptions.ts +37 -0
  287. package/src/sampling/index.test.ts +414 -0
  288. package/src/sampling/index.ts +286 -0
  289. package/src/sampling/prompts.ts +194 -0
  290. package/src/sampling/types.ts +60 -0
  291. package/src/schemas/config.ts +39 -0
  292. package/src/security/index.test.ts +441 -0
  293. package/src/security/index.ts +361 -0
  294. package/src/security/security-scenarios.test.ts +468 -0
  295. package/src/server.ts +211 -0
  296. package/src/test-utils/index.ts +6 -0
  297. package/src/test-utils/mock-context.ts +426 -0
  298. package/src/test-utils/mock-playwright-client.ts +422 -0
  299. package/src/tools/index.ts +11 -0
  300. package/src/tools/webtest/crawl.test.ts +834 -0
  301. package/src/tools/webtest/crawl.ts +901 -0
  302. package/src/tools/webtest/discover-features.ts +412 -0
  303. package/src/tools/webtest/discover-flows.ts +408 -0
  304. package/src/tools/webtest/generate-tests.test.ts +532 -0
  305. package/src/tools/webtest/generate-tests.ts +425 -0
  306. package/src/tools/webtest/index.ts +7 -0
  307. package/src/tools/webtest/integration.test.ts +536 -0
  308. package/src/tools/webtest/run-test-case.test.ts +659 -0
  309. package/src/tools/webtest/run-test-case.ts +508 -0
  310. package/src/tools/webtest/schemas.ts +201 -0
  311. package/src/tools/webtest/start-analysis.test.ts +151 -0
  312. package/src/tools/webtest/start-analysis.ts +158 -0
  313. package/src/transports/http.ts +19 -0
  314. package/src/transports/index.ts +30 -0
  315. package/src/transports/stdio.ts +7 -0
  316. package/src/types/capabilities.test.ts +193 -0
  317. package/src/types/capabilities.ts +50 -0
  318. package/src/types/context.ts +21 -0
  319. package/src/types/tool.ts +11 -0
  320. package/src/workspace/index.ts +945 -0
  321. package/src/workspace/markdown.ts +272 -0
  322. package/src/workspace/types.ts +186 -0
  323. package/tests/integration/server.test.ts +89 -0
  324. package/tests/integration/tools.test.ts +99 -0
  325. package/tsconfig.json +20 -0
  326. package/vitest.config.ts +9 -0
  327. package/vitest.integration.config.ts +10 -0
@@ -0,0 +1,456 @@
1
+ # OpenSpec Instructions
2
+
3
+ Instructions for AI coding assistants using OpenSpec for spec-driven development.
4
+
5
+ ## TL;DR Quick Checklist
6
+
7
+ - Search existing work: `openspec spec list --long`, `openspec list` (use `rg` only for full-text search)
8
+ - Decide scope: new capability vs modify existing capability
9
+ - Pick a unique `change-id`: kebab-case, verb-led (`add-`, `update-`, `remove-`, `refactor-`)
10
+ - Scaffold: `proposal.md`, `tasks.md`, `design.md` (only if needed), and delta specs per affected capability
11
+ - Write deltas: use `## ADDED|MODIFIED|REMOVED|RENAMED Requirements`; include at least one `#### Scenario:` per requirement
12
+ - Validate: `openspec validate [change-id] --strict` and fix issues
13
+ - Request approval: Do not start implementation until proposal is approved
14
+
15
+ ## Three-Stage Workflow
16
+
17
+ ### Stage 1: Creating Changes
18
+ Create proposal when you need to:
19
+ - Add features or functionality
20
+ - Make breaking changes (API, schema)
21
+ - Change architecture or patterns
22
+ - Optimize performance (changes behavior)
23
+ - Update security patterns
24
+
25
+ Triggers (examples):
26
+ - "Help me create a change proposal"
27
+ - "Help me plan a change"
28
+ - "Help me create a proposal"
29
+ - "I want to create a spec proposal"
30
+ - "I want to create a spec"
31
+
32
+ Loose matching guidance:
33
+ - Contains one of: `proposal`, `change`, `spec`
34
+ - With one of: `create`, `plan`, `make`, `start`, `help`
35
+
36
+ Skip proposal for:
37
+ - Bug fixes (restore intended behavior)
38
+ - Typos, formatting, comments
39
+ - Dependency updates (non-breaking)
40
+ - Configuration changes
41
+ - Tests for existing behavior
42
+
43
+ **Workflow**
44
+ 1. Review `openspec/project.md`, `openspec list`, and `openspec list --specs` to understand current context.
45
+ 2. Choose a unique verb-led `change-id` and scaffold `proposal.md`, `tasks.md`, optional `design.md`, and spec deltas under `openspec/changes/<id>/`.
46
+ 3. Draft spec deltas using `## ADDED|MODIFIED|REMOVED Requirements` with at least one `#### Scenario:` per requirement.
47
+ 4. Run `openspec validate <id> --strict` and resolve any issues before sharing the proposal.
48
+
49
+ ### Stage 2: Implementing Changes
50
+ Track these steps as TODOs and complete them one by one.
51
+ 1. **Read proposal.md** - Understand what's being built
52
+ 2. **Read design.md** (if exists) - Review technical decisions
53
+ 3. **Read tasks.md** - Get implementation checklist
54
+ 4. **Implement tasks sequentially** - Complete in order
55
+ 5. **Confirm completion** - Ensure every item in `tasks.md` is finished before updating statuses
56
+ 6. **Update checklist** - After all work is done, set every task to `- [x]` so the list reflects reality
57
+ 7. **Approval gate** - Do not start implementation until the proposal is reviewed and approved
58
+
59
+ ### Stage 3: Archiving Changes
60
+ After deployment, create separate PR to:
61
+ - Move `changes/[name]/` → `changes/archive/YYYY-MM-DD-[name]/`
62
+ - Update `specs/` if capabilities changed
63
+ - Use `openspec archive <change-id> --skip-specs --yes` for tooling-only changes (always pass the change ID explicitly)
64
+ - Run `openspec validate --strict` to confirm the archived change passes checks
65
+
66
+ ## Before Any Task
67
+
68
+ **Context Checklist:**
69
+ - [ ] Read relevant specs in `specs/[capability]/spec.md`
70
+ - [ ] Check pending changes in `changes/` for conflicts
71
+ - [ ] Read `openspec/project.md` for conventions
72
+ - [ ] Run `openspec list` to see active changes
73
+ - [ ] Run `openspec list --specs` to see existing capabilities
74
+
75
+ **Before Creating Specs:**
76
+ - Always check if capability already exists
77
+ - Prefer modifying existing specs over creating duplicates
78
+ - Use `openspec show [spec]` to review current state
79
+ - If request is ambiguous, ask 1–2 clarifying questions before scaffolding
80
+
81
+ ### Search Guidance
82
+ - Enumerate specs: `openspec spec list --long` (or `--json` for scripts)
83
+ - Enumerate changes: `openspec list` (or `openspec change list --json` - deprecated but available)
84
+ - Show details:
85
+ - Spec: `openspec show <spec-id> --type spec` (use `--json` for filters)
86
+ - Change: `openspec show <change-id> --json --deltas-only`
87
+ - Full-text search (use ripgrep): `rg -n "Requirement:|Scenario:" openspec/specs`
88
+
89
+ ## Quick Start
90
+
91
+ ### CLI Commands
92
+
93
+ ```bash
94
+ # Essential commands
95
+ openspec list # List active changes
96
+ openspec list --specs # List specifications
97
+ openspec show [item] # Display change or spec
98
+ openspec validate [item] # Validate changes or specs
99
+ openspec archive <change-id> [--yes|-y] # Archive after deployment (add --yes for non-interactive runs)
100
+
101
+ # Project management
102
+ openspec init [path] # Initialize OpenSpec
103
+ openspec update [path] # Update instruction files
104
+
105
+ # Interactive mode
106
+ openspec show # Prompts for selection
107
+ openspec validate # Bulk validation mode
108
+
109
+ # Debugging
110
+ openspec show [change] --json --deltas-only
111
+ openspec validate [change] --strict
112
+ ```
113
+
114
+ ### Command Flags
115
+
116
+ - `--json` - Machine-readable output
117
+ - `--type change|spec` - Disambiguate items
118
+ - `--strict` - Comprehensive validation
119
+ - `--no-interactive` - Disable prompts
120
+ - `--skip-specs` - Archive without spec updates
121
+ - `--yes`/`-y` - Skip confirmation prompts (non-interactive archive)
122
+
123
+ ## Directory Structure
124
+
125
+ ```
126
+ openspec/
127
+ ├── project.md # Project conventions
128
+ ├── specs/ # Current truth - what IS built
129
+ │ └── [capability]/ # Single focused capability
130
+ │ ├── spec.md # Requirements and scenarios
131
+ │ └── design.md # Technical patterns
132
+ ├── changes/ # Proposals - what SHOULD change
133
+ │ ├── [change-name]/
134
+ │ │ ├── proposal.md # Why, what, impact
135
+ │ │ ├── tasks.md # Implementation checklist
136
+ │ │ ├── design.md # Technical decisions (optional; see criteria)
137
+ │ │ └── specs/ # Delta changes
138
+ │ │ └── [capability]/
139
+ │ │ └── spec.md # ADDED/MODIFIED/REMOVED
140
+ │ └── archive/ # Completed changes
141
+ ```
142
+
143
+ ## Creating Change Proposals
144
+
145
+ ### Decision Tree
146
+
147
+ ```
148
+ New request?
149
+ ├─ Bug fix restoring spec behavior? → Fix directly
150
+ ├─ Typo/format/comment? → Fix directly
151
+ ├─ New feature/capability? → Create proposal
152
+ ├─ Breaking change? → Create proposal
153
+ ├─ Architecture change? → Create proposal
154
+ └─ Unclear? → Create proposal (safer)
155
+ ```
156
+
157
+ ### Proposal Structure
158
+
159
+ 1. **Create directory:** `changes/[change-id]/` (kebab-case, verb-led, unique)
160
+
161
+ 2. **Write proposal.md:**
162
+ ```markdown
163
+ # Change: [Brief description of change]
164
+
165
+ ## Why
166
+ [1-2 sentences on problem/opportunity]
167
+
168
+ ## What Changes
169
+ - [Bullet list of changes]
170
+ - [Mark breaking changes with **BREAKING**]
171
+
172
+ ## Impact
173
+ - Affected specs: [list capabilities]
174
+ - Affected code: [key files/systems]
175
+ ```
176
+
177
+ 3. **Create spec deltas:** `specs/[capability]/spec.md`
178
+ ```markdown
179
+ ## ADDED Requirements
180
+ ### Requirement: New Feature
181
+ The system SHALL provide...
182
+
183
+ #### Scenario: Success case
184
+ - **WHEN** user performs action
185
+ - **THEN** expected result
186
+
187
+ ## MODIFIED Requirements
188
+ ### Requirement: Existing Feature
189
+ [Complete modified requirement]
190
+
191
+ ## REMOVED Requirements
192
+ ### Requirement: Old Feature
193
+ **Reason**: [Why removing]
194
+ **Migration**: [How to handle]
195
+ ```
196
+ If multiple capabilities are affected, create multiple delta files under `changes/[change-id]/specs/<capability>/spec.md`—one per capability.
197
+
198
+ 4. **Create tasks.md:**
199
+ ```markdown
200
+ ## 1. Implementation
201
+ - [ ] 1.1 Create database schema
202
+ - [ ] 1.2 Implement API endpoint
203
+ - [ ] 1.3 Add frontend component
204
+ - [ ] 1.4 Write tests
205
+ ```
206
+
207
+ 5. **Create design.md when needed:**
208
+ Create `design.md` if any of the following apply; otherwise omit it:
209
+ - Cross-cutting change (multiple services/modules) or a new architectural pattern
210
+ - New external dependency or significant data model changes
211
+ - Security, performance, or migration complexity
212
+ - Ambiguity that benefits from technical decisions before coding
213
+
214
+ Minimal `design.md` skeleton:
215
+ ```markdown
216
+ ## Context
217
+ [Background, constraints, stakeholders]
218
+
219
+ ## Goals / Non-Goals
220
+ - Goals: [...]
221
+ - Non-Goals: [...]
222
+
223
+ ## Decisions
224
+ - Decision: [What and why]
225
+ - Alternatives considered: [Options + rationale]
226
+
227
+ ## Risks / Trade-offs
228
+ - [Risk] → Mitigation
229
+
230
+ ## Migration Plan
231
+ [Steps, rollback]
232
+
233
+ ## Open Questions
234
+ - [...]
235
+ ```
236
+
237
+ ## Spec File Format
238
+
239
+ ### Critical: Scenario Formatting
240
+
241
+ **CORRECT** (use #### headers):
242
+ ```markdown
243
+ #### Scenario: User login success
244
+ - **WHEN** valid credentials provided
245
+ - **THEN** return JWT token
246
+ ```
247
+
248
+ **WRONG** (don't use bullets or bold):
249
+ ```markdown
250
+ - **Scenario: User login** ❌
251
+ **Scenario**: User login ❌
252
+ ### Scenario: User login ❌
253
+ ```
254
+
255
+ Every requirement MUST have at least one scenario.
256
+
257
+ ### Requirement Wording
258
+ - Use SHALL/MUST for normative requirements (avoid should/may unless intentionally non-normative)
259
+
260
+ ### Delta Operations
261
+
262
+ - `## ADDED Requirements` - New capabilities
263
+ - `## MODIFIED Requirements` - Changed behavior
264
+ - `## REMOVED Requirements` - Deprecated features
265
+ - `## RENAMED Requirements` - Name changes
266
+
267
+ Headers matched with `trim(header)` - whitespace ignored.
268
+
269
+ #### When to use ADDED vs MODIFIED
270
+ - ADDED: Introduces a new capability or sub-capability that can stand alone as a requirement. Prefer ADDED when the change is orthogonal (e.g., adding "Slash Command Configuration") rather than altering the semantics of an existing requirement.
271
+ - MODIFIED: Changes the behavior, scope, or acceptance criteria of an existing requirement. Always paste the full, updated requirement content (header + all scenarios). The archiver will replace the entire requirement with what you provide here; partial deltas will drop previous details.
272
+ - RENAMED: Use when only the name changes. If you also change behavior, use RENAMED (name) plus MODIFIED (content) referencing the new name.
273
+
274
+ Common pitfall: Using MODIFIED to add a new concern without including the previous text. This causes loss of detail at archive time. If you aren’t explicitly changing the existing requirement, add a new requirement under ADDED instead.
275
+
276
+ Authoring a MODIFIED requirement correctly:
277
+ 1) Locate the existing requirement in `openspec/specs/<capability>/spec.md`.
278
+ 2) Copy the entire requirement block (from `### Requirement: ...` through its scenarios).
279
+ 3) Paste it under `## MODIFIED Requirements` and edit to reflect the new behavior.
280
+ 4) Ensure the header text matches exactly (whitespace-insensitive) and keep at least one `#### Scenario:`.
281
+
282
+ Example for RENAMED:
283
+ ```markdown
284
+ ## RENAMED Requirements
285
+ - FROM: `### Requirement: Login`
286
+ - TO: `### Requirement: User Authentication`
287
+ ```
288
+
289
+ ## Troubleshooting
290
+
291
+ ### Common Errors
292
+
293
+ **"Change must have at least one delta"**
294
+ - Check `changes/[name]/specs/` exists with .md files
295
+ - Verify files have operation prefixes (## ADDED Requirements)
296
+
297
+ **"Requirement must have at least one scenario"**
298
+ - Check scenarios use `#### Scenario:` format (4 hashtags)
299
+ - Don't use bullet points or bold for scenario headers
300
+
301
+ **Silent scenario parsing failures**
302
+ - Exact format required: `#### Scenario: Name`
303
+ - Debug with: `openspec show [change] --json --deltas-only`
304
+
305
+ ### Validation Tips
306
+
307
+ ```bash
308
+ # Always use strict mode for comprehensive checks
309
+ openspec validate [change] --strict
310
+
311
+ # Debug delta parsing
312
+ openspec show [change] --json | jq '.deltas'
313
+
314
+ # Check specific requirement
315
+ openspec show [spec] --json -r 1
316
+ ```
317
+
318
+ ## Happy Path Script
319
+
320
+ ```bash
321
+ # 1) Explore current state
322
+ openspec spec list --long
323
+ openspec list
324
+ # Optional full-text search:
325
+ # rg -n "Requirement:|Scenario:" openspec/specs
326
+ # rg -n "^#|Requirement:" openspec/changes
327
+
328
+ # 2) Choose change id and scaffold
329
+ CHANGE=add-two-factor-auth
330
+ mkdir -p openspec/changes/$CHANGE/{specs/auth}
331
+ printf "## Why\n...\n\n## What Changes\n- ...\n\n## Impact\n- ...\n" > openspec/changes/$CHANGE/proposal.md
332
+ printf "## 1. Implementation\n- [ ] 1.1 ...\n" > openspec/changes/$CHANGE/tasks.md
333
+
334
+ # 3) Add deltas (example)
335
+ cat > openspec/changes/$CHANGE/specs/auth/spec.md << 'EOF'
336
+ ## ADDED Requirements
337
+ ### Requirement: Two-Factor Authentication
338
+ Users MUST provide a second factor during login.
339
+
340
+ #### Scenario: OTP required
341
+ - **WHEN** valid credentials are provided
342
+ - **THEN** an OTP challenge is required
343
+ EOF
344
+
345
+ # 4) Validate
346
+ openspec validate $CHANGE --strict
347
+ ```
348
+
349
+ ## Multi-Capability Example
350
+
351
+ ```
352
+ openspec/changes/add-2fa-notify/
353
+ ├── proposal.md
354
+ ├── tasks.md
355
+ └── specs/
356
+ ├── auth/
357
+ │ └── spec.md # ADDED: Two-Factor Authentication
358
+ └── notifications/
359
+ └── spec.md # ADDED: OTP email notification
360
+ ```
361
+
362
+ auth/spec.md
363
+ ```markdown
364
+ ## ADDED Requirements
365
+ ### Requirement: Two-Factor Authentication
366
+ ...
367
+ ```
368
+
369
+ notifications/spec.md
370
+ ```markdown
371
+ ## ADDED Requirements
372
+ ### Requirement: OTP Email Notification
373
+ ...
374
+ ```
375
+
376
+ ## Best Practices
377
+
378
+ ### Simplicity First
379
+ - Default to <100 lines of new code
380
+ - Single-file implementations until proven insufficient
381
+ - Avoid frameworks without clear justification
382
+ - Choose boring, proven patterns
383
+
384
+ ### Complexity Triggers
385
+ Only add complexity with:
386
+ - Performance data showing current solution too slow
387
+ - Concrete scale requirements (>1000 users, >100MB data)
388
+ - Multiple proven use cases requiring abstraction
389
+
390
+ ### Clear References
391
+ - Use `file.ts:42` format for code locations
392
+ - Reference specs as `specs/auth/spec.md`
393
+ - Link related changes and PRs
394
+
395
+ ### Capability Naming
396
+ - Use verb-noun: `user-auth`, `payment-capture`
397
+ - Single purpose per capability
398
+ - 10-minute understandability rule
399
+ - Split if description needs "AND"
400
+
401
+ ### Change ID Naming
402
+ - Use kebab-case, short and descriptive: `add-two-factor-auth`
403
+ - Prefer verb-led prefixes: `add-`, `update-`, `remove-`, `refactor-`
404
+ - Ensure uniqueness; if taken, append `-2`, `-3`, etc.
405
+
406
+ ## Tool Selection Guide
407
+
408
+ | Task | Tool | Why |
409
+ |------|------|-----|
410
+ | Find files by pattern | Glob | Fast pattern matching |
411
+ | Search code content | Grep | Optimized regex search |
412
+ | Read specific files | Read | Direct file access |
413
+ | Explore unknown scope | Task | Multi-step investigation |
414
+
415
+ ## Error Recovery
416
+
417
+ ### Change Conflicts
418
+ 1. Run `openspec list` to see active changes
419
+ 2. Check for overlapping specs
420
+ 3. Coordinate with change owners
421
+ 4. Consider combining proposals
422
+
423
+ ### Validation Failures
424
+ 1. Run with `--strict` flag
425
+ 2. Check JSON output for details
426
+ 3. Verify spec file format
427
+ 4. Ensure scenarios properly formatted
428
+
429
+ ### Missing Context
430
+ 1. Read project.md first
431
+ 2. Check related specs
432
+ 3. Review recent archives
433
+ 4. Ask for clarification
434
+
435
+ ## Quick Reference
436
+
437
+ ### Stage Indicators
438
+ - `changes/` - Proposed, not yet built
439
+ - `specs/` - Built and deployed
440
+ - `archive/` - Completed changes
441
+
442
+ ### File Purposes
443
+ - `proposal.md` - Why and what
444
+ - `tasks.md` - Implementation steps
445
+ - `design.md` - Technical decisions
446
+ - `spec.md` - Requirements and behavior
447
+
448
+ ### CLI Essentials
449
+ ```bash
450
+ openspec list # What's in progress?
451
+ openspec show [item] # View details
452
+ openspec validate --strict # Is it correct?
453
+ openspec archive <change-id> [--yes|-y] # Mark complete (add --yes for automation)
454
+ ```
455
+
456
+ Remember: Specs are truth. Changes are proposals. Keep them in sync.
@@ -0,0 +1,33 @@
1
+ # Change: Add hybrid artifact paths (filePath + resourceUri) to tool outputs
2
+
3
+ ## Why
4
+
5
+ Currently, webtest tools return only `resourceUri` values (e.g., `webtest://abc123/analysis/app-analysis.md`) for accessing artifacts. While MCP resources provide a standard access mechanism, MCP clients may also need direct filesystem paths for:
6
+
7
+ 1. **Local file operations** - Reading files directly without MCP resource reads
8
+ 2. **External tool integration** - Passing file paths to other CLI tools, IDEs, or scripts
9
+ 3. **Debugging and inspection** - Quick access to artifacts during development
10
+ 4. **Backup and export** - Direct file system access for archiving workspaces
11
+
12
+ The workspace manager already writes files to disk (source of truth) and generates resource URIs (view layer), but only exposes the URIs. This change adds `filePath` alongside each `resourceUri` so clients have both access methods.
13
+
14
+ ## What Changes
15
+
16
+ - **Tool outputs**: Every tool that produces artifacts SHALL return both `filePath` (absolute filesystem path) and `resourceUri` (MCP resource URI) for each artifact
17
+ - **Workspace manager**: Methods like `saveAnalysis`, `saveTests`, `savePage`, `saveTestStepEvidence` SHALL return both paths
18
+ - **Consistent naming**: Use `*FilePath` / `*Uri` suffix pairs (e.g., `appAnalysisFilePath` / `appAnalysisUri`)
19
+
20
+ Affected tools:
21
+ - `webtest_init` - workspaceRootPath + workspaceRootUri
22
+ - `webtest_crawl_app` - crawlIndexFilePath + crawlIndexUri, page artifact paths
23
+ - `webtest_analyze_app` - appAnalysisFilePath + appAnalysisUri, flowsFilePath + flowsUri
24
+ - `webtest_generate_tests` - testsFilePath + testsUri
25
+ - `webtest_run_tests` - reportFilePath + reportUri, evidence paths
26
+
27
+ ## Impact
28
+
29
+ - Affected specs: `webtest-tools`, `webtest-resources`
30
+ - Affected code:
31
+ - `src/workspace/index.ts` - Return file paths from save methods
32
+ - `src/workspace/types.ts` - Add FilePath fields to return types
33
+ - `src/tools/webtest/*.ts` - Include file paths in tool results
@@ -0,0 +1,27 @@
1
+ ## ADDED Requirements
2
+
3
+ ### Requirement: Hybrid Artifact Access
4
+
5
+ The system SHALL provide both filesystem paths and MCP resource URIs for all artifacts, enabling direct file access alongside MCP resource reads.
6
+
7
+ #### Scenario: Workspace manager returns both path and URI
8
+
9
+ - **GIVEN** a workspace method saves an artifact (analysis, tests, pages, evidence)
10
+ - **WHEN** the save operation completes
11
+ - **THEN** it SHALL return both the absolute filesystem path and the `webtest://` URI
12
+ - **AND** the filesystem path SHALL be absolute (not relative)
13
+ - **AND** the path SHALL point to the actual file on disk
14
+
15
+ #### Scenario: File path resolves to same content as resource URI
16
+
17
+ - **GIVEN** an artifact has been saved
18
+ - **WHEN** the file is read directly via filesystem path
19
+ - **AND** the resource is read via MCP `resources/read` with the URI
20
+ - **THEN** both SHALL return identical content
21
+
22
+ #### Scenario: Workspace root path is accessible
23
+
24
+ - **GIVEN** a workspace has been created
25
+ - **WHEN** the workspace manager is queried
26
+ - **THEN** it SHALL provide the absolute path to the workspace root directory
27
+ - **AND** this path SHALL be used as the base for all artifact file paths