smart-spec-kit-mcp 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/README.md +262 -0
  2. package/dist/engine/sessionManager.d.ts +137 -0
  3. package/dist/engine/sessionManager.d.ts.map +1 -0
  4. package/dist/engine/sessionManager.js +128 -0
  5. package/dist/engine/sessionManager.js.map +1 -0
  6. package/dist/engine/workflowEngine.d.ts +57 -0
  7. package/dist/engine/workflowEngine.d.ts.map +1 -0
  8. package/dist/engine/workflowEngine.js +400 -0
  9. package/dist/engine/workflowEngine.js.map +1 -0
  10. package/dist/index.d.ts +14 -0
  11. package/dist/index.d.ts.map +1 -0
  12. package/dist/index.js +122 -0
  13. package/dist/index.js.map +1 -0
  14. package/dist/prompts/agents.d.ts +61 -0
  15. package/dist/prompts/agents.d.ts.map +1 -0
  16. package/dist/prompts/agents.js +236 -0
  17. package/dist/prompts/agents.js.map +1 -0
  18. package/dist/schemas/workflowSchema.d.ts +70 -0
  19. package/dist/schemas/workflowSchema.d.ts.map +1 -0
  20. package/dist/schemas/workflowSchema.js +42 -0
  21. package/dist/schemas/workflowSchema.js.map +1 -0
  22. package/dist/tools/agentTools.d.ts +11 -0
  23. package/dist/tools/agentTools.d.ts.map +1 -0
  24. package/dist/tools/agentTools.js +119 -0
  25. package/dist/tools/agentTools.js.map +1 -0
  26. package/dist/tools/orchestrationTools.d.ts +12 -0
  27. package/dist/tools/orchestrationTools.d.ts.map +1 -0
  28. package/dist/tools/orchestrationTools.js +375 -0
  29. package/dist/tools/orchestrationTools.js.map +1 -0
  30. package/dist/tools/workflowTools.d.ts +11 -0
  31. package/dist/tools/workflowTools.d.ts.map +1 -0
  32. package/dist/tools/workflowTools.js +236 -0
  33. package/dist/tools/workflowTools.js.map +1 -0
  34. package/dist/utils/markdownGenerator.d.ts +70 -0
  35. package/dist/utils/markdownGenerator.d.ts.map +1 -0
  36. package/dist/utils/markdownGenerator.js +206 -0
  37. package/dist/utils/markdownGenerator.js.map +1 -0
  38. package/dist/utils/vsCodeConfigGenerator.d.ts +32 -0
  39. package/dist/utils/vsCodeConfigGenerator.d.ts.map +1 -0
  40. package/dist/utils/vsCodeConfigGenerator.js +88 -0
  41. package/dist/utils/vsCodeConfigGenerator.js.map +1 -0
  42. package/dist/utils/workflowLoader.d.ts +99 -0
  43. package/dist/utils/workflowLoader.d.ts.map +1 -0
  44. package/dist/utils/workflowLoader.js +281 -0
  45. package/dist/utils/workflowLoader.js.map +1 -0
  46. package/package.json +61 -0
  47. package/templates/bugfix-report.md +184 -0
  48. package/templates/functional-spec.md +191 -0
  49. package/workflows/bugfix.yaml +99 -0
  50. package/workflows/feature-full.yaml +344 -0
  51. package/workflows/feature-standard.yaml +92 -0
