specky-sdd 3.2.1 → 3.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -5,6 +5,50 @@ All notable changes to Specky are documented in this file.
5
5
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6
6
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
 
8
+ ## [3.2.2] - 2026-04-13
9
+
10
+ ### Documentation (npm republish)
11
+
12
+ - **Plugin-first Quick Start**: README now leads with plugin installation (`copilot plugin install`), MCP-only as alternative
13
+ - **`mcpServers` key**: All JSON config examples updated from `servers` to `mcpServers`
14
+ - **Stale counts fixed**: Tool count (53/55/56 → 57), hook count (7 → 10), agent count (5 → 7), skill count (6) across README, SECURITY, CONTRIBUTING
15
+ - **SDD Platform table**: Updated to 57 tools, plugin install command
16
+ - **GETTING-STARTED.md**: Full English rewrite with plugin-first installation, use cases, model routing, hooks, FAQ
17
+ - **CONTRIBUTING.md**: Added Plugin Structure section; version reference updated to v3.2.x
18
+ - **No runtime changes** — MCP server code is identical to v3.2.1
19
+
20
+ ## [3.2.1] - 2026-04-13
21
+
22
+ ### Plugin Marketplace
23
+
24
+ - **`marketplace.json`**: Added `.github/plugin/marketplace.json` — repo is now a valid GitHub Copilot plugin marketplace
25
+ - **`plugin.json`**: Added `plugins/specky-sdd/.github/plugin/plugin.json` in Claude Code spec format (7 agents, 19 commands, 6 skills)
26
+ - **`.mcp.json`**: Plugin ships its own MCP config with `mcpServers` key and `specky-sdd@latest`
27
+ - **`.claude-plugin/`**: Added symlink for Claude Code marketplace compatibility
28
+ - **Plugin README**: Full plugin documentation at `plugins/specky-sdd/README.md` with skills, agents, commands, MCP server, and installation instructions
29
+ - **Plugin install**: Users can now install via `copilot plugin marketplace add paulasilvatech/specky && copilot plugin install specky-sdd@specky`
30
+ - **Flat structure**: Restructured from versioned `specky-sdd-vscode-v1.2.1/.github/plugin/specky/` to flat `plugins/specky-sdd/`
31
+ - **MCP key fix**: All JSON configs now use `mcpServers` key (previously `servers` in some files)
32
+ - **Version sync**: All plugin files aligned to v3.2.1 (`config.yml`, `plugin.json`, `marketplace.json`)
33
+ - **Cleanup**: Removed duplicate directories, empty `.github/agents/`, `.github/prompts/`, `.github/instructions/`, `.github/hooks/`
34
+
35
+ ### MCP Server Metadata
36
+
37
+ - **Server title**: MCP panel now shows "Specky" with description instead of raw binary name
38
+ - **Server icon**: SVG + PNG icons served from GitHub raw content, visible in VS Code MCP panel
39
+ - **Website URL**: Links to [specky-site](https://paulasilvatech.github.io/specky-site/) from server metadata
40
+ - **Instructions**: AI clients receive pipeline guidance during MCP handshake
41
+ - **Template path fix**: Templates now resolve from `dist/templates/` (self-contained npm package)
42
+
43
+ ### Documentation
44
+
45
+ - **MCP config examples**: Added `"type": "stdio"` to all VS Code, Claude Code, and Claude Desktop config examples
46
+ - **Removed broken env vars**: Removed `SDD_WORKSPACE` / `${workspaceFolder}` that caused startup errors
47
+ - **Tool count**: Updated 56 → 57 across all documentation
48
+ - **EARS patterns**: Fixed 5 → 6 pattern count (includes Complex)
49
+ - **Broken links**: Fixed references to private files (CLAUDE.md, SYSTEM-DESIGN.md, ears-notation.md)
50
+ - **Site fixes**: Updated EARS count and footer links on [specky-site](https://paulasilvatech.github.io/specky-site/)
51
+
8
52
  ## [3.2.0] - 2026-04-12
9
53
 
10
54
  ### Enterprise Security Hardening
package/README.md CHANGED
@@ -23,6 +23,7 @@
23
23
  <p>
24
24
  <a href="https://paulasilvatech.github.io/specky-site/">Website</a> ·
25
25
  <a href="GETTING-STARTED.md">Getting Started</a> ·
26
+ <a href="plugins/specky-sdd/">Plugin</a> ·
26
27
  <a href="https://www.npmjs.com/package/specky-sdd">npm</a> ·
27
28
  <a href="SECURITY.md">Security</a>
28
29
  </p>
@@ -36,8 +37,10 @@
36
37
  | **Start** | [What is Specky?](#what-is-specky) | Overview and ecosystem |
37
38
  | | [Why Specifications Matter](#why-specifications-matter-in-the-ai-era) | Vibe coding vs deterministic development |
38
39
  | | [Getting Started](GETTING-STARTED.md) | Complete educational guide |
39
- | **Use** | [Quick Start](#quick-start) | Install via npm or Docker, connect to your IDE |
40
- | | [Where Specifications Live](#where-specifications-live) | File structure and naming conventions |
40
+ | **Install** | [Quick Start](#quick-start) | Install plugin or MCP server, connect to your IDE |
41
+ | | [Plugin (recommended)](#install-as-plugin-recommended) | Enterprise-grade: agents, skills, hooks, MCP — all in one |
42
+ | | [MCP Server Only](#install-mcp-server-only) | Lightweight: just the 57 MCP tools |
43
+ | **Use** | [Where Specifications Live](#where-specifications-live) | File structure and naming conventions |
41
44
  | | [Input Methods](#input-methods-6-ways-to-start) | 6 ways to feed Specky |
42
45
  | | [Three Project Types](#three-project-types-one-pipeline) | Greenfield, Brownfield, Modernization |
43
46
  | **Pipeline** | [Pipeline and LGTM Gates](#pipeline-and-lgtm-gates) | 10 phases with human review gates |
@@ -55,7 +58,7 @@ Specky is an open-source **MCP server** that turns the [Spec-Kit](https://github
55
58
 
56
59
  **Spec-Kit** provides the methodology: EARS notation, gated pipeline phases, constitution model, quality patterns. **Specky** reimplements all of it as MCP tools and adds programmatic enforcement: a state machine that blocks phase-skipping, an EARS validator, cross-artifact analysis, compliance engines, test generation, and MCP-to-MCP routing.
57
60
 
58
- **Install Specky and you get both.** The Spec-Kit methodology is already built in. It works inside any AI IDE that supports MCP, via `.github/agents/` or `.claude/commands/`, and natively in Cursor, Windsurf, or any MCP-compatible client. See how they [complement each other](#the-spec-driven-development-platform).
61
+ **Install the Specky plugin and you get everything.** The Spec-Kit methodology is built in. The plugin bundles 7 agents, 19 prompts, 6 skills, 10 automation hooks, and the MCP server — all configured automatically. It works inside VS Code with Copilot, Claude Code, Cursor, Windsurf, or any MCP-compatible client. See the [plugin documentation](plugins/specky-sdd/) or how Spec-Kit and Specky [complement each other](#the-spec-driven-development-platform).
59
62
 
60
63
 
61
64
  ## Why Specifications Matter in the AI Era
@@ -109,7 +112,7 @@ Specky adds a **deterministic engine** between your intent and your code:
109
112
  | Phantom task detection | Catches tasks marked done with no code evidence |
110
113
  | Property-based testing | fast-check (TypeScript) and Hypothesis (Python) |
111
114
  | Checkpoint/restore | Persistent snapshots of all spec artifacts |
112
- | 7 automation hooks | Tests, docs, security scan, spec sync, SRP, changelog, checkpoint |
115
+ | 10 automation hooks (2 blocking) | Security scan, release gate, spec sync, checkpoint, quality, EARS, task trace, drift, cognitive debt, metrics |
113
116
  | Works in any MCP host | VS Code + Copilot, Claude Code, Cursor, Windsurf, or any MCP client |
114
117
  | Zero outbound network calls | Fully air-gapped, code never leaves your machine |
115
118
  | MIT open source | Fork it, extend it, audit it. No vendor lock, no seat pricing |
@@ -122,31 +125,73 @@ Specky adds a **deterministic engine** between your intent and your code:
122
125
  - **Node.js 18+**: [Download here](https://nodejs.org/)
123
126
  - **An AI IDE**: VS Code with Copilot, Claude Code, Claude Desktop, Cursor, or Windsurf
124
127
 
125
- ### Step 1: Choose Your Installation Scope
128
+ ### Install as Plugin (recommended)
126
129
 
127
- | Scope | What it does | Best for |
128
- |-------|-------------|----------|
129
- | **Per workspace** (recommended) | Config file lives inside the repo, shared with the team via Git | Teams, open-source projects |
130
- | **Global (once)** | Installed on your machine, available in every repo automatically | Personal use, quick setup |
130
+ The **Specky plugin** is the enterprise-grade installation method. It bundles everything your team needs: 7 agents, 19 prompts, 6 skills, 10 automation hooks, and the MCP server — configured automatically and version-controlled with your repo.
131
131
 
132
- ### Step 2: Install
132
+ | What you get | MCP Server Only | Plugin |
133
+ |-------------|:-:|:-:|
134
+ | 57 MCP tools | ✅ | ✅ |
135
+ | 7 specialized agents | — | ✅ |
136
+ | 19 reusable prompts | — | ✅ |
137
+ | 6 domain skills (SKILL.md) | — | ✅ |
138
+ | 10 automation hooks (2 blocking) | — | ✅ |
139
+ | EARS notation reference | — | ✅ |
140
+ | Model routing guidance | — | ✅ |
141
+ | Pipeline config (config.yml) | — | ✅ |
142
+ | `copilot plugin install` ready | — | ✅ |
133
143
 
134
- <details open>
135
- <summary><strong>Global (recommended): Install once, use everywhere</strong></summary>
144
+ #### Via Copilot CLI
136
145
 
137
- Install globally so `specky-sdd` is always available — no re-download on every run:
146
+ ```bash
147
+ copilot plugin marketplace add paulasilvatech/specky
148
+ copilot plugin install specky-sdd@specky
149
+ ```
150
+
151
+ #### Manual Installation
138
152
 
139
153
  ```bash
140
- npm install -g specky-sdd
154
+ cd your-project/
155
+ bash <(curl -sL https://raw.githubusercontent.com/paulasilvatech/specky/main/plugins/specky-sdd/install.sh)
141
156
  ```
142
157
 
143
- Then configure your IDE to use the global install:
158
+ The installer creates:
159
+
160
+ ```
161
+ your-project/
162
+ ├── .github/plugin/specky/ ← Full plugin (agents, skills, hooks, prompts)
163
+ │ ├── agents/ ← 7 specialized Copilot agents
164
+ │ ├── prompts/ ← 19 reusable prompts
165
+ │ ├── skills/ ← 6 domain skills
166
+ │ ├── hooks/scripts/ ← 10 automation hooks
167
+ │ ├── instructions/ ← Copilot instructions
168
+ │ └── config.yml ← Pipeline configuration
169
+ ├── .vscode/
170
+ │ ├── mcp.json ← MCP server configuration
171
+ │ └── settings.json ← Hook integration
172
+ └── GETTING-STARTED.md
173
+ ```
174
+
175
+ > **Tip:** Commit `.github/plugin/` and `.vscode/` to Git so every team member gets Specky automatically on clone.
176
+
177
+ See the full [plugin documentation](plugins/specky-sdd/README.md) for details.
178
+
179
+ ### Install MCP Server Only
180
+
181
+ If you only need the 57 MCP tools without agents, skills, and hooks, install the MCP server directly.
182
+
183
+ <details>
184
+ <summary><strong>Global (npm)</strong></summary>
185
+
186
+ ```bash
187
+ npm install -g specky-sdd
188
+ ```
144
189
 
145
190
  **VS Code** (`.vscode/mcp.json`):
146
191
  ```json
147
192
  {
148
- "servers": {
149
- "specky": {
193
+ "mcpServers": {
194
+ "specky-sdd": {
150
195
  "type": "stdio",
151
196
  "command": "specky-sdd"
152
197
  }
@@ -156,21 +201,14 @@ Then configure your IDE to use the global install:
156
201
 
157
202
  **Claude Code**:
158
203
  ```bash
159
- claude mcp add specky -- specky-sdd
204
+ claude mcp add specky-sdd -- specky-sdd
160
205
  ```
161
206
 
162
207
  **Claude Desktop** (`claude_desktop_config.json`):
163
-
164
- | OS | Config location |
165
- |----|----------------|
166
- | macOS | `~/Library/Application Support/Claude/claude_desktop_config.json` |
167
- | Linux | `~/.config/Claude/claude_desktop_config.json` |
168
- | Windows | `%APPDATA%\Claude\claude_desktop_config.json` |
169
-
170
208
  ```json
171
209
  {
172
210
  "mcpServers": {
173
- "specky": {
211
+ "specky-sdd": {
174
212
  "command": "specky-sdd"
175
213
  }
176
214
  }
@@ -180,57 +218,37 @@ claude mcp add specky -- specky-sdd
180
218
  </details>
181
219
 
182
220
  <details>
183
- <summary><strong>Per Workspace (alternative): npx, no global install</strong></summary>
184
-
185
- Add a config file to the repo so teammates get Specky automatically on clone — no global install needed.
221
+ <summary><strong>Per Workspace (npx)</strong></summary>
186
222
 
187
223
  **VS Code** (`.vscode/mcp.json`):
188
224
  ```json
189
225
  {
190
- "servers": {
191
- "specky": {
226
+ "mcpServers": {
227
+ "specky-sdd": {
192
228
  "type": "stdio",
193
- "command": "specky-sdd"
229
+ "command": "npx",
230
+ "args": ["-y", "specky-sdd@latest"]
194
231
  }
195
232
  }
196
233
  }
197
234
  ```
198
235
 
199
- **Claude Code**:
200
- ```bash
201
- claude mcp add specky -- specky-sdd
202
- ```
203
-
204
236
  > Commit `.vscode/mcp.json` to Git so every team member gets Specky automatically.
205
237
 
206
238
  </details>
207
239
 
208
240
  <details>
209
- <summary><strong>Docker: Docker (HTTP mode, no Node.js required)</strong></summary>
210
-
211
- Run Specky as an HTTP server in a container:
241
+ <summary><strong>Docker (HTTP mode, no Node.js required)</strong></summary>
212
242
 
213
243
  ```bash
214
244
  docker run -d --name specky -p 3200:3200 -v $(pwd):/workspace ghcr.io/paulasilvatech/specky:latest
215
245
  ```
216
246
 
217
- Verify it's running:
218
-
219
- ```bash
220
- curl http://localhost:3200/health
221
- ```
222
-
223
247
  Point any MCP client that supports HTTP to `http://localhost:3200/mcp`
224
248
 
225
- Stop when done:
226
-
227
- ```bash
228
- docker stop specky && docker rm specky
229
- ```
230
-
231
249
  </details>
232
250
 
233
- ### Step 3: Verify
251
+ ### Verify
234
252
 
235
253
  Open your AI IDE and type:
236
254
 
@@ -242,7 +260,7 @@ The AI should list the 57 SDD tools. If you see them, Specky is working.
242
260
 
243
261
  ### Try It Now
244
262
 
245
- Once connected, type this in your AI chat to see Specky in action:
263
+ Once connected, type this in your AI chat:
246
264
 
247
265
  ```
248
266
  > Initialize a Specky project for a todo API and help me define the scope
@@ -853,14 +871,14 @@ All artifacts are saved in [`.specs/NNN-feature/`](#where-specifications-live).
853
871
 
854
872
  **[Spec-Kit](https://github.com/paulasilvatech/spec-kit)** is the open-source SDD methodology: EARS notation, gated pipeline phases, constitution model, 25+ specialized agents, and Markdown prompt templates. It defines **what** to do.
855
873
 
856
- **Specky** is the MCP engine that reimplements that methodology as 53 enforceable tools with programmatic validation. It enforces **how** to do it.
874
+ **Specky** is the MCP engine that reimplements that methodology as 57 enforceable tools with programmatic validation. It enforces **how** to do it.
857
875
 
858
876
  | | Spec-Kit (Methodology) | Specky (Engine) |
859
877
  |--|------------------------|-----------------|
860
- | **What it is** | Prompt templates + agent definitions | MCP server with 55 tools |
878
+ | **What it is** | Prompt templates + agent definitions | MCP server with 57 tools |
861
879
  | **How it works** | AI reads `.md` templates and follows instructions | AI calls tools that validate, enforce, and generate |
862
880
  | **Validation** | AI tries to follow the prompts | State machine, EARS regex, Zod schemas |
863
- | **Install** | Copy `.github/agents/` and `.claude/commands/` | `npx specky-sdd` (includes methodology built-in) |
881
+ | **Install** | Copy `.github/agents/` and `.claude/commands/` | `copilot plugin install specky-sdd@specky` or `npm install -g specky-sdd` |
864
882
  | **Works standalone** | Yes, in any AI IDE | Yes, includes all Spec-Kit patterns |
865
883
  | **Best for** | Learning SDD, lightweight adoption | Production enforcement, enterprise, compliance |
866
884
 
@@ -870,10 +888,19 @@ When you install Specky, you get the full Spec-Kit methodology reimplemented as
870
888
 
871
889
  Together they form the **SDD layer** of the GitHub + Microsoft enterprise platform. Specky reimplements the Spec-Kit methodology as enforceable MCP tools with compliance, traceability, and automation built in.
872
890
 
891
+ The recommended way to adopt this stack is via the [Specky plugin](plugins/specky-sdd/), which bundles the MCP server, agents, skills, and hooks into a single installable package:
892
+
893
+ ```bash
894
+ copilot plugin marketplace add paulasilvatech/specky
895
+ copilot plugin install specky-sdd@specky
896
+ ```
897
+
898
+ Or configure the MCP server directly:
899
+
873
900
  ```json
874
901
  {
875
- "servers": {
876
- "specky": {
902
+ "mcpServers": {
903
+ "specky-sdd": {
877
904
  "type": "stdio",
878
905
  "command": "specky-sdd"
879
906
  }
@@ -881,7 +908,7 @@ Together they form the **SDD layer** of the GitHub + Microsoft enterprise platfo
881
908
  }
882
909
  ```
883
910
 
884
- > **Note:** This example assumes `specky-sdd` is installed globally (`npm install -g specky-sdd`). See the [Quick Start](#quick-start) section for per-workspace and Docker alternatives.
911
+ > **Note:** This example assumes `specky-sdd` is installed globally (`npm install -g specky-sdd`). See the [Quick Start](#quick-start) section for plugin installation, per-workspace, and Docker alternatives.
885
912
 
886
913
  ## Project Configuration
887
914
 
@@ -1086,7 +1113,7 @@ For contributors, see [CONTRIBUTING.md](CONTRIBUTING.md).
1086
1113
  | Test traceability: REQ-ID → test coverage mapping | Stable |
1087
1114
  | Intent drift detection with amendment suggestions | Stable |
1088
1115
  | 10 automation hooks (2 blocking) | Stable |
1089
- | 12 Claude Code commands + 5 Copilot agents | Stable |
1116
+ | 7 Copilot agents + 19 prompts + 6 skills (via plugin) | Stable |
1090
1117
  | 6 compliance frameworks (HIPAA, SOC2, GDPR, PCI-DSS, ISO 27001) | Stable |
1091
1118
  | 6 input types (transcript, PDF, DOCX, Figma, codebase, raw text) | Stable |
1092
1119
  | Test generation for 6 frameworks (vitest, jest, playwright, pytest, junit, xunit) | Stable |
package/SECURITY.md CHANGED
@@ -26,7 +26,7 @@ If you discover a security vulnerability in Specky, please report it responsibly
26
26
 
27
27
  ### Input Validation
28
28
 
29
- All 56 MCP tool inputs are validated using [Zod](https://zod.dev/) schemas with `.strict()` mode. No unknown fields are accepted. This prevents injection of unexpected parameters through the MCP JSON-RPC interface.
29
+ All 57 MCP tool inputs are validated using [Zod](https://zod.dev/) schemas with `.strict()` mode. No unknown fields are accepted. This prevents injection of unexpected parameters through the MCP JSON-RPC interface.
30
30
 
31
31
  ```
32
32
  AI Client → JSON-RPC → Zod .strict() validation → Service layer
@@ -193,15 +193,15 @@ Running `npx specky-sdd` without a pinned version downloads the latest package f
193
193
  | Approach | Risk reduction | Notes |
194
194
  |----------|---------------|-------|
195
195
  | `npm install -g specky-sdd` | **High** — fetches once, runs offline after | Recommended default |
196
- | `npm install -g specky-sdd@3.2.0` | **Higher** — version-pinned, no silent upgrades | Best for reproducible environments |
197
- | Docker (`ghcr.io/paulasilvatech/specky:3.2.0`) | **Highest** — immutable image by digest | Best for CI/CD and air-gapped |
196
+ | `npm install -g specky-sdd@3.2.1` | **Higher** — version-pinned, no silent upgrades | Best for reproducible environments |
197
+ | Docker (`ghcr.io/paulasilvatech/specky:3.2.1`) | **Highest** — immutable image by digest | Best for CI/CD and air-gapped |
198
198
  | `npx specky-sdd` (unversioned) | **Baseline** — re-downloads on each invocation | Avoid in production pipelines |
199
199
 
200
200
  **Workspace isolation pattern** (CI/CD):
201
201
 
202
202
  ```bash
203
203
  # Install into a local vendor directory — no global write permissions needed
204
- npm install specky-sdd@3.2.0 --prefix ./vendor --ignore-scripts
204
+ npm install specky-sdd@3.2.1 --prefix ./vendor --ignore-scripts
205
205
  ./vendor/node_modules/.bin/specky-sdd
206
206
  ```
207
207
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "specky-sdd",
3
- "version": "3.2.1",
3
+ "version": "3.2.2",
4
4
  "description": "Specky — 57 MCP tools for Spec-Driven Development. 10-phase pipeline, enterprise security (rate limiting, HMAC state integrity, RBAC, hash-chained audit), model routing guidance, context tiering, cognitive debt metrics, EARS notation, 17 diagram types.",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",