agentic-mermaid 0.1.1 → 0.1.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.
Files changed (336) hide show
  1. package/CHANGELOG.md +144 -4
  2. package/LICENSES/Apache-2.0.txt +202 -0
  3. package/README.md +25 -32
  4. package/THIRD_PARTY_NOTICES.md +29 -0
  5. package/dist/agent-core.d.ts +463 -0
  6. package/dist/agent-core.js +397 -0
  7. package/dist/agent.d.ts +73 -1868
  8. package/dist/agent.js +336 -37325
  9. package/dist/agentic-mermaid-mcp.js +7 -38399
  10. package/dist/am.js +33632 -40445
  11. package/dist/chunk-4QECACIA.js +4702 -0
  12. package/dist/chunk-CDPKJ2BQ.js +37 -0
  13. package/dist/chunk-QKDLMOJJ.js +3487 -0
  14. package/dist/chunk-WI35L7IR.js +615 -0
  15. package/dist/chunk-WN3YDOBG.js +149 -0
  16. package/dist/chunk-ZYMMKQ3I.js +62637 -0
  17. package/dist/index-D54dqSdC.d.ts +6777 -0
  18. package/dist/index.d.ts +1 -1
  19. package/dist/index.js +310 -33014
  20. package/dist/mcp-cli-SBQSTJFC.js +17 -0
  21. package/docs/README.md +14 -6
  22. package/docs/schemas/style-spec.schema.json +1221 -30
  23. package/examples/styles/catalog.json +54 -0
  24. package/examples/styles/cloudflare-workers-inspired-prototype.mmd +9 -0
  25. package/examples/styles/cloudflare-workers-inspired-prototype.style.json +110 -0
  26. package/examples/styles/cupertino-prototype.mmd +10 -0
  27. package/examples/styles/cupertino-prototype.style.json +63 -0
  28. package/examples/styles/mid-century-report.style.json +2 -2
  29. package/examples/styles/star-chart-atlas.style.json +2 -1
  30. package/examples/styles/transit-route-map.style.json +2 -2
  31. package/examples/styles/vercel-inspired-prototype.mmd +6 -0
  32. package/examples/styles/vercel-inspired-prototype.style.json +87 -0
  33. package/package.json +68 -43
  34. package/server.json +2 -2
  35. package/skills/agentic-mermaid-diagram-workflow/SKILL.md +17 -36
  36. package/skills/agentic-mermaid-diagram-workflow/references/cli.md +4 -5
  37. package/skills/agentic-mermaid-diagram-workflow/references/code-mode.md +15 -31
  38. package/skills/agentic-mermaid-diagram-workflow/references/sequence.md +10 -14
  39. package/skills/agentic-mermaid-live-editor/SKILL.md +100 -206
  40. package/AGENT_NATIVE.md +0 -607
  41. package/Instructions_for_agents.md +0 -89
  42. package/TODO.md +0 -684
  43. package/assets/hero.png +0 -0
  44. package/dist/index-wjRjbsP-.d.ts +0 -1102
  45. package/docs/agent-api-cookbook.md +0 -308
  46. package/docs/agent-mutation-policy.md +0 -104
  47. package/docs/agent-workflow-examples.md +0 -46
  48. package/docs/api.md +0 -211
  49. package/docs/ascii.md +0 -103
  50. package/docs/assets/improvements/box-start-connector.png +0 -0
  51. package/docs/assets/improvements/comment-dropped-lint.png +0 -0
  52. package/docs/assets/improvements/er-content-loss.png +0 -0
  53. package/docs/assets/improvements/fan-in-trunks.png +0 -0
  54. package/docs/assets/improvements/gantt-family.png +0 -0
  55. package/docs/assets/improvements/gantt-milestone-clamp.png +0 -0
  56. package/docs/assets/improvements/gantt-verify-seam.png +0 -0
  57. package/docs/assets/improvements/subgraph-container-edges.png +0 -0
  58. package/docs/assets/improvements/wrapper-frontmatter.png +0 -0
  59. package/docs/assets/improvements/wrapper-init-directive.png +0 -0
  60. package/docs/assets/improvements/wrapper-leading-comment.png +0 -0
  61. package/docs/assets/style-cookbook/mid-century-report.png +0 -0
  62. package/docs/assets/style-cookbook/star-chart-atlas.png +0 -0
  63. package/docs/assets/style-cookbook/transit-route-map.png +0 -0
  64. package/docs/comparison.md +0 -94
  65. package/docs/config.md +0 -105
  66. package/docs/contributing/adding-diagram-types.md +0 -144
  67. package/docs/contributing/diagram-family-citizenship.matrix.json +0 -2127
  68. package/docs/contributing/diagram-family-citizenship.md +0 -82
  69. package/docs/contributing/harvesting-upstream-tests.md +0 -126
  70. package/docs/contributing/lessons-learned.md +0 -276
  71. package/docs/contributing/releasing.md +0 -82
  72. package/docs/contributing/visual-review-evidence.md +0 -53
  73. package/docs/custom-style-cookbook.md +0 -154
  74. package/docs/design/families/README.md +0 -26
  75. package/docs/design/families/architecture-beta.md +0 -48
  76. package/docs/design/families/flowchart-parser-conformance.md +0 -22
  77. package/docs/design/families/gantt-research.md +0 -137
  78. package/docs/design/families/gantt.md +0 -329
  79. package/docs/design/families/journey-agentic-cards-before.png +0 -0
  80. package/docs/design/families/journey-experience-curve-implementation.png +0 -0
  81. package/docs/design/families/journey-mermaid-classic-implementation.png +0 -0
  82. package/docs/design/families/journey-mermaid-classic-prototype.png +0 -0
  83. package/docs/design/families/journey-mermaid-classic-prototype.svg +0 -163
  84. package/docs/design/families/journey-mermaid-classic-prototype.svg.png +0 -0
  85. package/docs/design/families/journey-migration-parity.md +0 -439
  86. package/docs/design/families/journey-section-overlap-after.png +0 -0
  87. package/docs/design/families/journey-section-overlap-before.png +0 -0
  88. package/docs/design/families/journey-usage-research.md +0 -423
  89. package/docs/design/families/journey.md +0 -153
  90. package/docs/design/families/xychart.md +0 -85
  91. package/docs/design/system/README.md +0 -45
  92. package/docs/design/system/abstraction-audit.md +0 -224
  93. package/docs/design/system/abstraction-recommendations.md +0 -655
  94. package/docs/design/system/architecture.mmd +0 -29
  95. package/docs/design/system/architecture.svg +0 -137
  96. package/docs/design/system/layout-guarantees-and-robustness.md +0 -351
  97. package/docs/design/system/layout-rubric.md +0 -138
  98. package/docs/design/system/route-contracts.md +0 -848
  99. package/docs/design/system/source-preservation-ladder.md +0 -52
  100. package/docs/design/system/styles-rollout.md +0 -216
  101. package/docs/design/system/ugly-layouts.md +0 -119
  102. package/docs/diagram-families.md +0 -193
  103. package/docs/features.md +0 -147
  104. package/docs/fork-differences.md +0 -130
  105. package/docs/getting-started.md +0 -175
  106. package/docs/issue-derived-test-cases.md +0 -156
  107. package/docs/layout-characterization/README.md +0 -245
  108. package/docs/layout-characterization/contact-sheet-families.md +0 -498
  109. package/docs/layout-characterization/contact-sheet.md +0 -638
  110. package/docs/layout-characterization/properties.md +0 -281
  111. package/docs/layout-characterization/visual-quality.md +0 -160
  112. package/docs/layout-characterization/visual-snapshots/architecture.svg +0 -79
  113. package/docs/layout-characterization/visual-snapshots/class.svg +0 -60
  114. package/docs/layout-characterization/visual-snapshots/er.svg +0 -61
  115. package/docs/layout-characterization/visual-snapshots/flowchart.svg +0 -58
  116. package/docs/layout-characterization/visual-snapshots/gantt.svg +0 -52
  117. package/docs/layout-characterization/visual-snapshots/journey.svg +0 -98
  118. package/docs/layout-characterization/visual-snapshots/pie.svg +0 -36
  119. package/docs/layout-characterization/visual-snapshots/quadrant.svg +0 -47
  120. package/docs/layout-characterization/visual-snapshots/sequence.svg +0 -59
  121. package/docs/layout-characterization/visual-snapshots/state.svg +0 -52
  122. package/docs/layout-characterization/visual-snapshots/timeline.svg +0 -64
  123. package/docs/layout-characterization/visual-snapshots/xychart.svg +0 -97
  124. package/docs/mcp-code-mode-rationale.md +0 -101
  125. package/docs/mcp-http-transport.md +0 -223
  126. package/docs/mermaid-layout-complaints.md +0 -837
  127. package/docs/mutation-testing.md +0 -206
  128. package/docs/project/divergences.md +0 -98
  129. package/docs/project/dogfooding-docs-strategy.md +0 -66
  130. package/docs/project/hosted-mcp-cloudflare-plan.md +0 -338
  131. package/docs/project/lessons-learned.md +0 -1019
  132. package/docs/project/remove-role-styling-plan.md +0 -176
  133. package/docs/quality.md +0 -215
  134. package/docs/react.md +0 -97
  135. package/docs/style-authoring.md +0 -133
  136. package/docs/testing-strategy.md +0 -335
  137. package/docs/theming.md +0 -162
  138. package/examples/agent-improve-auth-flow.ts +0 -206
  139. package/examples/agent-loop.ts +0 -53
  140. package/examples/mcp-vs-cli-complex-diagrams.ts +0 -133
  141. package/llms.txt +0 -104
  142. package/skill-evals/README.md +0 -77
  143. package/skill-evals/fixtures/architecture-cache/input.mmd +0 -5
  144. package/skill-evals/fixtures/class-payment/input.mmd +0 -4
  145. package/skill-evals/fixtures/er-orders/input.mmd +0 -10
  146. package/skill-evals/fixtures/flowchart-cache/input.mmd +0 -3
  147. package/skill-evals/fixtures/gantt-release/input.mmd +0 -7
  148. package/skill-evals/fixtures/journey-checkout/input.mmd +0 -6
  149. package/skill-evals/fixtures/pie-exports/input.mmd +0 -5
  150. package/skill-evals/fixtures/quadrant-priorities/input.mmd +0 -11
  151. package/skill-evals/fixtures/sequence-retry/input.mmd +0 -8
  152. package/skill-evals/fixtures/state-lifecycle/input.mmd +0 -5
  153. package/skill-evals/fixtures/timeline-release/input.mmd +0 -6
  154. package/skill-evals/fixtures/xychart-growth/input.mmd +0 -5
  155. package/skill-evals/shared-benchmark.json +0 -510
  156. package/src/agent/analyze.ts +0 -157
  157. package/src/agent/apply.ts +0 -146
  158. package/src/agent/architecture-body.ts +0 -458
  159. package/src/agent/certificates.ts +0 -110
  160. package/src/agent/class-body.ts +0 -319
  161. package/src/agent/core.ts +0 -207
  162. package/src/agent/create.ts +0 -106
  163. package/src/agent/describe.ts +0 -368
  164. package/src/agent/er-body.ts +0 -224
  165. package/src/agent/facts.ts +0 -360
  166. package/src/agent/families-builtin.ts +0 -920
  167. package/src/agent/families.ts +0 -232
  168. package/src/agent/family-layouts.ts +0 -832
  169. package/src/agent/flowchart-body.ts +0 -372
  170. package/src/agent/flowchart-unsupported.ts +0 -243
  171. package/src/agent/font-coverage.ts +0 -288
  172. package/src/agent/gantt-body.ts +0 -495
  173. package/src/agent/index.ts +0 -10
  174. package/src/agent/journey-body.ts +0 -374
  175. package/src/agent/label-metrics.ts +0 -28
  176. package/src/agent/layout-to-rendered.ts +0 -63
  177. package/src/agent/mutate.ts +0 -97
  178. package/src/agent/mutation-ops.ts +0 -51
  179. package/src/agent/op-schema.ts +0 -443
  180. package/src/agent/parse.ts +0 -223
  181. package/src/agent/pie-body.ts +0 -270
  182. package/src/agent/png.ts +0 -171
  183. package/src/agent/quadrant-body.ts +0 -336
  184. package/src/agent/quality.ts +0 -363
  185. package/src/agent/readability-audit.ts +0 -92
  186. package/src/agent/rendered-route-audit.ts +0 -61
  187. package/src/agent/sequence-body.ts +0 -345
  188. package/src/agent/serialize.ts +0 -214
  189. package/src/agent/state-body.ts +0 -589
  190. package/src/agent/structural-count.ts +0 -150
  191. package/src/agent/timeline-body.ts +0 -280
  192. package/src/agent/trace-log.ts +0 -43
  193. package/src/agent/types.ts +0 -995
  194. package/src/agent/verify.ts +0 -603
  195. package/src/agent/xychart-body.ts +0 -472
  196. package/src/architecture/config.ts +0 -282
  197. package/src/architecture/layout.ts +0 -496
  198. package/src/architecture/parser.ts +0 -375
  199. package/src/architecture/renderer.ts +0 -611
  200. package/src/architecture/types.ts +0 -113
  201. package/src/ascii/ansi.ts +0 -423
  202. package/src/ascii/architecture.ts +0 -210
  203. package/src/ascii/canvas.ts +0 -443
  204. package/src/ascii/class-diagram.ts +0 -697
  205. package/src/ascii/converter.ts +0 -475
  206. package/src/ascii/draw.ts +0 -1693
  207. package/src/ascii/edge-bundling.ts +0 -328
  208. package/src/ascii/edge-routing.ts +0 -330
  209. package/src/ascii/er-diagram.ts +0 -439
  210. package/src/ascii/gantt.ts +0 -276
  211. package/src/ascii/grid.ts +0 -747
  212. package/src/ascii/index.ts +0 -196
  213. package/src/ascii/journey.ts +0 -169
  214. package/src/ascii/meta.ts +0 -244
  215. package/src/ascii/multiline-utils.ts +0 -80
  216. package/src/ascii/pathfinder.ts +0 -301
  217. package/src/ascii/pie.ts +0 -67
  218. package/src/ascii/quadrant.ts +0 -158
  219. package/src/ascii/reverse.ts +0 -216
  220. package/src/ascii/sequence.ts +0 -499
  221. package/src/ascii/shapes/circle.ts +0 -27
  222. package/src/ascii/shapes/corners.ts +0 -143
  223. package/src/ascii/shapes/diamond.ts +0 -27
  224. package/src/ascii/shapes/hexagon.ts +0 -27
  225. package/src/ascii/shapes/index.ts +0 -106
  226. package/src/ascii/shapes/rectangle.ts +0 -168
  227. package/src/ascii/shapes/rounded.ts +0 -27
  228. package/src/ascii/shapes/special.ts +0 -332
  229. package/src/ascii/shapes/stadium.ts +0 -110
  230. package/src/ascii/shapes/state.ts +0 -192
  231. package/src/ascii/shapes/types.ts +0 -73
  232. package/src/ascii/timeline.ts +0 -141
  233. package/src/ascii/types.ts +0 -312
  234. package/src/ascii/validate.ts +0 -120
  235. package/src/ascii/width.ts +0 -81
  236. package/src/ascii/wrap.ts +0 -131
  237. package/src/ascii/xychart.ts +0 -919
  238. package/src/browser.ts +0 -29
  239. package/src/class/layout.ts +0 -240
  240. package/src/class/parser.ts +0 -332
  241. package/src/class/renderer.ts +0 -638
  242. package/src/class/types.ts +0 -129
  243. package/src/cli/agent-instructions.ts +0 -1
  244. package/src/cli/am-bin.ts +0 -6
  245. package/src/cli/exit-codes.ts +0 -18
  246. package/src/cli/index.ts +0 -1132
  247. package/src/cli/init-agent.ts +0 -147
  248. package/src/cli/run-entrypoint.ts +0 -10
  249. package/src/color-resolver.ts +0 -152
  250. package/src/elk-instance.ts +0 -114
  251. package/src/er/layout.ts +0 -187
  252. package/src/er/parser.ts +0 -226
  253. package/src/er/renderer.ts +0 -792
  254. package/src/er/types.ts +0 -99
  255. package/src/family-rubric.ts +0 -425
  256. package/src/font-manifest.ts +0 -31
  257. package/src/gantt/layout.ts +0 -365
  258. package/src/gantt/parser.ts +0 -282
  259. package/src/gantt/pipeline.ts +0 -27
  260. package/src/gantt/renderer.ts +0 -414
  261. package/src/gantt/schedule.ts +0 -513
  262. package/src/gantt/types.ts +0 -255
  263. package/src/index.ts +0 -368
  264. package/src/journey/layout.ts +0 -554
  265. package/src/journey/parse-core.ts +0 -251
  266. package/src/journey/parser.ts +0 -101
  267. package/src/journey/renderer.ts +0 -917
  268. package/src/journey/types.ts +0 -144
  269. package/src/layout/geometry.ts +0 -182
  270. package/src/layout/pass.ts +0 -142
  271. package/src/layout/passes/index.ts +0 -3916
  272. package/src/layout-engine.ts +0 -1565
  273. package/src/layout-rubric.ts +0 -659
  274. package/src/mcp/artifacts.ts +0 -137
  275. package/src/mcp/dynamic-harness.ts +0 -31
  276. package/src/mcp/dynamic-modules.d.ts +0 -7
  277. package/src/mcp/facade.ts +0 -608
  278. package/src/mcp/harness-runtime.ts +0 -203
  279. package/src/mcp/hosted-server.ts +0 -468
  280. package/src/mcp/mcp-bin.ts +0 -3
  281. package/src/mcp/mcp-cli.ts +0 -82
  282. package/src/mcp/protocol.ts +0 -13
  283. package/src/mcp/sandbox.ts +0 -195
  284. package/src/mcp/sdk-decl.ts +0 -391
  285. package/src/mcp/server.ts +0 -362
  286. package/src/mcp/tool-surface.ts +0 -146
  287. package/src/mermaid-source.ts +0 -655
  288. package/src/multiline-utils.ts +0 -228
  289. package/src/parser.ts +0 -1031
  290. package/src/pie/layout.ts +0 -168
  291. package/src/pie/parser.ts +0 -136
  292. package/src/pie/renderer.ts +0 -234
  293. package/src/pie/types.ts +0 -82
  294. package/src/quadrant/layout.ts +0 -191
  295. package/src/quadrant/parser.ts +0 -183
  296. package/src/quadrant/renderer.ts +0 -322
  297. package/src/quadrant/types.ts +0 -113
  298. package/src/render-family-hooks.ts +0 -244
  299. package/src/renderer.ts +0 -1099
  300. package/src/route-contracts.ts +0 -2723
  301. package/src/scene/backend.ts +0 -76
  302. package/src/scene/fidelity.ts +0 -183
  303. package/src/scene/hybrid-backend.ts +0 -174
  304. package/src/scene/ir.ts +0 -181
  305. package/src/scene/marks.ts +0 -127
  306. package/src/scene/rough-backend.ts +0 -378
  307. package/src/scene/seed.ts +0 -46
  308. package/src/scene/style-registry.ts +0 -556
  309. package/src/sequence/layout.ts +0 -456
  310. package/src/sequence/parser.ts +0 -255
  311. package/src/sequence/renderer.ts +0 -604
  312. package/src/sequence/types.ts +0 -154
  313. package/src/shape-clipping.ts +0 -351
  314. package/src/shared/accessibility-directives.ts +0 -22
  315. package/src/shared/batched.ts +0 -61
  316. package/src/shared/color-math.ts +0 -93
  317. package/src/shared/svg-a11y.ts +0 -29
  318. package/src/shared/syntax-error.ts +0 -17
  319. package/src/shared/unicode-ranges.ts +0 -135
  320. package/src/styles.ts +0 -318
  321. package/src/svg-paths.ts +0 -28
  322. package/src/text-metrics.ts +0 -248
  323. package/src/theme.ts +0 -710
  324. package/src/timeline/layout.ts +0 -381
  325. package/src/timeline/parser.ts +0 -215
  326. package/src/timeline/renderer.ts +0 -538
  327. package/src/timeline/types.ts +0 -105
  328. package/src/types.ts +0 -462
  329. package/src/website-worker-modules.d.ts +0 -18
  330. package/src/xychart/axis-utils.ts +0 -109
  331. package/src/xychart/colors.ts +0 -124
  332. package/src/xychart/config.ts +0 -88
  333. package/src/xychart/layout.ts +0 -656
  334. package/src/xychart/parser.ts +0 -504
  335. package/src/xychart/renderer.ts +0 -640
  336. package/src/xychart/types.ts +0 -282