@@ -0,0 +1,191 @@
1
+ ---
2
+ title: "[TO FILL: Feature Title]"
3
+ workitem_id: "[TO FILL]"
4
+ type: Functional Specification
5
+ version: "1.0"
6
+ status: Draft
7
+ author: "[TO FILL]"
8
+ created: "[TO FILL: Date]"
9
+ last_updated: "[TO FILL: Date]"
10
+ azure_devops_link: "[TO FILL: Link to ADO Work Item]"
11
+ ---
12
+
13
+ # Functional Specification: [TO FILL: Feature Title]
14
+
15
+ ## 1. Overview
16
+
17
+ ### 1.1 Purpose
18
+ [TO FILL: Brief description of the feature's purpose and the problem it solves]
19
+
20
+ ### 1.2 Scope
21
+ [TO FILL: What is included and explicitly excluded from this feature]
22
+
23
+ ### 1.3 Background
24
+ [TO FILL: Context and history leading to this feature request]
25
+
26
+ ---
27
+
28
+ ## 2. Stakeholders
29
+
30
+ | Role | Name | Responsibility |
31
+ |------|------|----------------|
32
+ | Product Owner | [TO FILL] | Requirements validation |
33
+ | Tech Lead | [TO FILL] | Technical decisions |
34
+ | QA Lead | [TO FILL] | Test strategy |
35
+ | UX Designer | [TO FILL] | User experience |
36
+
37
+ ---
38
+
39
+ ## 3. Requirements
40
+
41
+ ### 3.1 Functional Requirements
42
+
43
+ | ID | Requirement | Priority | Source |
44
+ |----|-------------|----------|--------|
45
+ | FR-001 | [TO FILL] | Must Have | ADO #{workitem_id} |
46
+ | FR-002 | [TO FILL] | Should Have | |
47
+ | FR-003 | [TO FILL] | Could Have | |
48
+
49
+ ### 3.2 Non-Functional Requirements
50
+
51
+ | ID | Category | Requirement | Target |
52
+ |----|----------|-------------|--------|
53
+ | NFR-001 | Performance | [TO FILL] | [TO FILL] |
54
+ | NFR-002 | Security | [TO FILL] | [TO FILL] |
55
+ | NFR-003 | Availability | [TO FILL] | [TO FILL] |
56
+ | NFR-004 | Scalability | [TO FILL] | [TO FILL] |
57
+
58
+ ### 3.3 Acceptance Criteria
59
+
60
+ ```gherkin
61
+ Feature: [TO FILL: Feature Name]
62
+
63
+ Scenario: [TO FILL: Main Success Scenario]
64
+ Given [TO FILL: Initial context]
65
+ When [TO FILL: Action performed]
66
+ Then [TO FILL: Expected outcome]
67
+
68
+ Scenario: [TO FILL: Alternative Scenario]
69
+ Given [TO FILL]
70
+ When [TO FILL]
71
+ Then [TO FILL]
72
+ ```
73
+
74
+ ---
75
+
76
+ ## 4. User Experience
77
+
78
+ ### 4.1 User Personas
79
+
80
+ **Persona 1: [TO FILL: Name]**
81
+ - Role: [TO FILL]
82
+ - Goals: [TO FILL]
83
+ - Pain Points: [TO FILL]
84
+
85
+ ### 4.2 User Stories
86
+
87
+ | ID | As a... | I want to... | So that... |
88
+ |----|---------|--------------|------------|
89
+ | US-001 | [TO FILL] | [TO FILL] | [TO FILL] |
90
+ | US-002 | [TO FILL] | [TO FILL] | [TO FILL] |
91
+
92
+ ### 4.3 User Flow
93
+
94
+ ```
95
+ [TO FILL: Describe or link to user flow diagram]
96
+ ┌─────────┐ ┌─────────┐ ┌─────────┐
97
+ │ Step 1 │───▶│ Step 2 │───▶│ Step 3 │
98
+ └─────────┘ └─────────┘ └─────────┘
99
+ ```
100
+
101
+ ---
102
+
103
+ ## 5. Technical Considerations
104
+
105
+ ### 5.1 Architecture Impact
106
+ [TO FILL: How this feature affects the existing architecture]
107
+
108
+ ### 5.2 Dependencies
109
+
110
+ | Dependency | Type | Status | Notes |
111
+ |------------|------|--------|-------|
112
+ | [TO FILL] | Service/API | [TO FILL] | |
113
+ | [TO FILL] | Library | [TO FILL] | |
114
+
115
+ ### 5.3 Data Model Changes
116
+ [TO FILL: New entities, modified schemas, migrations needed]
117
+
118
+ ### 5.4 API Changes
119
+ [TO FILL: New endpoints, modified contracts]
120
+
121
+ ---
122
+
123
+ ## 6. Risks & Assumptions
124
+
125
+ ### 6.1 Assumptions
126
+
127
+ | ID | Assumption | Impact if Wrong |
128
+ |----|------------|-----------------|
129
+ | A-001 | [TO FILL] | [TO FILL] |
130
+
131
+ ### 6.2 Risks
132
+
133
+ | ID | Risk | Probability | Impact | Mitigation |
134
+ |----|------|-------------|--------|------------|
135
+ | R-001 | [TO FILL] | Medium | High | [TO FILL] |
136
+
137
+ ### 6.3 Open Questions
138
+
139
+ - [ ] [TO FILL: Question 1]
140
+ - [ ] [TO FILL: Question 2]
141
+
142
+ ---
143
+
144
+ ## 7. Implementation Notes
145
+
146
+ ### 7.1 Suggested Approach
147
+ [TO FILL: High-level implementation strategy]
148
+
149
+ ### 7.2 Phasing (if applicable)
150
+
151
+ | Phase | Scope | Target Date |
152
+ |-------|-------|-------------|
153
+ | Phase 1 | [TO FILL] | [TO FILL] |
154
+ | Phase 2 | [TO FILL] | [TO FILL] |
155
+
156
+ ---
157
+
158
+ ## 8. Testing Strategy
159
+
160
+ ### 8.1 Test Scenarios
161
+ [TO FILL: Key scenarios to test]
162
+
163
+ ### 8.2 Test Data Requirements
164
+ [TO FILL: Special data needed for testing]
165
+
166
+ ---
167
+
168
+ ## 9. Documentation & Training
169
+
170
+ - [ ] User documentation required
171
+ - [ ] Admin documentation required
172
+ - [ ] Training materials needed
173
+ - [ ] Release notes entry
174
+
175
+ ---
176
+
177
+ ## 10. Approval
178
+
179
+ | Role | Name | Date | Signature |
180
+ |------|------|------|-----------|
181
+ | Product Owner | | | ☐ Approved |
182
+ | Tech Lead | | | ☐ Approved |
183
+ | QA Lead | | | ☐ Approved |
184
+
185
+ ---
186
+
187
+ ## Revision History
188
+
189
+ | Version | Date | Author | Changes |
190
+ |---------|------|--------|---------|
191
+ | 1.0 | [TO FILL] | [TO FILL] | Initial draft |
@@ -0,0 +1,99 @@
1
+ # Bugfix Workflow
2
+ # Streamlined process for bug fixes with validation checkpoints
3
+
4
+ name: bugfix
5
+ displayName: "Bug Fix"
6
+ description: "Structured workflow for analyzing, fixing, and validating bug corrections"
7
+
8
+ metadata:
9
+ version: "1.0"
10
+ author: "Spec-Kit"
11
+ tags:
12
+ - bugfix
13
+ - hotfix
14
+ - correction
15
+
16
+ template: bugfix-report.md
17
+ defaultAgent: SpecAgent
18
+
19
+ steps:
20
+ - id: analyze-bug
21
+ name: "Analyze Bug & Root Cause"
22
+ action: fetch_ado
23
+ description: |
24
+ Retrieve the bug work item from Azure DevOps and analyze:
25
+ - Reproduction steps
26
+ - Error logs and stack traces
27
+ - Affected components
28
+ - User impact assessment
29
+
30
+ Identify the root cause of the issue.
31
+ outputs:
32
+ - bug_data
33
+ - root_cause_analysis
34
+
35
+ - id: plan-fix
36
+ name: "Plan Correction"
37
+ action: call_agent
38
+ agent: PlanAgent
39
+ description: |
40
+ Create a correction plan including:
41
+ - Proposed fix approach
42
+ - Files/components to modify
43
+ - Potential side effects
44
+ - Rollback strategy if needed
45
+
46
+ Keep the fix minimal and focused.
47
+ inputs:
48
+ source: "root_cause_analysis"
49
+ outputs:
50
+ - fix_plan
51
+
52
+ - id: security-check
53
+ name: "Security Validation"
54
+ action: review
55
+ agent: GovAgent
56
+ description: |
57
+ Quick security review of the proposed fix:
58
+ - [ ] No new vulnerabilities introduced
59
+ - [ ] Input validation maintained
60
+ - [ ] No sensitive data exposure
61
+ - [ ] Authentication/Authorization intact
62
+ inputs:
63
+ document: "fix_plan"
64
+ outputs:
65
+ - security_clearance
66
+
67
+ - id: implement-fix
68
+ name: "Implement & Test"
69
+ action: generate_content
70
+ description: |
71
+ Implement the fix following the plan:
72
+ 1. Write the code fix
73
+ 2. Add unit tests for the bug scenario
74
+ 3. Add regression tests
75
+ 4. Update documentation if needed
76
+
77
+ Ensure test coverage for the fixed code path.
78
+ inputs:
79
+ plan: "fix_plan"
80
+ outputs:
81
+ - code_changes
82
+ - test_cases
83
+
84
+ - id: final-review
85
+ name: "Final Review"
86
+ action: review
87
+ agent: GovAgent
88
+ description: |
89
+ Final validation before merge:
90
+ - [ ] Fix addresses root cause
91
+ - [ ] No regression introduced
92
+ - [ ] Tests pass
93
+ - [ ] Code review approved
94
+ - [ ] Documentation updated
95
+ inputs:
96
+ changes: "code_changes"
97
+ tests: "test_cases"
98
+ outputs:
99
+ - approval_status
@@ -0,0 +1,344 @@
1
+ # Full Feature Workflow with Governance
2
+ # Complete workflow with all validation checkpoints
3
+
4
+ name: feature-full
5
+ displayName: "Feature with Full Governance"
6
+ description: "Complete feature workflow including RGPD, Security, Architecture, Design System, and Testing validations"
7
+
8
+ metadata:
9
+ version: "1.0"
10
+ author: "Spec-Kit"
11
+ tags:
12
+ - feature
13
+ - governance
14
+ - enterprise
15
+
16
+ template: functional-spec.md
17
+ defaultAgent: SpecAgent
18
+
19
+ steps:
20
+ # ═══════════════════════════════════════════════════════════════
21
+ # PHASE 1: SPECIFICATION
22
+ # ═══════════════════════════════════════════════════════════════
23
+
24
+ - id: fetch-requirements
25
+ name: "1.1 Fetch Requirements"
26
+ action: fetch_ado
27
+ description: |
28
+ Retrieve the Feature work item and all linked items from Azure DevOps.
29
+
30
+ Extract:
31
+ - Title and description
32
+ - Acceptance criteria
33
+ - Parent Epic context
34
+ - Linked User Stories
35
+ - Attachments (mockups, documents)
36
+ outputs:
37
+ - workitem_data
38
+ - linked_items
39
+ - attachments
40
+
41
+ - id: write-spec
42
+ name: "1.2 Write Functional Specification"
43
+ action: call_agent
44
+ agent: SpecAgent
45
+ description: |
46
+ Generate a comprehensive functional specification including:
47
+
48
+ **Functional Requirements**
49
+ - User stories with acceptance criteria
50
+ - Business rules
51
+ - Data requirements
52
+
53
+ **Non-Functional Requirements**
54
+ - Performance targets
55
+ - Availability requirements
56
+ - Scalability needs
57
+
58
+ Mark uncertain sections with [TO FILL] for human review.
59
+ inputs:
60
+ source: "workitem_data"
61
+ outputs:
62
+ - functional_spec
63
+
64
+ # ═══════════════════════════════════════════════════════════════
65
+ # PHASE 2: VALIDATION GATES
66
+ # ═══════════════════════════════════════════════════════════════
67
+
68
+ - id: rgpd-review
69
+ name: "2.1 🛡️ RGPD Compliance Review"
70
+ action: review
71
+ agent: GovAgent
72
+ description: |
73
+ Validate GDPR/RGPD compliance:
74
+
75
+ **Data Collection**
76
+ - [ ] Personal data identified and documented
77
+ - [ ] Legal basis for processing defined
78
+ - [ ] Data minimization principle applied
79
+
80
+ **User Rights**
81
+ - [ ] Right to access implemented
82
+ - [ ] Right to rectification supported
83
+ - [ ] Right to erasure (RTBF) supported
84
+ - [ ] Data portability considered
85
+
86
+ **Security & Governance**
87
+ - [ ] Data retention period defined
88
+ - [ ] Third-party processors identified
89
+ - [ ] Privacy by design applied
90
+ - [ ] DPIA required? (if high risk)
91
+ inputs:
92
+ spec: "functional_spec"
93
+ outputs:
94
+ - rgpd_report
95
+ - rgpd_status
96
+
97
+ - id: security-review
98
+ name: "2.2 🔒 Security Review"
99
+ action: review
100
+ agent: GovAgent
101
+ description: |
102
+ Security assessment checklist:
103
+
104
+ **Authentication & Authorization**
105
+ - [ ] Auth mechanism defined
106
+ - [ ] Role-based access control
107
+ - [ ] Session management
108
+
109
+ **Data Protection**
110
+ - [ ] Encryption at rest
111
+ - [ ] Encryption in transit (TLS)
112
+ - [ ] Sensitive data handling
113
+
114
+ **Input/Output Security**
115
+ - [ ] Input validation strategy
116
+ - [ ] Output encoding
117
+ - [ ] SQL injection prevention
118
+ - [ ] XSS prevention
119
+ - [ ] CSRF protection
120
+
121
+ **Infrastructure**
122
+ - [ ] Secrets management
123
+ - [ ] Logging (without PII)
124
+ - [ ] Rate limiting
125
+ - [ ] DDoS considerations
126
+ inputs:
127
+ spec: "functional_spec"
128
+ outputs:
129
+ - security_report
130
+ - security_status
131
+
132
+ - id: architecture-review
133
+ name: "2.3 🏗️ Architecture Review"
134
+ action: review
135
+ agent: GovAgent
136
+ description: |
137
+ Architecture validation:
138
+
139
+ **Consistency**
140
+ - [ ] Aligns with existing architecture
141
+ - [ ] Follows established patterns
142
+ - [ ] Uses approved technologies
143
+
144
+ **Quality Attributes**
145
+ - [ ] Scalability addressed
146
+ - [ ] Performance requirements met
147
+ - [ ] Reliability/Availability design
148
+ - [ ] Maintainability considered
149
+
150
+ **Technical Debt**
151
+ - [ ] No unnecessary complexity
152
+ - [ ] Reuses existing components
153
+ - [ ] Technical debt acceptable
154
+
155
+ **Integration**
156
+ - [ ] API contracts defined
157
+ - [ ] Event/message schemas
158
+ - [ ] Database changes documented
159
+ inputs:
160
+ spec: "functional_spec"
161
+ outputs:
162
+ - architecture_report
163
+ - architecture_status
164
+
165
+ - id: design-review
166
+ name: "2.4 🎨 Design System Review"
167
+ action: review
168
+ agent: GovAgent
169
+ description: |
170
+ Design System compliance (if UI involved):
171
+
172
+ **Components**
173
+ - [ ] Uses Design System components
174
+ - [ ] No unauthorized custom components
175
+ - [ ] Proper component composition
176
+
177
+ **Visual Consistency**
178
+ - [ ] Color tokens used correctly
179
+ - [ ] Typography follows guidelines
180
+ - [ ] Spacing uses standard scale
181
+ - [ ] Icons from approved library
182
+
183
+ **Accessibility (WCAG 2.1 AA)**
184
+ - [ ] Color contrast ratios
185
+ - [ ] Keyboard navigation
186
+ - [ ] Screen reader support
187
+ - [ ] Focus indicators
188
+
189
+ **Responsive Design**
190
+ - [ ] Mobile breakpoints defined
191
+ - [ ] Touch targets adequate
192
+ - [ ] Dark mode support (if applicable)
193
+ inputs:
194
+ spec: "functional_spec"
195
+ outputs:
196
+ - design_report
197
+ - design_status
198
+
199
+ # ═══════════════════════════════════════════════════════════════
200
+ # PHASE 3: TECHNICAL PLANNING
201
+ # ═══════════════════════════════════════════════════════════════
202
+
203
+ - id: technical-plan
204
+ name: "3.1 Technical Planning"
205
+ action: call_agent
206
+ agent: PlanAgent
207
+ description: |
208
+ Create detailed technical plan:
209
+
210
+ **Architecture Decisions**
211
+ - Components to create/modify
212
+ - Database schema changes
213
+ - API endpoints
214
+ - Integration points
215
+
216
+ **Task Breakdown**
217
+ - Granular tasks (1-3 days each)
218
+ - Clear acceptance criteria
219
+ - Dependencies mapped
220
+ - Effort estimates (S/M/L/XL)
221
+
222
+ **Risk Mitigation**
223
+ - Technical risks identified
224
+ - Mitigation strategies
225
+ - Spike tasks if needed
226
+ inputs:
227
+ spec: "functional_spec"
228
+ reviews: ["rgpd_report", "security_report", "architecture_report"]
229
+ outputs:
230
+ - technical_plan
231
+ - task_list
232
+
233
+ - id: test-strategy
234
+ name: "3.2 🧪 Test Strategy"
235
+ action: call_agent
236
+ agent: TestAgent
237
+ description: |
238
+ Define comprehensive test strategy:
239
+
240
+ **Unit Tests**
241
+ - Critical business logic
242
+ - Edge cases
243
+ - Error handling
244
+ - Target: >80% coverage
245
+
246
+ **Integration Tests**
247
+ - API contracts
248
+ - Database operations
249
+ - External service mocks
250
+
251
+ **E2E Tests**
252
+ - Critical user journeys
253
+ - Happy path scenarios
254
+ - Key error scenarios
255
+
256
+ **Non-Functional Tests**
257
+ - Performance benchmarks
258
+ - Load testing thresholds
259
+ - Security scan requirements
260
+ inputs:
261
+ spec: "functional_spec"
262
+ plan: "technical_plan"
263
+ outputs:
264
+ - test_strategy
265
+ - test_cases
266
+
267
+ # ═══════════════════════════════════════════════════════════════
268
+ # PHASE 4: DOCUMENTATION & FINALIZATION
269
+ # ═══════════════════════════════════════════════════════════════
270
+
271
+ - id: documentation
272
+ name: "4.1 📚 Documentation Plan"
273
+ action: generate_content
274
+ description: |
275
+ Identify documentation needs:
276
+
277
+ **User Documentation**
278
+ - [ ] User guide updates
279
+ - [ ] FAQ additions
280
+ - [ ] Tutorial/walkthrough
281
+
282
+ **Technical Documentation**
283
+ - [ ] API documentation
284
+ - [ ] Architecture Decision Record (ADR)
285
+ - [ ] Runbook updates
286
+ - [ ] README updates
287
+
288
+ **Release Documentation**
289
+ - [ ] Changelog entry
290
+ - [ ] Release notes
291
+ - [ ] Migration guide (if breaking changes)
292
+ inputs:
293
+ spec: "functional_spec"
294
+ plan: "technical_plan"
295
+ outputs:
296
+ - documentation_plan
297
+
298
+ - id: final-approval
299
+ name: "4.2 ✅ Final Approval Gate"
300
+ action: review
301
+ agent: GovAgent
302
+ description: |
303
+ Final checklist before development starts:
304
+
305
+ **Specification**
306
+ - [ ] Functional spec complete and approved
307
+ - [ ] All [TO FILL] sections resolved
308
+ - [ ] Stakeholder sign-off obtained
309
+
310
+ **Compliance**
311
+ - [ ] RGPD review: PASSED
312
+ - [ ] Security review: PASSED
313
+ - [ ] Architecture review: PASSED
314
+ - [ ] Design review: PASSED (if applicable)
315
+
316
+ **Planning**
317
+ - [ ] Technical plan approved
318
+ - [ ] Tasks created in ADO
319
+ - [ ] Test strategy defined
320
+ - [ ] Documentation plan ready
321
+
322
+ **Ready for Development** ✅
323
+ inputs:
324
+ all_artifacts: true
325
+ outputs:
326
+ - final_approval
327
+ - development_ready
328
+
329
+ - id: create-tasks
330
+ name: "4.3 Create ADO Work Items"
331
+ action: create_file
332
+ description: |
333
+ Generate Azure DevOps work items:
334
+ - Create Tasks from technical plan
335
+ - Link to parent Feature
336
+ - Set estimates and priorities
337
+ - Assign to sprint
338
+
339
+ Output format ready for ADO import or manual creation.
340
+ inputs:
341
+ tasks: "task_list"
342
+ feature_id: "context_id"
343
+ outputs:
344
+ - ado_work_items