@skill-map/spec 0.19.0 → 0.21.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.
- package/CHANGELOG.md +607 -6
- package/README.md +6 -6
- package/architecture.md +129 -57
- package/cli-contract.md +71 -25
- package/conformance/README.md +2 -2
- package/conformance/cases/kernel-empty-boot.json +2 -2
- package/conformance/cases/sidecar-end-to-end.json +3 -3
- package/conformance/coverage.md +5 -5
- package/conformance/fixtures/sidecar-end-to-end/.claude/agents/orphan.sm +1 -1
- package/conformance/fixtures/sidecar-example/agent-example.md +1 -1
- package/db-schema.md +22 -18
- package/index.json +36 -36
- package/interfaces/security-scanner.md +2 -2
- package/job-events.md +12 -12
- package/job-lifecycle.md +1 -1
- package/package.json +1 -1
- package/plugin-author-guide.md +131 -82
- package/plugin-kv-api.md +6 -6
- package/prompt-preamble.md +1 -1
- package/schemas/annotations.schema.json +4 -4
- package/schemas/api/rest-envelope.schema.json +4 -4
- package/schemas/conformance-case.schema.json +2 -2
- package/schemas/extensions/analyzer.schema.json +43 -0
- package/schemas/extensions/base.schema.json +5 -5
- package/schemas/extensions/extractor.schema.json +1 -1
- package/schemas/extensions/hook.schema.json +6 -4
- package/schemas/issue.schema.json +6 -6
- package/schemas/link.schema.json +2 -2
- package/schemas/plugins-registry.schema.json +1 -1
- package/schemas/project-config.schema.json +19 -1
- package/schemas/sidecar.schema.json +2 -2
- package/schemas/summaries/agent.schema.json +1 -1
- package/schemas/summaries/command.schema.json +1 -1
- package/schemas/summaries/hook.schema.json +1 -1
- package/schemas/{view-contracts.schema.json → view-slots.schema.json} +93 -55
- package/schemas/extensions/rule.schema.json +0 -43
package/index.json
CHANGED
|
@@ -71,8 +71,8 @@
|
|
|
71
71
|
"path": "schemas/extensions/extractor.schema.json"
|
|
72
72
|
},
|
|
73
73
|
{
|
|
74
|
-
"id": "extensions/
|
|
75
|
-
"path": "schemas/extensions/
|
|
74
|
+
"id": "extensions/analyzer",
|
|
75
|
+
"path": "schemas/extensions/analyzer.schema.json"
|
|
76
76
|
},
|
|
77
77
|
{
|
|
78
78
|
"id": "extensions/action",
|
|
@@ -174,69 +174,69 @@
|
|
|
174
174
|
}
|
|
175
175
|
]
|
|
176
176
|
},
|
|
177
|
-
"specPackageVersion": "0.
|
|
177
|
+
"specPackageVersion": "0.21.0",
|
|
178
178
|
"integrity": {
|
|
179
179
|
"algorithm": "sha256",
|
|
180
180
|
"files": {
|
|
181
|
-
"CHANGELOG.md": "
|
|
182
|
-
"README.md": "
|
|
183
|
-
"architecture.md": "
|
|
184
|
-
"cli-contract.md": "
|
|
185
|
-
"conformance/README.md": "
|
|
186
|
-
"conformance/cases/kernel-empty-boot.json": "
|
|
181
|
+
"CHANGELOG.md": "a1111c70f65d3f7640b5b17cad7d10e4e98e422adda9c8f07be175a4472ce640",
|
|
182
|
+
"README.md": "b551522ab0c7f5ef702e9ea4d4f67fd7ad838b080d85975c2834d8d40af14a00",
|
|
183
|
+
"architecture.md": "69dcbfba3d0b65626c5170b72512ff50038305b9e9b748e14bde1069863ecc0e",
|
|
184
|
+
"cli-contract.md": "ee08f0970ffcb5e6ce2c8dccbc10ea880b39b7d5307f90e312fecdc26aa07de2",
|
|
185
|
+
"conformance/README.md": "70e3101104765ef359d5322d0a7c9248d2157f78a510fb2cc8005b4eba3173d6",
|
|
186
|
+
"conformance/cases/kernel-empty-boot.json": "2a5be9c93143d07a16d998df09dcc8fa4ea2d2f9a0bff6417573ed5a770352c1",
|
|
187
187
|
"conformance/cases/orphan-markdown-fallback.json": "8ef6e49b7e6532bd845d9f54974a16e537cf98d355f0c5e4f4fb06abac3adcc5",
|
|
188
188
|
"conformance/cases/plugin-missing-ui-rejected.json": "bdebee810436e6be88edf2fe38ddc6939fd3f53e6a12dc1d66da051c4922f1e9",
|
|
189
|
-
"conformance/cases/sidecar-end-to-end.json": "
|
|
190
|
-
"conformance/coverage.md": "
|
|
189
|
+
"conformance/cases/sidecar-end-to-end.json": "24a73e7c857709d001cf7013b8fe5ccad4027e064b39533dda33697d80b56e7a",
|
|
190
|
+
"conformance/coverage.md": "45208fd74c5b548962025307d489deb91eaeedc57c0b10ff7c941631851b6f07",
|
|
191
191
|
"conformance/fixtures/orphan-markdown/.claude/agents/reviewer.md": "7f062731106f2d9811e4fffcf6ab44b8dfff4cfb16536a469514cc0664e832bf",
|
|
192
192
|
"conformance/fixtures/orphan-markdown/ARCHITECTURE.md": "d6b6e18d4b963b26a292de73348c3396fd4710ab4c4bdd6cf094e581f99ec8d6",
|
|
193
193
|
"conformance/fixtures/plugin-missing-ui/.skill-map/plugins/bad-provider/plugin.json": "4d78af6f12faa9d131e2a19f1dbb8f250baacc525978f3a8c858932b95da4ff6",
|
|
194
194
|
"conformance/fixtures/plugin-missing-ui/.skill-map/plugins/bad-provider/provider.js": "d1f4898b43201d24f048171ce84d433b68694457452fbc64498857f5da3e9bbb",
|
|
195
195
|
"conformance/fixtures/plugin-missing-ui/notes/example.md": "55767f0aa1b6774546a99f28c58e7b732aa9cfa5dfce8d0326470f7f622f577e",
|
|
196
196
|
"conformance/fixtures/preamble-v1.txt": "1e0aeef224b64477bdc13a949c3ad402e68249caf499ecdba1302371677c068b",
|
|
197
|
-
"conformance/fixtures/sidecar-end-to-end/.claude/agents/orphan.sm": "
|
|
197
|
+
"conformance/fixtures/sidecar-end-to-end/.claude/agents/orphan.sm": "3102ff10a0f08f60c014f82409d45ad4faf2cefa04d652a87676d3557ad64944",
|
|
198
198
|
"conformance/fixtures/sidecar-end-to-end/.claude/agents/stale.md": "cb3a95777cba530d47e6040c5601b6dcd34b5fc653dd69f183369eb6bdd956b5",
|
|
199
199
|
"conformance/fixtures/sidecar-end-to-end/.claude/agents/stale.sm": "cb04f7f3103b4218b09fd4da92f7ea429588b04c1dac6a9547ce362263b11224",
|
|
200
|
-
"conformance/fixtures/sidecar-example/agent-example.md": "
|
|
200
|
+
"conformance/fixtures/sidecar-example/agent-example.md": "741131403e8c9580d0b7a8c2446cb4502d01f80053b7a2092663de92431aaa82",
|
|
201
201
|
"conformance/fixtures/sidecar-example/agent-example.sm": "41200387e74a120c554a34dfabc50dd2151067a1c6599695c59412d8eab38bb4",
|
|
202
|
-
"db-schema.md": "
|
|
203
|
-
"interfaces/security-scanner.md": "
|
|
204
|
-
"job-events.md": "
|
|
205
|
-
"job-lifecycle.md": "
|
|
206
|
-
"plugin-author-guide.md": "
|
|
207
|
-
"plugin-kv-api.md": "
|
|
208
|
-
"prompt-preamble.md": "
|
|
209
|
-
"schemas/annotations.schema.json": "
|
|
210
|
-
"schemas/api/rest-envelope.schema.json": "
|
|
202
|
+
"db-schema.md": "8d0725443ae4cf1231378b8bbadcae46b32cb1b6cae06fb98865005debb080a1",
|
|
203
|
+
"interfaces/security-scanner.md": "aefe9f02f190615ba18649df03c1bdd79d98691039563c659e90f34362e5f1d5",
|
|
204
|
+
"job-events.md": "b223bf0e576cbd481688e163ab3ce0a6e952a8a4a3912f1342237b664984e388",
|
|
205
|
+
"job-lifecycle.md": "1d9c42632f8e77ef58ff47ae6d9680e7ed5939760627c75253aab8c80f728fd1",
|
|
206
|
+
"plugin-author-guide.md": "cf3abe83129228eba2e1b25b2cae93741f7676e3c5dc9f00fc64e0536a11df27",
|
|
207
|
+
"plugin-kv-api.md": "673e0a65825ba1aabf9b4ba0b4e0d5baf8e81dc5de1c13bee9532fbb33e7b440",
|
|
208
|
+
"prompt-preamble.md": "4860c310ccf2823870d318993ad8f067571799dade90bddb6634c3dbedd636b7",
|
|
209
|
+
"schemas/annotations.schema.json": "b3a9aa66de17058ccfd890ea9ff1b9ee315a0877e9dd4a58fd8b76e26a99d00e",
|
|
210
|
+
"schemas/api/rest-envelope.schema.json": "0f33b58e885cd0d74682a534d24765edee88fc35a63c03e987f73bdad451c892",
|
|
211
211
|
"schemas/bump-report.schema.json": "c2d853715d5f50098567bc23382a4e81baf78d589c6e1baf67d3b841e7f7d8ae",
|
|
212
|
-
"schemas/conformance-case.schema.json": "
|
|
212
|
+
"schemas/conformance-case.schema.json": "f6d4c9fb92e79cb516eeeb9d042223572a3bd5ff8e7871a0becce13916f20cf6",
|
|
213
213
|
"schemas/execution-record.schema.json": "9628fa557cb856402f3a5f1d1167c609e46a197c850fe8171abfddd46c1028a8",
|
|
214
214
|
"schemas/extensions/action.schema.json": "262272175c06a2e33c08f819a45c3ef8260276c91a9d0542fdffc932aeb32db7",
|
|
215
|
-
"schemas/extensions/
|
|
216
|
-
"schemas/extensions/
|
|
215
|
+
"schemas/extensions/analyzer.schema.json": "6272e5959f3c94e109e6116f7ed6b5ae35e4e3aea821a3c30742d11c5ab5838f",
|
|
216
|
+
"schemas/extensions/base.schema.json": "528083fb7db8bd064147224999e1bb3959ee2061863f55f48e928c27222cf957",
|
|
217
|
+
"schemas/extensions/extractor.schema.json": "a859a53a7a5b009b1fe20d322bc1a8ff62e4b91ef938e98b1c80c802bd734b37",
|
|
217
218
|
"schemas/extensions/formatter.schema.json": "2ab092aa37ae349c69b93071ed4f0e131affb7bb5799516ca82c721262631b36",
|
|
218
|
-
"schemas/extensions/hook.schema.json": "
|
|
219
|
+
"schemas/extensions/hook.schema.json": "a55cec50f6fda5b924de86359b910d22548d0a5bb61b2051edb82a80d3b36a2b",
|
|
219
220
|
"schemas/extensions/provider.schema.json": "077c0c079e3965cee667019f76ee1e180d6b1f4162767d868bccc912e8dfbf89",
|
|
220
|
-
"schemas/extensions/rule.schema.json": "8ff420bde498f50db114c352305d487c71aef2dd746fd0c24976ff6a09865c22",
|
|
221
221
|
"schemas/frontmatter/base.schema.json": "ec4abde950c31639974fc078e6bdc74ed48da4d2c0a996f5248684406910a178",
|
|
222
222
|
"schemas/history-stats.schema.json": "23f472d1de06d23fc775aabba821f8375f347af4dc8d89ba567980d61a11f9de",
|
|
223
223
|
"schemas/input-types.schema.json": "f1f51ccda746ea3c8a404757f60c89e403619e88ec4137a50af100ec89f8f4b5",
|
|
224
|
-
"schemas/issue.schema.json": "
|
|
224
|
+
"schemas/issue.schema.json": "0bbc1783ad07cb5c3c2399d7a560f57314a9ff76ed061b4a198ddf7ce74dad78",
|
|
225
225
|
"schemas/job.schema.json": "ffbdd51c54b487c44eb57fabd07f624ac1030c14ef69b46933c154092853a84c",
|
|
226
|
-
"schemas/link.schema.json": "
|
|
226
|
+
"schemas/link.schema.json": "7fc429d03aca7e4c0b9a28241712c1aa2a5275870cea5ed938c2f97e8cccb081",
|
|
227
227
|
"schemas/node.schema.json": "2ede4385e796cbf416c494d810dcb6d6036b35e71561efee46f5675bf0a015fe",
|
|
228
|
-
"schemas/plugins-registry.schema.json": "
|
|
229
|
-
"schemas/project-config.schema.json": "
|
|
228
|
+
"schemas/plugins-registry.schema.json": "678f476cf460d0b5876a92e72e0d572b6db265dd9fad6e95db553c56f77db5d9",
|
|
229
|
+
"schemas/project-config.schema.json": "7517e921f474af044599a82149c1046ee24d314db0a37a46f1c37d36212f338d",
|
|
230
230
|
"schemas/report-base-deterministic.schema.json": "6f8b38c097994ee87e0639935c42b5e85d8ea4244959ca397978171b0d7d2222",
|
|
231
231
|
"schemas/report-base.schema.json": "a1021e9a59b4df9f99cd92454d797e88469766e7d49f52d231c4645ffdfdad8f",
|
|
232
232
|
"schemas/scan-result.schema.json": "d1a8782e198bc9bb92dad247437aefa1b02f92ff8dca8562eaf2348fd7c5cf0c",
|
|
233
|
-
"schemas/sidecar.schema.json": "
|
|
234
|
-
"schemas/summaries/agent.schema.json": "
|
|
235
|
-
"schemas/summaries/command.schema.json": "
|
|
236
|
-
"schemas/summaries/hook.schema.json": "
|
|
233
|
+
"schemas/sidecar.schema.json": "119f71e943a3d9305e25e26e1d8b3b525a391af0a7547d8f8a79de96b016e07c",
|
|
234
|
+
"schemas/summaries/agent.schema.json": "bf540f9a804f2b43756ab33b7deb0462620d26e88cc9379c75a5f87d3b1b47d8",
|
|
235
|
+
"schemas/summaries/command.schema.json": "c26f6965f77c5058608feb5e7b9f807395de8e015b0dea5efcdb44cb1820551a",
|
|
236
|
+
"schemas/summaries/hook.schema.json": "58420ec485e152fdd21fa3d87337ad74b0d81a48d3b83dd072d4a2d196f78573",
|
|
237
237
|
"schemas/summaries/markdown.schema.json": "33e2a1a11ec08a860c0c220609235c6fbdfda9ce19b6d65238f467f132ed4e54",
|
|
238
238
|
"schemas/summaries/skill.schema.json": "f01bab92c51d64ee23e61587e42cf0dc5b37a2f518f5b12b3d1d456390338aa8",
|
|
239
|
-
"schemas/view-
|
|
239
|
+
"schemas/view-slots.schema.json": "59a6fd09af79d38dd16ae90dd3fe2965069335941909bc5b7f78110f3ec019fd",
|
|
240
240
|
"versioning.md": "996e62006423edc01151a6f7869605f76c5e1454cc30b38d9f616925b5bcfb64"
|
|
241
241
|
}
|
|
242
242
|
}
|
|
@@ -147,7 +147,7 @@ A `category` value SHOULD be one of these for interoperability:
|
|
|
147
147
|
- `injection-risk` — pattern likely to enable prompt injection, SQL injection, command injection.
|
|
148
148
|
- `license-violation` — incompatible license terms for a dependency or referenced asset.
|
|
149
149
|
- `outdated` — version pinned well below current, not exploited but due for upgrade.
|
|
150
|
-
- `policy-violation` — organization-level
|
|
150
|
+
- `policy-violation` — organization-level analyzer (naming, banned words, required disclaimer).
|
|
151
151
|
|
|
152
152
|
Vendors MAY introduce their own category with the prefix `vendor:<slug>` (e.g. `vendor:socket:supply-chain`). Consumers that don't understand a vendor category MUST treat it as opaque but still display it.
|
|
153
153
|
|
|
@@ -158,7 +158,7 @@ Vendors MAY introduce their own category with the prefix `vendor:<slug>` (e.g. `
|
|
|
158
158
|
- Scanners are invoked through the standard job system: `sm job submit security-snyk -n <node.path>` or `sm job submit security-snyk --all`.
|
|
159
159
|
- The report is persisted through the normal action report mechanism ([`state_executions`](../db-schema.md)`.report_path` points to the JSON file).
|
|
160
160
|
- `sm findings --security` aggregates findings from reports whose action id starts with `security-`, merging across scanners, deduplicating by `finding.id`.
|
|
161
|
-
- Implementations MAY also surface findings at scan time via a companion
|
|
161
|
+
- Implementations MAY also surface findings at scan time via a companion Analyzer (e.g. `security-findings-stale` flags nodes whose last security scan is older than a threshold). This is recommended but not normative.
|
|
162
162
|
|
|
163
163
|
---
|
|
164
164
|
|
package/job-events.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Canonical event stream emitted during job execution. Every implementation MUST emit these events in the order described, with the shapes defined below. Consumers include the CLI pretty printer, the `--json` ndjson output, the Server's WebSocket broadcaster, and any third-party integration.
|
|
4
4
|
|
|
5
|
-
This document is **normative**. The set of event types, their payload shapes, and their ordering
|
|
5
|
+
This document is **normative**. The set of event types, their payload shapes, and their ordering analyzers are stable contracts.
|
|
6
6
|
|
|
7
7
|
---
|
|
8
8
|
|
|
@@ -291,7 +291,7 @@ Emitted once at the end of `sm job run`, after the last job event.
|
|
|
291
291
|
|
|
292
292
|
---
|
|
293
293
|
|
|
294
|
-
## Ordering
|
|
294
|
+
## Ordering analyzers
|
|
295
295
|
|
|
296
296
|
For each job, the normative order is:
|
|
297
297
|
|
|
@@ -401,25 +401,25 @@ Emitted once per registered Extractor, after the full walk completes. Aggregated
|
|
|
401
401
|
|
|
402
402
|
> **Hookable** — see [`architecture.md` §Hook · curated trigger set](./architecture.md#hook--curated-trigger-set). Per-Extractor metrics, audit. Filter by `data.extractorId` to scope to a single Extractor.
|
|
403
403
|
|
|
404
|
-
#### `
|
|
404
|
+
#### `analyzer.completed`
|
|
405
405
|
|
|
406
|
-
Emitted once per registered
|
|
406
|
+
Emitted once per registered Analyzer, after every issue has been validated.
|
|
407
407
|
|
|
408
408
|
```json
|
|
409
409
|
{
|
|
410
|
-
"type": "
|
|
410
|
+
"type": "analyzer.completed",
|
|
411
411
|
"timestamp": 1745159455950,
|
|
412
412
|
"runId": "...",
|
|
413
413
|
"jobId": null,
|
|
414
414
|
"data": {
|
|
415
|
-
"
|
|
415
|
+
"analyzerId": "core/superseded"
|
|
416
416
|
}
|
|
417
417
|
}
|
|
418
418
|
```
|
|
419
419
|
|
|
420
|
-
`
|
|
420
|
+
`analyzerId` is the qualified extension id.
|
|
421
421
|
|
|
422
|
-
> **Hookable** — see [`architecture.md` §Hook · curated trigger set](./architecture.md#hook--curated-trigger-set). Per-
|
|
422
|
+
> **Hookable** — see [`architecture.md` §Hook · curated trigger set](./architecture.md#hook--curated-trigger-set). Per-Analyzer alerting, downstream tooling. Filter by `data.analyzerId`.
|
|
423
423
|
|
|
424
424
|
#### `action.completed`
|
|
425
425
|
|
|
@@ -456,7 +456,7 @@ Emitted by the scan after `scan.completed` when the new scan's issue set differs
|
|
|
456
456
|
"runId": "...",
|
|
457
457
|
"jobId": null,
|
|
458
458
|
"data": {
|
|
459
|
-
"
|
|
459
|
+
"analyzerId": "trigger-collision",
|
|
460
460
|
"severity": "warn",
|
|
461
461
|
"nodeIds": ["skills/a.md", "skills/b.md"],
|
|
462
462
|
"message": "..."
|
|
@@ -475,13 +475,13 @@ Emitted when an issue present in the previous scan is absent from the new one.
|
|
|
475
475
|
"runId": "...",
|
|
476
476
|
"jobId": null,
|
|
477
477
|
"data": {
|
|
478
|
-
"
|
|
478
|
+
"analyzerId": "broken-ref",
|
|
479
479
|
"nodeIds": ["skills/c.md"]
|
|
480
480
|
}
|
|
481
481
|
}
|
|
482
482
|
```
|
|
483
483
|
|
|
484
|
-
Issue diffing is keyed on `(
|
|
484
|
+
Issue diffing is keyed on `(analyzerId, nodeIds sorted, message)` — same key → same issue. A payload change on the same key emits no event; consumers re-read full issue detail from `sm check` when needed.
|
|
485
485
|
|
|
486
486
|
---
|
|
487
487
|
|
|
@@ -523,6 +523,6 @@ Consumers MUST ignore unknown fields (forward compatibility).
|
|
|
523
523
|
|
|
524
524
|
The envelope (`type`, `timestamp`, `runId`, `jobId`, `data`) is stable. Adding an envelope field is a major bump because every consumer would need to handle it.
|
|
525
525
|
|
|
526
|
-
The **non-job event families** (`scan.*`, `issue.*`, `extractor.completed`, `
|
|
526
|
+
The **non-job event families** (`scan.*`, `issue.*`, `extractor.completed`, `analyzer.completed`, `action.completed`) are marked **experimental** across spec v0.x. They ship alongside the WebSocket broadcaster at Step 13 of the reference impl; shapes may tighten before a stable tag lands. Once promoted to `stable` (a minor spec bump), the same add/remove/rename semantics as the job events apply.
|
|
527
527
|
|
|
528
528
|
The **Hook curated trigger set** (eight hookable lifecycle events; see [`architecture.md` §Hook · curated trigger set](./architecture.md#hook--curated-trigger-set)) is itself stable as of the same minor in which it lands: adding a hookable trigger is a minor bump, removing or renaming one is a major bump. The curation policy ("a hook subscribes only to a deliberately small set") is normative — surface noise reduction is the entire point.
|
package/job-lifecycle.md
CHANGED
|
@@ -242,7 +242,7 @@ Config controls (`jobs.retention.completed`, `jobs.retention.failed`):
|
|
|
242
242
|
|
|
243
243
|
## See also
|
|
244
244
|
|
|
245
|
-
- [`architecture.md`](./architecture.md) — `RunnerPort` definition; driving-adapter peer
|
|
245
|
+
- [`architecture.md`](./architecture.md) — `RunnerPort` definition; driving-adapter peer analyzer for Skill agents.
|
|
246
246
|
- [`job-events.md`](./job-events.md) — canonical event stream emitted during job execution.
|
|
247
247
|
- [`prompt-preamble.md`](./prompt-preamble.md) — verbatim preamble prepended to every rendered job content row.
|
|
248
248
|
- [`db-schema.md`](./db-schema.md) — `state_jobs` and `state_executions` table catalogs.
|