@@ -1,206 +0,0 @@
1
- // Runnable agent-improvement example:
2
- // 1. create a non-trivial Auth Flow via MCP Code Mode mutations;
3
- // 2. assess it and spot label-overflow warnings;
4
- // 3. improve it through another mutation batch;
5
- // 4. reassess the impact;
6
- // 5. write final Mermaid, SVG, ASCII, PNG, and assessment files.
7
- //
8
- // Run:
9
- // bun run examples/agent-improve-auth-flow.ts
10
- // bun run examples/agent-improve-auth-flow.ts --out-dir /tmp/auth-flow-improved
11
-
12
- import { Buffer } from 'node:buffer'
13
- import { mkdirSync, mkdtempSync, rmSync, writeFileSync } from 'node:fs'
14
- import { tmpdir } from 'node:os'
15
- import { join, resolve } from 'node:path'
16
- import { spawnSync } from 'node:child_process'
17
- import { handleRequest } from '../src/mcp/server.ts'
18
-
19
- const REPO = join(import.meta.dir, '..')
20
-
21
- function argValue(name: string): string | undefined {
22
- const idx = process.argv.indexOf(name)
23
- return idx >= 0 ? process.argv[idx + 1] : undefined
24
- }
25
-
26
- // Render the final source to PNG in a *fresh* process via `am render`. The
27
- // native PNG renderer (resvg) must not be loaded in this process: after MCP
28
- // Code Mode runs agent code in a `node:vm` sandbox, loading the native binding
29
- // here panics Bun (`panic: unreachable` on dlopen-after-vm). Shelling out to
30
- // the CLI keeps the dlopen in a clean process — same pattern as the MCP/CLI
31
- // parity example.
32
- function renderPngOutOfProcess(source: string, outPath: string): void {
33
- const srcPath = `${outPath}.src.mmd`
34
- writeFileSync(srcPath, source)
35
- try {
36
- const r = spawnSync(
37
- 'bun',
38
- ['run', join(REPO, 'bin/am.ts'), 'render', srcPath, '--format', 'png', '--output', outPath],
39
- { cwd: REPO, encoding: 'utf8' },
40
- )
41
- if (r.status !== 0) throw new Error(`am render --format png failed (${r.status})\nstderr: ${r.stderr}`)
42
- } finally {
43
- rmSync(srcPath, { force: true })
44
- }
45
- }
46
-
47
- const outDir = resolve(argValue('--out-dir') ?? mkdtempSync(join(tmpdir(), 'am-agent-improve-')))
48
- const useTestPngPlaceholder = process.argv.includes('--test-png-placeholder')
49
- mkdirSync(outDir, { recursive: true })
50
-
51
- const AGENT_CODE = `
52
- const parsed = mermaid.parseMermaid('---\\ntitle: Auth Flow Draft\\n---\\nflowchart LR\\n')
53
- if (!parsed.ok) return { phase: 'parse', errors: parsed.error }
54
-
55
- const flow = mermaid.asFlowchart(parsed.value)
56
- if (!flow) return { phase: 'narrow', error: 'not-flowchart' }
57
-
58
- let current = flow
59
- const createOps = [
60
- { kind: 'add_node', id: 'A', label: 'User' },
61
- { kind: 'add_node', id: 'B', label: 'Login Page' },
62
- { kind: 'add_node', id: 'C', label: 'Are the supplied credentials valid?', shape: 'diamond' },
63
- { kind: 'add_node', id: 'D', label: 'Does this user require multi-factor authentication?', shape: 'diamond' },
64
- { kind: 'add_node', id: 'E', label: 'Enter MFA Code' },
65
- { kind: 'add_node', id: 'F', label: 'Is the entered multi-factor code valid?', shape: 'diamond' },
66
- { kind: 'add_node', id: 'G', label: 'Create Session' },
67
- { kind: 'add_node', id: 'H', label: 'Dashboard' },
68
- { kind: 'add_edge', from: 'A', to: 'B' },
69
- { kind: 'add_edge', from: 'B', to: 'C' },
70
- { kind: 'add_edge', from: 'C', to: 'B', label: 'No' },
71
- { kind: 'add_edge', from: 'C', to: 'D', label: 'Yes' },
72
- { kind: 'add_edge', from: 'D', to: 'E', label: 'Yes' },
73
- { kind: 'add_edge', from: 'E', to: 'F' },
74
- { kind: 'add_edge', from: 'F', to: 'E', label: 'No' },
75
- { kind: 'add_edge', from: 'D', to: 'G', label: 'No' },
76
- { kind: 'add_edge', from: 'F', to: 'G', label: 'Yes' },
77
- { kind: 'add_edge', from: 'G', to: 'H' },
78
- ]
79
- for (const op of createOps) {
80
- const next = mermaid.mutate(current, op)
81
- if (!next.ok) return { phase: 'create', op, error: next.error }
82
- current = next.value
83
- }
84
-
85
- const assess = (diagram) => {
86
- const verify = mermaid.verifyMermaid(diagram, { labelCharCap: 28 })
87
- const source = mermaid.serializeMermaid(diagram)
88
- const labels = Array.from(source.matchAll(/[\\[{]([^\\]\\}]+)[\\]\\}]/g)).map(m => m[1])
89
- const longestLabel = labels.reduce((max, label) => Math.max(max, label.length), 0)
90
- return {
91
- ok: verify.ok,
92
- warningCount: verify.warnings.length,
93
- warnings: verify.warnings.map(w => ({ code: w.code, target: w.target, charCount: w.charCount, limit: w.limit })),
94
- longestLabel,
95
- bounds: verify.layout.bounds,
96
- source,
97
- }
98
- }
99
-
100
- const before = assess(current)
101
- const problems = []
102
- if (before.warnings.some(w => w.code === 'LABEL_OVERFLOW')) {
103
- problems.push('Decision labels are too long for compact rendering and screenshots.')
104
- }
105
- if (before.bounds.w > 1600) {
106
- problems.push('The left-to-right diagram is wide enough to be awkward in docs.')
107
- }
108
-
109
- const improveOps = [
110
- { kind: 'set_label', target: 'C', label: 'Valid Credentials?' },
111
- { kind: 'set_label', target: 'D', label: 'MFA Enabled?' },
112
- { kind: 'set_label', target: 'F', label: 'Code Valid?' },
113
- ]
114
- for (const op of improveOps) {
115
- const next = mermaid.mutate(current, op)
116
- if (!next.ok) return { phase: 'improve', op, error: next.error }
117
- current = next.value
118
- }
119
-
120
- const after = assess(current)
121
- const svg = mermaid.renderMermaidSVG(current, { security: 'strict' })
122
- const ascii = mermaid.renderMermaidASCII(current, { useAscii: true })
123
-
124
- return {
125
- createOps: createOps.length,
126
- improveOps: improveOps.length,
127
- problems,
128
- impact: {
129
- warningsBefore: before.warningCount,
130
- warningsAfter: after.warningCount,
131
- longestLabelBefore: before.longestLabel,
132
- longestLabelAfter: after.longestLabel,
133
- boundsBefore: before.bounds,
134
- boundsAfter: after.bounds,
135
- },
136
- beforeSource: before.source,
137
- source: after.source,
138
- svg,
139
- ascii,
140
- }
141
- `
142
-
143
- const response = await handleRequest({
144
- jsonrpc: '2.0',
145
- id: 1,
146
- method: 'tools/call',
147
- params: { name: 'execute', arguments: { code: AGENT_CODE } },
148
- })
149
-
150
- const text = (response?.result as { content?: Array<{ text?: string }> } | undefined)?.content?.[0]?.text
151
- if (typeof text !== 'string') throw new Error(`bad MCP response: ${JSON.stringify(response)}`)
152
- const executed = JSON.parse(text) as { ok: boolean; value?: unknown; error?: string }
153
- if (!executed.ok) throw new Error(`agent execute failed: ${executed.error ?? text}`)
154
-
155
- const result = executed.value as {
156
- createOps: number
157
- improveOps: number
158
- problems: string[]
159
- impact: Record<string, unknown>
160
- beforeSource: string
161
- source: string
162
- svg: string
163
- ascii: string
164
- }
165
-
166
- const files = {
167
- before: join(outDir, 'auth-flow-before.mmd'),
168
- source: join(outDir, 'auth-flow-improved.mmd'),
169
- svg: join(outDir, 'auth-flow-improved.svg'),
170
- ascii: join(outDir, 'auth-flow-improved.txt'),
171
- png: join(outDir, 'auth-flow-improved.png'),
172
- assessment: join(outDir, 'assessment.json'),
173
- }
174
-
175
- writeFileSync(files.before, result.beforeSource)
176
- writeFileSync(files.source, result.source)
177
- writeFileSync(files.svg, result.svg)
178
- writeFileSync(files.ascii, result.ascii)
179
- // PNG is binary, so the host renders it from the verified final source. The
180
- // default path renders the real PNG out-of-process (see renderPngOutOfProcess);
181
- // `--test-png-placeholder` writes a tiny stand-in to skip native rendering on
182
- // environments without the resvg binding.
183
- if (useTestPngPlaceholder) {
184
- writeFileSync(files.png, Buffer.from('iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8/x8AAwMCAO+/p9sAAAAASUVORK5CYII=', 'base64'))
185
- } else {
186
- renderPngOutOfProcess(result.source, files.png)
187
- }
188
- writeFileSync(files.assessment, JSON.stringify({
189
- createOps: result.createOps,
190
- improveOps: result.improveOps,
191
- problems: result.problems,
192
- impact: result.impact,
193
- }, null, 2) + '\n')
194
-
195
- writeFileSync(1, JSON.stringify({
196
- ok: true,
197
- outDir,
198
- files,
199
- problems: result.problems,
200
- impact: result.impact,
201
- }, null, 2) + '\n')
202
-
203
- // This example is often run from test subprocesses. Exit explicitly after the
204
- // output is synchronously flushed so platform-specific native/font handles
205
- // cannot keep the process open after the example has completed.
206
- process.exit(0)
@@ -1,53 +0,0 @@
1
- // Runnable example: the agent verify-before-commit loop.
2
- // bun run examples/agent-loop.ts
3
- //
4
- // Demonstrates parse → narrow → mutate (flowchart + sequence) → verify →
5
- // serialize, plus the opaque fallback for constructs we don't structurally model.
6
-
7
- import {
8
- parseMermaid, asFlowchart, asSequence, mutate, verifyMermaid, serializeMermaid,
9
- } from '../src/agent/index.ts'
10
-
11
- function line(s: string) { process.stdout.write(s + '\n') }
12
-
13
- // 1. Flowchart: insert a Cache between API and DB.
14
- {
15
- const d0 = parseMermaid('flowchart TD\n API --> DB')
16
- if (!d0.ok) throw new Error('parse failed')
17
- const flow = asFlowchart(d0.value)!
18
- const a = mutate(flow, { kind: 'add_node', id: 'Cache', label: 'Cache' })
19
- if (!a.ok) throw new Error(a.error.message)
20
- const b = mutate(a.value, { kind: 'add_edge', from: 'API', to: 'Cache' })
21
- if (!b.ok) throw new Error(b.error.message)
22
- const c = mutate(b.value, { kind: 'add_edge', from: 'Cache', to: 'DB' })
23
- if (!c.ok) throw new Error(c.error.message)
24
- const v = verifyMermaid(c.value)
25
- if (!v.ok) throw new Error('verify failed')
26
- line('--- flowchart ---')
27
- line(`verify ok: ${v.ok} warnings: ${v.warnings.length}`)
28
- line(serializeMermaid(c.value))
29
- }
30
-
31
- // 2. Sequence: add a reply.
32
- {
33
- const d0 = parseMermaid('sequenceDiagram\n Alice->>Bob: Hi')
34
- if (!d0.ok) throw new Error('parse failed')
35
- const seq = asSequence(d0.value)!
36
- const a = mutate(seq, { kind: 'add_message', from: 'Bob', to: 'Alice', text: 'Hello', style: 'reply' })
37
- if (!a.ok) throw new Error(a.error.message)
38
- const v = verifyMermaid(a.value)
39
- if (!v.ok) throw new Error('verify failed')
40
- line('--- sequence ---')
41
- line(`verify ok: ${v.ok} warnings: ${v.warnings.length}`)
42
- line(serializeMermaid(a.value))
43
- }
44
-
45
- // 3. Opaque fallback: a sequence diagram with a Note isn't structurally
46
- // mutable, but it round-trips losslessly via preserved body.source.
47
- {
48
- const d0 = parseMermaid('sequenceDiagram\n Alice->>Bob: Hi\n Note over Bob: thinking')
49
- if (!d0.ok) throw new Error('parse failed')
50
- line('--- opaque sequence (has a Note) ---')
51
- line(`asSequence is null (not mutable): ${asSequence(d0.value) === null}`)
52
- line(`round-trips losslessly: ${serializeMermaid(d0.value).includes('Note over Bob')}`)
53
- }
@@ -1,133 +0,0 @@
1
- // Runnable parity example: build complicated diagrams via MCP Code Mode and
2
- // via the `am` CLI, then assert the serialized Mermaid source is identical.
3
- // bun run examples/mcp-vs-cli-complex-diagrams.ts
4
- //
5
- // This intentionally uses MCP `execute` for composition. The non-Code-Mode
6
- // path is the CLI, not a parallel render-tool-per-format MCP surface.
7
-
8
- import { mkdtempSync, rmSync, writeFileSync } from 'node:fs'
9
- import { tmpdir } from 'node:os'
10
- import { join } from 'node:path'
11
- import { spawnSync } from 'node:child_process'
12
- import { handleRequest } from '../src/mcp/server.ts'
13
- import type { AnyMutationOp } from '../src/agent/types.ts'
14
-
15
- const REPO = join(import.meta.dir, '..')
16
-
17
- const CASES: Array<{ id: string; initialSource: string; ops: AnyMutationOp[] }> = [
18
- {
19
- id: 'auth-flow',
20
- initialSource: `---
21
- title: Auth Flow
22
- ---
23
- flowchart LR
24
- `,
25
- ops: [
26
- { kind: 'add_node', id: 'A', label: 'User' },
27
- { kind: 'add_node', id: 'B', label: 'Login Page' },
28
- { kind: 'add_node', id: 'C', label: 'Valid Credentials?', shape: 'diamond' },
29
- { kind: 'add_node', id: 'D', label: 'MFA Enabled?', shape: 'diamond' },
30
- { kind: 'add_node', id: 'E', label: 'Enter MFA Code' },
31
- { kind: 'add_node', id: 'F', label: 'Code Valid?', shape: 'diamond' },
32
- { kind: 'add_node', id: 'G', label: 'Create Session' },
33
- { kind: 'add_node', id: 'H', label: 'Dashboard' },
34
- { kind: 'add_edge', from: 'A', to: 'B' },
35
- { kind: 'add_edge', from: 'B', to: 'C' },
36
- { kind: 'add_edge', from: 'C', to: 'B', label: 'No' },
37
- { kind: 'add_edge', from: 'C', to: 'D', label: 'Yes' },
38
- { kind: 'add_edge', from: 'D', to: 'E', label: 'Yes' },
39
- { kind: 'add_edge', from: 'E', to: 'F' },
40
- { kind: 'add_edge', from: 'F', to: 'E', label: 'No' },
41
- { kind: 'add_edge', from: 'D', to: 'G', label: 'No' },
42
- { kind: 'add_edge', from: 'F', to: 'G', label: 'Yes' },
43
- { kind: 'add_edge', from: 'G', to: 'H' },
44
- ],
45
- },
46
- {
47
- id: 'order-domain-er',
48
- initialSource: `---
49
- title: Order Domain
50
- ---
51
- erDiagram
52
- `,
53
- ops: [
54
- { kind: 'add_entity', id: 'CUSTOMER', attributes: ['string id', 'string email'] },
55
- { kind: 'add_entity', id: 'ORDER', attributes: ['string id', 'date placed_at', 'string status'] },
56
- { kind: 'add_entity', id: 'LINE_ITEM', attributes: ['string id', 'int quantity'] },
57
- { kind: 'add_entity', id: 'PRODUCT', attributes: ['string sku', 'string name'] },
58
- { kind: 'add_relation', from: 'CUSTOMER', to: 'ORDER', leftCard: 'one-only', rightCard: 'zero-or-many', label: 'places' },
59
- { kind: 'add_relation', from: 'ORDER', to: 'LINE_ITEM', leftCard: 'one-only', rightCard: 'one-or-many', label: 'contains' },
60
- { kind: 'add_relation', from: 'PRODUCT', to: 'LINE_ITEM', leftCard: 'one-only', rightCard: 'zero-or-many', label: 'appears_in' },
61
- ],
62
- },
63
- ]
64
-
65
- async function buildViaMcpCodeMode(c: typeof CASES[number]): Promise<string> {
66
- const code = `
67
- const parsed = mermaid.parseMermaid(${JSON.stringify(c.initialSource)})
68
- if (!parsed.ok) return { error: parsed.error }
69
- const narrow = parsed.value.kind === 'er' ? mermaid.asEr(parsed.value) : mermaid.asFlowchart(parsed.value)
70
- if (!narrow) return { error: 'unsupported-family', family: parsed.value.kind }
71
- let current = narrow
72
- const ops = ${JSON.stringify(c.ops)}
73
- for (const op of ops) {
74
- const next = mermaid.mutate(current, op)
75
- if (!next.ok) return { error: next.error, op }
76
- current = next.value
77
- }
78
- const verify = mermaid.verifyMermaid(current)
79
- if (!verify.ok) return { error: 'verify', warnings: verify.warnings }
80
- return { source: mermaid.serializeMermaid(current) }
81
- `
82
-
83
- const response = await handleRequest({
84
- jsonrpc: '2.0',
85
- id: c.id,
86
- method: 'tools/call',
87
- params: { name: 'execute', arguments: { code } },
88
- })
89
- const payload = parseMcpTextPayload(response)
90
- if (!payload.ok) throw new Error(`MCP execute failed for ${c.id}: ${payload.error}`)
91
- const value = payload.value as { source?: unknown }
92
- if (typeof value.source !== 'string') throw new Error(`MCP returned no source for ${c.id}: ${JSON.stringify(value)}`)
93
- return value.source
94
- }
95
-
96
- function buildViaCli(c: typeof CASES[number]): string {
97
- const dir = mkdtempSync(join(tmpdir(), `am-${c.id}-`))
98
- try {
99
- const input = join(dir, `${c.id}.mmd`)
100
- const ops = join(dir, 'ops.json')
101
- writeFileSync(input, c.initialSource)
102
- writeFileSync(ops, JSON.stringify(c.ops, null, 2))
103
- const r = spawnSync('bun', ['run', join(REPO, 'bin/am.ts'), 'mutate', input, '--ops', ops, '--json'], {
104
- cwd: REPO,
105
- encoding: 'utf8',
106
- })
107
- if (r.status !== 0) throw new Error(`CLI failed for ${c.id} (${r.status})\nstdout: ${r.stdout}\nstderr: ${r.stderr}`)
108
- const payload = JSON.parse(r.stdout) as { ok: boolean; source?: unknown; error?: unknown }
109
- if (!payload.ok || typeof payload.source !== 'string') throw new Error(`CLI returned no source for ${c.id}: ${r.stdout}`)
110
- return payload.source
111
- } finally {
112
- rmSync(dir, { recursive: true, force: true })
113
- }
114
- }
115
-
116
- function parseMcpTextPayload(response: Awaited<ReturnType<typeof handleRequest>>): { ok: boolean; value?: unknown; error?: string } {
117
- const text = (response?.result as { content?: Array<{ text?: string }> } | undefined)?.content?.[0]?.text
118
- if (typeof text !== 'string') return { ok: false, error: `bad MCP response: ${JSON.stringify(response)}` }
119
- const executeResult = JSON.parse(text) as { ok: boolean; value?: unknown; error?: string }
120
- return executeResult.ok ? { ok: true, value: executeResult.value } : { ok: false, error: executeResult.error ?? text }
121
- }
122
-
123
- const sources: Record<string, string> = {}
124
- for (const c of CASES) {
125
- const mcpSource = await buildViaMcpCodeMode(c)
126
- const cliSource = buildViaCli(c)
127
- if (mcpSource !== cliSource) {
128
- throw new Error(`${c.id}: MCP and CLI produced different source\n--- MCP ---\n${mcpSource}\n--- CLI ---\n${cliSource}`)
129
- }
130
- sources[c.id] = mcpSource
131
- }
132
-
133
- console.log(JSON.stringify({ ok: true, channelA: 'mcp.execute', channelB: 'am mutate --ops', cases: Object.keys(sources), sources }, null, 2))
package/llms.txt DELETED
@@ -1,104 +0,0 @@
1
- # Agentic Mermaid
2
-
3
- > Agent-native Mermaid runtime: parse, verify, mutate, and round-trip
4
- > Mermaid diagrams with a typed IR. Deterministic ASCII / PNG / SVG. No
5
- > browser required. CLI + MCP + library.
6
-
7
- Version: 0.1.1
8
-
9
- ## What it does
10
-
11
- A typed editing surface over Mermaid for AI agents. Parse a diagram to a
12
- ValidDiagram, mutate it with typed ops, verify structurally (no pixels),
13
- serialize back to canonical source. Layout is deterministic (verified
14
- cross-process and same-machine cross-runtime on x86_64/ARM64).
15
-
16
- ## The agent loop
17
-
18
- New diagrams: author Mermaid source → parse → verify → render/return.
19
- Existing structured diagrams: parse → narrow → mutate → verify → serialize.
20
- Run verify at every commit point. Never serialize a diagram whose verify result
21
- you haven't inspected.
22
-
23
- ## CLI verbs (`am <verb>`)
24
-
25
- - render --format svg, ascii, unicode, json [--security strict] — render a diagram
26
- - render --format png --output file.png — render one input to PNG (no PNG bytes on stdout, no multi-input/watch)
27
- - render --style <names|file.json> --seed N — styled svg/png; comma-separate to stack (--style hand-drawn,dracula)
28
- - styles [--json] — list registered styles (default + full looks + palette-only themes)
29
- - parse — diagram → ValidDiagram JSON
30
- - verify — structural validation (exit 3 if invalid)
31
- - mutate --op '<json>' / --ops '<json array|file>' — apply typed mutation(s), verify, then emit source
32
- - preview [--output file.html] [--open] — standalone strict-mode HTML preview for user inspection
33
- - format — normalize / canonicalize source
34
- - describe [--format text|json|facts] — natural-language, AX-tree, or semantic facts summary
35
- - capabilities --json — machine-readable capability envelope incl. editPolicy + mutationOps
36
- - batch --jsonl — bulk render/verify/parse/serialize/mutate ops, one JSON envelope per line
37
- - render-markdown <file.md> [--ascii] — render fenced mermaid blocks, skip invalid ones
38
- - llms-txt — this document
39
- - init-agent [--dir .] [--force] — write AGENTS.md section, root skills/ bundle, and .mcp.json sample
40
-
41
- Exit codes: 0 ok, 2 arg error, 3 verify-failed, 4 internal.
42
-
43
- ## MCP tools
44
-
45
- Code Mode `execute(code)` (JavaScript in a node:vm sandbox with a typed
46
- mermaid.* SDK declaration) plus narrow helper tools: render_png and describe.
47
- render_png is offline.
48
-
49
- ## Output formats
50
-
51
- Agentic Mermaid outputs SVG, PNG, ASCII, Unicode, and JSON layout. Full capability list: svg, ascii, unicode, png, json. SVG strict mode (security: 'strict') emits zero external-fetch
52
- references — safe for untrusted/agent-generated diagrams. See SECURITY.md.
53
-
54
- ## Diagram families
55
-
56
- All families parse, verify, render, round-trip: flowchart, state, sequence, timeline, class, er, journey, architecture, xychart, pie, quadrant, gantt.
57
- Structured mutation (structured-when-narrowed): flowchart, state, sequence, timeline, class, er, journey, architecture, xychart, pie, quadrant, gantt.
58
- Narrowers: asFlowchart, asState, asSequence, asTimeline, asClass, asEr, asJourney, asArchitecture, asXyChart, asPie, asQuadrant, asGantt.
59
- State diagrams own a dedicated body (BUILD-19): narrow with asState; state-shaped ops apply (asFlowchart returns null on them).
60
- Source-level-only: none — every renderable family ships structured mutation.
61
- Opaque-fallback bodies (unmodeled syntax) round-trip losslessly via preserved source (never silently dropped) and stay source-level only.
62
-
63
- ## Warning codes
64
-
65
- EMPTY_DIAGRAM (structural/error), UNRESOLVABLE_SCHEDULE (structural/error), RENDER_FAILED (structural/error), EDGE_MISANCHORED (structural/error), OFF_CANVAS (structural/error), GROUP_BREACH (structural/error), UNKNOWN_SHAPE (structural/warning), LABEL_OVERFLOW (structural/warning), NODE_OVERLAP (geometric/warning), ROUTE_SELF_CROSS (geometric/warning), ROUTE_HITCH (geometric/warning), ROUTE_UNEXPLAINED_BEND (geometric/warning), ROUTE_LABEL_ON_SHARED_TRUNK (geometric/warning), ROUTE_CONTAINER_MISANCHOR (geometric/warning), ROUTE_SHAPE_MISANCHOR (geometric/warning), ROUTE_STALE_AFTER_NODE_MOVE (geometric/warning), DUPLICATE_EDGE (lint/warning), UNREACHABLE_NODE (lint/warning), DECISION_BRANCH_UNLABELED (lint/warning), COMMENT_DROPPED (lint/warning), UNSUPPORTED_SYNTAX (lint/warning), CONTENT_DROPPED_ON_ROUNDTRIP (lint/warning), INEFFECTIVE_CONFIG (lint/warning)
66
-
67
- ## Library
68
-
69
- `import { parseMermaid, mutate, verifyMermaid, analyzeMermaid,
70
- analyzeMermaidSource, serializeMermaid, renderMermaidASCII,
71
- renderMermaidPNG, renderMermaidSVG, renderMermaidASCIIWithMeta,
72
- describeMermaid, asciiToMermaid, verifyNoExternalRefs,
73
- registerStyle, knownStyles, validateStyleSpec } from 'agentic-mermaid/agent'`
74
-
75
- ## Styles
76
-
77
- Every render call accepts style: a name ('hand-drawn', 'excalidraw',
78
- 'pen-and-ink', 'freehand', 'watercolor', 'blueprint', 'tufte', or any theme
79
- name — a theme is a palette-only style), an inline JSON spec, or a stack
80
- merged left → right ({ style: ['hand-drawn', 'dracula'] }). seed re-rolls
81
- ink wobble, never layout — (source, style, seed) reproduces an image
82
- exactly. Custom styles are data: validateStyleSpec(json) checks untrusted
83
- records, registerStyle({ name, … }) makes them addressable by name.
84
- Authoring guide + quality rubric: docs/style-authoring.md.
85
-
86
- ## Docs
87
-
88
- - docs/README.md — documentation index and structure
89
- - Instructions_for_agents.md — canonical agent-use guide
90
- - AGENT_NATIVE.md — architecture/spec rationale
91
- - docs/features.md — current capability inventory
92
- - docs/api.md — library/CLI/MCP API reference, including SVG/PNG/ASCII output
93
- - docs/diagram-families.md — family examples and edit policy
94
- - docs/theming.md — themes, CSS variables, and Shiki compatibility
95
- - docs/style-authoring.md — styles: the composable look system (a theme is a palette-only style; stack names/specs; author custom styles as data records with the quality rubric)
96
- - docs/quality.md — determinism + "good looking" rubric
97
- - TODO.md — only active backlog
98
- - SECURITY.md — threat model + strict-mode guarantee
99
- - docs/agent-mutation-policy.md — structured-vs-source-level policy
100
- - docs/agent-api-cookbook.md — copy-pasteable library/CLI/MCP recipes
101
- - docs/mcp-code-mode-rationale.md — MCP surface rationale
102
- - docs/agent-workflow-examples.md — runnable MCP/CLI + agent-improvement examples
103
- - skills/ — agent-agnostic SKILL.md bundles for diagram workflow and live-editor development
104
- - skill-evals/ — skill-eval-harness manifest, fixtures, and benchmark instructions
@@ -1,77 +0,0 @@
1
- # Skill evals
2
-
3
- This directory contains the `skill-eval-harness` manifest for the repository’s agent-agnostic skills under [`../skills/`](../skills/).
4
-
5
- ## Coverage matrix
6
-
7
- The public tune split now includes:
8
-
9
- - Diagram families: flowchart, state, sequence, timeline, class, ER, journey,
10
- architecture, xychart, pie, quadrant, gantt.
11
- - Channels: library, CLI, and MCP Code Mode.
12
- - Negative/no-trigger rows for unrelated work.
13
- - Adversarial rows for source concatenation, skipping verify, editing generated `editor.html`, and using `type` instead of `kind`.
14
- - Fixture-backed artifact rows under [`fixtures/`](./fixtures/) that require changed Mermaid/source plus `verifyMermaid` evidence.
15
-
16
- The manifest also contains private `prompt_ref` stubs for `holdout` and `holdback`. Those paths are intentionally under ignored `skill-evals/private/`; keep real hidden prompts and answer keys out of public commits.
17
-
18
- ## Harness
19
-
20
- Install/run with:
21
-
22
- ```bash
23
- uvx --from git+https://github.com/adewale/skill-eval-harness.git@v0.1.1 skill-benchmark --help
24
- ```
25
-
26
- Validate and audit the public manifest:
27
-
28
- ```bash
29
- skill-benchmark validate skill-evals/shared-benchmark.json
30
- skill-benchmark audit-manifest skill-evals/shared-benchmark.json --format markdown --out /tmp/agentic-mermaid-skill-audit.md
31
- ```
32
-
33
- Use strict hidden-prompt validation only in a private eval workspace where `skill-evals/private/...` exists:
34
-
35
- ```bash
36
- skill-benchmark validate skill-evals/shared-benchmark.json --strict-holdback
37
- ```
38
-
39
- Prepare visible tune tasks with repeated runs:
40
-
41
- ```bash
42
- skill-benchmark prepare skill-evals/shared-benchmark.json \
43
- --split tune \
44
- --runs-per-variant 5 \
45
- --out /tmp/agentic-mermaid-skill-tasks.jsonl
46
- ```
47
-
48
- Use 3 runs per variant for cheap iteration; use 5 for pre-merge/release evidence. Fixture-backed artifact cases require a runner that preserves generated `outputs/...` files inside each run directory so `file_exists` assertions can grade them.
49
-
50
- Run autonomous trigger/no-trigger checks separately:
51
-
52
- ```bash
53
- skill-pi-trigger-eval skill-evals/shared-benchmark.json \
54
- --split tune \
55
- --runs-per-query 5 \
56
- --out /tmp/agentic-mermaid-trigger-report.json
57
- ```
58
-
59
- After running the prepared tasks with a coding-agent runner, grade with:
60
-
61
- ```bash
62
- skill-benchmark benchmark skill-evals/shared-benchmark.json \
63
- --runs /tmp/agentic-mermaid-skill-runs \
64
- --split tune \
65
- --out /tmp/agentic-mermaid-skill-benchmark.json
66
- ```
67
-
68
- ## Latest smoke result
69
-
70
- Runner: Pi CLI, one run per variant, tune split only, model reported by Pi as `gpt-5.5` / `openai-codex`.
71
-
72
- | Variant | Cases | Runs | Mean objective pass rate |
73
- |---|---:|---:|---:|
74
- | `with_skill` | 2 | 2 | 1.00 |
75
- | `without_skill` | 2 | 2 | 0.00 |
76
-
77
- That older result was a positive smoke signal. It is superseded as a coverage target by the expanded manifest above and should be rerun with 3–5 runs per variant before claiming benchmark-level evidence.
@@ -1,5 +0,0 @@
1
- architecture-beta
2
- group app(cloud)[Application]
3
- service api(server)[API] in app
4
- service db(database)[Database] in app
5
- api:R -- L:db
@@ -1,4 +0,0 @@
1
- classDiagram
2
- class PaymentService
3
- class Invoice
4
- PaymentService --> Invoice : creates
@@ -1,10 +0,0 @@
1
- erDiagram
2
- CUSTOMER {
3
- string id PK
4
- string email
5
- }
6
- ORDER {
7
- string id PK
8
- string customer_id FK
9
- }
10
- CUSTOMER ||--o{ ORDER : places
@@ -1,3 +0,0 @@
1
- flowchart TD
2
- Client[Client] --> API[API]
3
- API --> DB[(Database)]
@@ -1,7 +0,0 @@
1
- gantt
2
- title Release train
3
- dateFormat YYYY-MM-DD
4
- section Build
5
- Build renderer :build, 2024-01-08, 3d
6
- section Ship
7
- Release :milestone, rel, after build, 0d
@@ -1,6 +0,0 @@
1
- journey
2
- title Checkout
3
- section Browse
4
- Find item: 4: Customer
5
- section Pay
6
- Enter payment: 3: Customer
@@ -1,5 +0,0 @@
1
- pie showData
2
- title Export requests
3
- "SVG" : 42
4
- "PNG" : 28
5
- "ASCII" : 18
@@ -1,11 +0,0 @@
1
- quadrantChart
2
- title Feature priorities
3
- x-axis Low impact --> High impact
4
- y-axis Low effort --> High effort
5
- quadrant-1 Plan carefully
6
- quadrant-2 Big bets
7
- quadrant-3 Defer
8
- quadrant-4 Quick wins
9
- SVG export: [0.78, 0.28]
10
- MCP setup: [0.62, 0.72]
11
- Theme polish: [0.35, 0.24]
@@ -1,8 +0,0 @@
1
- sequenceDiagram
2
- participant Client
3
- participant API
4
- participant DB
5
- Client->>API: Request
6
- API->>DB: Query
7
- DB-->>API: Result
8
- API-->>Client: Response
@@ -1,5 +0,0 @@
1
- stateDiagram-v2
2
- [*] --> Idle
3
- Idle --> Processing: start
4
- Processing --> Complete: done
5
- Complete --> [*]
@@ -1,6 +0,0 @@
1
- timeline
2
- title Agentic Mermaid Release
3
- section Plan
4
- Design : API surface
5
- section Build
6
- Implement : Renderer