session-orchestrator 3.16.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/.claude-plugin/marketplace.json +29 -0
- package/.claude-plugin/plugin.json +18 -0
- package/.codex-plugin/agents/explorer.toml +14 -0
- package/.codex-plugin/agents/session-reviewer.toml +23 -0
- package/.codex-plugin/agents/wave-worker.toml +15 -0
- package/.codex-plugin/config.toml +20 -0
- package/.codex-plugin/plugin.json +37 -0
- package/.cursor/rules/000-session-orchestrator.mdc +73 -0
- package/.cursor/rules/010-session-workflow.mdc +170 -0
- package/.cursor/rules/020-quality-gates.mdc +128 -0
- package/.cursor/rules/030-wave-execution.mdc +216 -0
- package/.cursor/rules/040-discovery.mdc +242 -0
- package/.cursor/rules/050-plan.mdc +235 -0
- package/.cursor/rules/060-evolve.mdc +232 -0
- package/.cursor/rules/070-gitlab-ops.mdc +246 -0
- package/.cursor/rules/080-ecosystem-health.mdc +145 -0
- package/.mcp.json +8 -0
- package/CHANGELOG.md +1544 -0
- package/LICENSE +21 -0
- package/NOTICE +64 -0
- package/README.md +242 -0
- package/SECURITY.md +90 -0
- package/agents/AGENTS.md +136 -0
- package/agents/analyst.md +99 -0
- package/agents/architect-reviewer.md +93 -0
- package/agents/code-implementer.md +106 -0
- package/agents/db-specialist.md +104 -0
- package/agents/dialectic-deriver.md +139 -0
- package/agents/docs-writer.md +113 -0
- package/agents/eval-judge.md +146 -0
- package/agents/memory-proposal-collector.md +297 -0
- package/agents/qa-strategist.md +102 -0
- package/agents/schemas/analyst.schema.json +46 -0
- package/agents/schemas/architect-reviewer.schema.json +50 -0
- package/agents/schemas/code-implementer.schema.json +61 -0
- package/agents/schemas/db-specialist.schema.json +80 -0
- package/agents/schemas/docs-writer.schema.json +56 -0
- package/agents/schemas/persona-panel-sidecar.schema.json +245 -0
- package/agents/schemas/qa-strategist.schema.json +46 -0
- package/agents/schemas/security-reviewer.schema.json +86 -0
- package/agents/schemas/session-reviewer.schema.json +69 -0
- package/agents/schemas/test-writer.schema.json +69 -0
- package/agents/schemas/ui-developer.schema.json +90 -0
- package/agents/schemas/ux-evaluator.schema.json +51 -0
- package/agents/security-reviewer.md +236 -0
- package/agents/session-reviewer.md +201 -0
- package/agents/skill-applied-judge.md +122 -0
- package/agents/test-writer.md +123 -0
- package/agents/ui-developer.md +109 -0
- package/agents/ux-evaluator.md +161 -0
- package/assets/icon.svg +11 -0
- package/assets/og-card.png +0 -0
- package/assets/og-card.svg +47 -0
- package/commands/autopilot-multi.md +74 -0
- package/commands/autopilot.md +80 -0
- package/commands/bootstrap.md +56 -0
- package/commands/brainstorm.md +48 -0
- package/commands/close.md +24 -0
- package/commands/debug.md +36 -0
- package/commands/discovery.md +32 -0
- package/commands/dispatcher.md +59 -0
- package/commands/eval.md +28 -0
- package/commands/evolve.md +10 -0
- package/commands/go.md +41 -0
- package/commands/grill.md +45 -0
- package/commands/harness-audit.md +26 -0
- package/commands/memory-cleanup.md +25 -0
- package/commands/persona-panel.md +121 -0
- package/commands/plan.md +15 -0
- package/commands/portfolio.md +97 -0
- package/commands/reconcile.md +23 -0
- package/commands/repo-audit.md +24 -0
- package/commands/session.md +30 -0
- package/commands/spinout.md +15 -0
- package/commands/sunset-review.md +27 -0
- package/commands/templates-ack.md +96 -0
- package/commands/test.md +97 -0
- package/docs/README.md +105 -0
- package/docs/USER-GUIDE.md +1403 -0
- package/docs/ci-setup.md +81 -0
- package/docs/codex-setup.md +142 -0
- package/docs/components.md +74 -0
- package/docs/cursor-setup.md +104 -0
- package/docs/events-schema.md +81 -0
- package/docs/migration-v3.md +148 -0
- package/docs/owner-config-schema.md +154 -0
- package/docs/persona-panel.md +433 -0
- package/docs/pi-setup.md +115 -0
- package/docs/plugin-architecture-v3.md +296 -0
- package/docs/pm-skills-marketplace.md +114 -0
- package/docs/policy-cache-validation-2026-04-28.md +118 -0
- package/docs/rule-authoring.md +316 -0
- package/docs/session-config-reference.md +1439 -0
- package/docs/session-config-template.md +961 -0
- package/docs/vault-docs-architecture.md +297 -0
- package/hooks/_lib/lock-bootstrap.mjs +272 -0
- package/hooks/_lib/lock-reconcile.mjs +93 -0
- package/hooks/_lib/profile-gate.mjs +95 -0
- package/hooks/_lib/transcript-history.mjs +211 -0
- package/hooks/agent-teams-h3-test.sh +362 -0
- package/hooks/config-protection.mjs +0 -0
- package/hooks/cwd-change-restore.mjs +131 -0
- package/hooks/enforce-commands.mjs +179 -0
- package/hooks/enforce-scope.mjs +273 -0
- package/hooks/hooks-codex.json +60 -0
- package/hooks/hooks-cursor.json +15 -0
- package/hooks/hooks-pi.json +115 -0
- package/hooks/hooks.json +215 -0
- package/hooks/loop-guard.mjs +260 -0
- package/hooks/on-session-end.mjs +217 -0
- package/hooks/on-session-start.mjs +660 -0
- package/hooks/on-stop.mjs +294 -0
- package/hooks/operator-steer.mjs +64 -0
- package/hooks/post-edit-validate.mjs +225 -0
- package/hooks/post-subagent-discovery-validator.mjs +398 -0
- package/hooks/post-tool-batch-wave-signal.mjs +328 -0
- package/hooks/post-tool-failure-corrective-context.mjs +248 -0
- package/hooks/post-tooluse-frontend-slop.mjs +184 -0
- package/hooks/pre-bash-destructive-guard.mjs +515 -0
- package/hooks/pre-bash-memory-propose-audit.mjs +206 -0
- package/hooks/pre-bash-staging-fence.mjs +223 -0
- package/hooks/pre-bash-templates-first.mjs +404 -0
- package/hooks/run-node.sh +72 -0
- package/hooks/skill-invocation-telemetry.mjs +99 -0
- package/hooks/subagent-telemetry.mjs +249 -0
- package/hooks/wave-scope-commit-guard.mjs +191 -0
- package/monitors/monitors.json +14 -0
- package/output-styles/finding-report.md +48 -0
- package/output-styles/session-report.md +53 -0
- package/output-styles/wave-summary.md +38 -0
- package/package.json +94 -0
- package/pi/extensions/session-orchestrator.ts +25 -0
- package/pi/prompts/autopilot-multi.md +12 -0
- package/pi/prompts/autopilot.md +12 -0
- package/pi/prompts/bootstrap.md +12 -0
- package/pi/prompts/brainstorm.md +12 -0
- package/pi/prompts/close.md +11 -0
- package/pi/prompts/debug.md +12 -0
- package/pi/prompts/discovery.md +12 -0
- package/pi/prompts/dispatcher.md +12 -0
- package/pi/prompts/eval.md +12 -0
- package/pi/prompts/evolve.md +12 -0
- package/pi/prompts/go.md +12 -0
- package/pi/prompts/grill.md +12 -0
- package/pi/prompts/harness-audit.md +12 -0
- package/pi/prompts/memory-cleanup.md +12 -0
- package/pi/prompts/persona-panel.md +12 -0
- package/pi/prompts/plan.md +12 -0
- package/pi/prompts/portfolio.md +12 -0
- package/pi/prompts/reconcile.md +12 -0
- package/pi/prompts/repo-audit.md +12 -0
- package/pi/prompts/session.md +12 -0
- package/pi/prompts/spinout.md +12 -0
- package/pi/prompts/sunset-review.md +12 -0
- package/pi/prompts/templates-ack.md +12 -0
- package/pi/prompts/test.md +12 -0
- package/rules/_index.md +51 -0
- package/rules/always-on/commit-discipline.md +26 -0
- package/rules/always-on/npm-quality-gates.md +26 -0
- package/rules/always-on/parallel-sessions.md +43 -0
- package/rules/opt-in-domain/prompt-caching.md +270 -0
- package/rules/opt-in-stack/backend-data.md +188 -0
- package/rules/opt-in-stack/backend.md +390 -0
- package/rules/opt-in-stack/frontend.md +98 -0
- package/rules/opt-in-stack/security-web.md +194 -0
- package/rules/opt-in-stack/swift.md +65 -0
- package/scripts/archive-closed-prds.mjs +416 -0
- package/scripts/autopilot-multi.mjs +802 -0
- package/scripts/autopilot.mjs +383 -0
- package/scripts/backfill-abandoned-sessions.mjs +265 -0
- package/scripts/backfill-learnings-expires.mjs +196 -0
- package/scripts/backfill-learnings.mjs +203 -0
- package/scripts/backfill-sessions.mjs +282 -0
- package/scripts/check-doc-consistency.sh +279 -0
- package/scripts/check-package-manager.mjs +445 -0
- package/scripts/ci/assert-vitest-green.mjs +267 -0
- package/scripts/codex-install.mjs +435 -0
- package/scripts/compute-grounding-injection.sh +186 -0
- package/scripts/cursor-install.mjs +113 -0
- package/scripts/dialectic-deriver.mjs +573 -0
- package/scripts/emit-event.mjs +160 -0
- package/scripts/emit-session.mjs +212 -0
- package/scripts/eval-session.mjs +262 -0
- package/scripts/export-hw-learnings.mjs +437 -0
- package/scripts/gc-stale-worktrees.mjs +666 -0
- package/scripts/generate-pi-prompts.mjs +127 -0
- package/scripts/harness-audit.mjs +287 -0
- package/scripts/lib/agent-frontmatter.mjs +266 -0
- package/scripts/lib/agent-output-schema.mjs +166 -0
- package/scripts/lib/agent-status.mjs +303 -0
- package/scripts/lib/ajv-loader.mjs +34 -0
- package/scripts/lib/auto-dialectic.mjs +382 -0
- package/scripts/lib/auto-dream.mjs +471 -0
- package/scripts/lib/autonomy/suitability.mjs +212 -0
- package/scripts/lib/autopilot/dep-graph.mjs +417 -0
- package/scripts/lib/autopilot/durable-telemetry.mjs +121 -0
- package/scripts/lib/autopilot/flags.mjs +104 -0
- package/scripts/lib/autopilot/kill-switches.mjs +174 -0
- package/scripts/lib/autopilot/loop.mjs +320 -0
- package/scripts/lib/autopilot/mr-draft.mjs +520 -0
- package/scripts/lib/autopilot/multi-killswitch.mjs +184 -0
- package/scripts/lib/autopilot/recent-runs.mjs +106 -0
- package/scripts/lib/autopilot/stall-sampler.mjs +97 -0
- package/scripts/lib/autopilot/telemetry.mjs +224 -0
- package/scripts/lib/autopilot/worktree-pipeline.mjs +605 -0
- package/scripts/lib/autopilot-telemetry.mjs +11 -0
- package/scripts/lib/autopilot.mjs +39 -0
- package/scripts/lib/backlog-scan.mjs +179 -0
- package/scripts/lib/bootstrap-lock-freshness.mjs +260 -0
- package/scripts/lib/bootstrap-lock-refresh.mjs +186 -0
- package/scripts/lib/build-live-signals.mjs +150 -0
- package/scripts/lib/ci-status-banner.mjs +425 -0
- package/scripts/lib/claude-md-budget-lint.mjs +246 -0
- package/scripts/lib/cli-flags.mjs +158 -0
- package/scripts/lib/codex/plugin-contract.mjs +610 -0
- package/scripts/lib/cold-start-detector.mjs +240 -0
- package/scripts/lib/command-blocker.mjs +458 -0
- package/scripts/lib/common.mjs +333 -0
- package/scripts/lib/config/auto-dream.mjs +77 -0
- package/scripts/lib/config/block-header.mjs +94 -0
- package/scripts/lib/config/broken-window.mjs +114 -0
- package/scripts/lib/config/coercers.mjs +248 -0
- package/scripts/lib/config/cold-start.mjs +92 -0
- package/scripts/lib/config/config-protection.mjs +120 -0
- package/scripts/lib/config/cross-repo.mjs +104 -0
- package/scripts/lib/config/custom-phases.mjs +213 -0
- package/scripts/lib/config/dialectic.mjs +92 -0
- package/scripts/lib/config/discovery-validator.mjs +75 -0
- package/scripts/lib/config/dispatcher-autonomy-capture.mjs +240 -0
- package/scripts/lib/config/dispatcher-autonomy.mjs +152 -0
- package/scripts/lib/config/docs-orchestrator.mjs +90 -0
- package/scripts/lib/config/docs-staleness.mjs +96 -0
- package/scripts/lib/config/drift-check.mjs +155 -0
- package/scripts/lib/config/eval.mjs +130 -0
- package/scripts/lib/config/events-rotation.mjs +74 -0
- package/scripts/lib/config/evolve.mjs +308 -0
- package/scripts/lib/config/frontend-slop-hook.mjs +104 -0
- package/scripts/lib/config/gitlab-portfolio.mjs +150 -0
- package/scripts/lib/config/handover-gate.mjs +106 -0
- package/scripts/lib/config/host-paths.mjs +76 -0
- package/scripts/lib/config/io.mjs +54 -0
- package/scripts/lib/config/loop-guard.mjs +117 -0
- package/scripts/lib/config/memory.mjs +150 -0
- package/scripts/lib/config/persona-gate-wave.mjs +258 -0
- package/scripts/lib/config/reconcile.mjs +205 -0
- package/scripts/lib/config/section-extractor.mjs +100 -0
- package/scripts/lib/config/skill-evolution.mjs +112 -0
- package/scripts/lib/config/slopcheck.mjs +99 -0
- package/scripts/lib/config/state-md-lock.mjs +83 -0
- package/scripts/lib/config/templates-first.mjs +94 -0
- package/scripts/lib/config/test.mjs +113 -0
- package/scripts/lib/config/vault-integration.mjs +201 -0
- package/scripts/lib/config/vault-mirror-quality.mjs +99 -0
- package/scripts/lib/config/vault-staleness.mjs +84 -0
- package/scripts/lib/config/vault-sync.mjs +96 -0
- package/scripts/lib/config/verification-auto-fix.mjs +84 -0
- package/scripts/lib/config/wave-reviewers.mjs +133 -0
- package/scripts/lib/config-schema.mjs +345 -0
- package/scripts/lib/config.mjs +474 -0
- package/scripts/lib/convergence-monitor.mjs +389 -0
- package/scripts/lib/coordinator-snapshot.mjs +371 -0
- package/scripts/lib/crypto-digest-utils.mjs +91 -0
- package/scripts/lib/discovery/helpers.mjs +127 -0
- package/scripts/lib/discovery/triage-state.mjs +279 -0
- package/scripts/lib/dispatcher/cli.mjs +257 -0
- package/scripts/lib/dispatcher/enumerate.mjs +243 -0
- package/scripts/lib/dispatcher/rank.mjs +363 -0
- package/scripts/lib/ecosystem-health.mjs +224 -0
- package/scripts/lib/ecosystem-wizard/ci-detector.mjs +18 -0
- package/scripts/lib/ecosystem-wizard/config-parser.mjs +54 -0
- package/scripts/lib/ecosystem-wizard/config-writer.mjs +287 -0
- package/scripts/lib/ecosystem-wizard/package-manager-detector.mjs +42 -0
- package/scripts/lib/ecosystem-wizard/wizard-prompt.mjs +246 -0
- package/scripts/lib/ecosystem-wizard.mjs +48 -0
- package/scripts/lib/env-check.mjs +89 -0
- package/scripts/lib/eval/engine.mjs +605 -0
- package/scripts/lib/eval/judge.mjs +433 -0
- package/scripts/lib/eval/report.mjs +367 -0
- package/scripts/lib/eval/schema.mjs +618 -0
- package/scripts/lib/eval/session-resolve.mjs +137 -0
- package/scripts/lib/eval/sink.mjs +77 -0
- package/scripts/lib/events-rotation.mjs +86 -0
- package/scripts/lib/events-schema.mjs +81 -0
- package/scripts/lib/events.mjs +80 -0
- package/scripts/lib/evolve/autonomy-verdict.mjs +461 -0
- package/scripts/lib/evolve/autopilot-effectiveness.mjs +293 -0
- package/scripts/lib/exclusivity-matrix.mjs +68 -0
- package/scripts/lib/fetch-baseline.mjs +311 -0
- package/scripts/lib/file-lock.mjs +512 -0
- package/scripts/lib/frontend-detect/detect.mjs +138 -0
- package/scripts/lib/frontend-detect/rules.mjs +295 -0
- package/scripts/lib/frontmatter-guard.mjs +241 -0
- package/scripts/lib/gates/echo-stub-detect.mjs +39 -0
- package/scripts/lib/gates/gate-baseline.mjs +42 -0
- package/scripts/lib/gates/gate-full.mjs +85 -0
- package/scripts/lib/gates/gate-helpers.mjs +231 -0
- package/scripts/lib/gates/gate-incremental.mjs +76 -0
- package/scripts/lib/gates/gate-per-file.mjs +55 -0
- package/scripts/lib/gitlab-ops/stale-mr-sweep.mjs +447 -0
- package/scripts/lib/gitlab-portfolio/aggregator.mjs +383 -0
- package/scripts/lib/gitlab-portfolio/cli.mjs +428 -0
- package/scripts/lib/gitlab-portfolio/markdown-writer.mjs +289 -0
- package/scripts/lib/gitlab-portfolio/vcs-detect.mjs +182 -0
- package/scripts/lib/handover-gate.mjs +222 -0
- package/scripts/lib/hardening.mjs +43 -0
- package/scripts/lib/hardware-pattern-detector.mjs +238 -0
- package/scripts/lib/harness-audit/categories/category1.mjs +123 -0
- package/scripts/lib/harness-audit/categories/category2.mjs +145 -0
- package/scripts/lib/harness-audit/categories/category3.mjs +143 -0
- package/scripts/lib/harness-audit/categories/category4.mjs +202 -0
- package/scripts/lib/harness-audit/categories/category5.mjs +152 -0
- package/scripts/lib/harness-audit/categories/category6.mjs +211 -0
- package/scripts/lib/harness-audit/categories/category7.mjs +125 -0
- package/scripts/lib/harness-audit/categories/category8.mjs +328 -0
- package/scripts/lib/harness-audit/categories/category9.mjs +294 -0
- package/scripts/lib/harness-audit/categories/helpers.mjs +165 -0
- package/scripts/lib/harness-audit/categories.mjs +19 -0
- package/scripts/lib/historical-guard.mjs +15 -0
- package/scripts/lib/host-identity.mjs +262 -0
- package/scripts/lib/instruction-budget-guard.mjs +332 -0
- package/scripts/lib/io.mjs +304 -0
- package/scripts/lib/issue-close-strip-labels.mjs +161 -0
- package/scripts/lib/language-mappers/README.md +57 -0
- package/scripts/lib/language-mappers/index.mjs +165 -0
- package/scripts/lib/language-mappers/markdown.mjs +149 -0
- package/scripts/lib/language-mappers/python.mjs +249 -0
- package/scripts/lib/language-mappers/swift.mjs +201 -0
- package/scripts/lib/language-mappers/typescript.mjs +433 -0
- package/scripts/lib/learnings/expiry-sweep.mjs +164 -0
- package/scripts/lib/learnings/filters.mjs +43 -0
- package/scripts/lib/learnings/io.mjs +255 -0
- package/scripts/lib/learnings/schema.mjs +518 -0
- package/scripts/lib/learnings/surface.mjs +207 -0
- package/scripts/lib/learnings.mjs +42 -0
- package/scripts/lib/lock-reaper.mjs +648 -0
- package/scripts/lib/locks/index.mjs +31 -0
- package/scripts/lib/locks/lock-body.mjs +62 -0
- package/scripts/lib/locks/staging-fence-lock.mjs +267 -0
- package/scripts/lib/locks/state-md-lock.mjs +351 -0
- package/scripts/lib/loop-readiness-banner.mjs +144 -0
- package/scripts/lib/memory-banner.mjs +478 -0
- package/scripts/lib/memory-cleanup/worktree-sweep.mjs +108 -0
- package/scripts/lib/memory-cleanup-stamp.mjs +56 -0
- package/scripts/lib/memory-paths.mjs +31 -0
- package/scripts/lib/memory-proposals/collector.mjs +334 -0
- package/scripts/lib/memory-proposals/schema.mjs +289 -0
- package/scripts/lib/memory-proposals/sink.mjs +507 -0
- package/scripts/lib/memory-proposals/store.mjs +441 -0
- package/scripts/lib/mission-status-schema.mjs +114 -0
- package/scripts/lib/mode-selector/alternatives.mjs +64 -0
- package/scripts/lib/mode-selector/constants.mjs +29 -0
- package/scripts/lib/mode-selector/context-pressure.mjs +157 -0
- package/scripts/lib/mode-selector/rationale.mjs +55 -0
- package/scripts/lib/mode-selector/scoring.mjs +221 -0
- package/scripts/lib/mode-selector-accuracy.mjs +121 -0
- package/scripts/lib/mode-selector.mjs +160 -0
- package/scripts/lib/multi-provider-build/providers.mjs +64 -0
- package/scripts/lib/multi-provider-build/templating.mjs +130 -0
- package/scripts/lib/named-baseline-resolver.mjs +233 -0
- package/scripts/lib/named-vault-resolver.mjs +433 -0
- package/scripts/lib/owner-config/coerce.mjs +29 -0
- package/scripts/lib/owner-config/constants.mjs +21 -0
- package/scripts/lib/owner-config/defaults.mjs +50 -0
- package/scripts/lib/owner-config/error.mjs +19 -0
- package/scripts/lib/owner-config/index.mjs +13 -0
- package/scripts/lib/owner-config/merge.mjs +52 -0
- package/scripts/lib/owner-config/validate.mjs +259 -0
- package/scripts/lib/owner-config-banner.mjs +126 -0
- package/scripts/lib/owner-config-loader.mjs +159 -0
- package/scripts/lib/owner-config.example.yaml +72 -0
- package/scripts/lib/owner-config.mjs +28 -0
- package/scripts/lib/owner-interview.mjs +243 -0
- package/scripts/lib/owner-yaml.mjs +571 -0
- package/scripts/lib/package-manager.mjs +160 -0
- package/scripts/lib/path-utils.mjs +217 -0
- package/scripts/lib/peer-cards/merger.mjs +310 -0
- package/scripts/lib/peer-cards/reader.mjs +125 -0
- package/scripts/lib/peer-cards/schema.mjs +230 -0
- package/scripts/lib/peer-cards/staleness-banner.mjs +86 -0
- package/scripts/lib/peer-cards/writer.mjs +138 -0
- package/scripts/lib/peer-discovery.mjs +200 -0
- package/scripts/lib/persona-panel/catalog-loader.mjs +577 -0
- package/scripts/lib/persona-panel/consolidator.mjs +370 -0
- package/scripts/lib/persona-panel/persona-runner.mjs +375 -0
- package/scripts/lib/persona-panel/threshold.mjs +130 -0
- package/scripts/lib/pi-hook-bridge.mjs +328 -0
- package/scripts/lib/platform.mjs +266 -0
- package/scripts/lib/playwright-driver/runner.mjs +297 -0
- package/scripts/lib/plugin-root.mjs +210 -0
- package/scripts/lib/pre-dispatch-check.mjs +126 -0
- package/scripts/lib/product-repo-detect.mjs +121 -0
- package/scripts/lib/profiles/registry.mjs +176 -0
- package/scripts/lib/profiles/schema.mjs +209 -0
- package/scripts/lib/qg-command-drift-banner.mjs +88 -0
- package/scripts/lib/quality-gate/diagnostics.mjs +92 -0
- package/scripts/lib/quality-gate.mjs +536 -0
- package/scripts/lib/quality-gates-cache.mjs +228 -0
- package/scripts/lib/quality-gates-policy.mjs +95 -0
- package/scripts/lib/recommendations-v0.mjs +156 -0
- package/scripts/lib/reconcile/eligibility.mjs +203 -0
- package/scripts/lib/reconcile/emitter.mjs +244 -0
- package/scripts/lib/reconcile/engine.mjs +412 -0
- package/scripts/lib/reconcile/idempotency.mjs +239 -0
- package/scripts/lib/reconcile/renderer.mjs +211 -0
- package/scripts/lib/reconcile/writer.mjs +293 -0
- package/scripts/lib/reconcile-nudge-banner.mjs +284 -0
- package/scripts/lib/resource-probe/evaluate.mjs +190 -0
- package/scripts/lib/resource-probe/parsers.mjs +181 -0
- package/scripts/lib/resource-probe/probe-platform.mjs +300 -0
- package/scripts/lib/resource-probe.mjs +95 -0
- package/scripts/lib/rule-loader.mjs +552 -0
- package/scripts/lib/rules-sync.mjs +439 -0
- package/scripts/lib/scope-gate.mjs +496 -0
- package/scripts/lib/session-close-backfill.mjs +539 -0
- package/scripts/lib/session-discovery.mjs +256 -0
- package/scripts/lib/session-end/phase-skip.mjs +357 -0
- package/scripts/lib/session-end/worktree-cleanup.mjs +112 -0
- package/scripts/lib/session-id.mjs +362 -0
- package/scripts/lib/session-lock.mjs +703 -0
- package/scripts/lib/session-registry.mjs +355 -0
- package/scripts/lib/session-schema/aliases.mjs +71 -0
- package/scripts/lib/session-schema/constants.mjs +115 -0
- package/scripts/lib/session-schema/normalizer.mjs +66 -0
- package/scripts/lib/session-schema/timestamps.mjs +64 -0
- package/scripts/lib/session-schema/validator.mjs +453 -0
- package/scripts/lib/session-schema.mjs +71 -0
- package/scripts/lib/session-token-rollup.mjs +137 -0
- package/scripts/lib/sessions-staleness-banner.mjs +247 -0
- package/scripts/lib/skill-evolution/blast-radius-classifier.mjs +114 -0
- package/scripts/lib/skill-evolution/candidate-intake.mjs +270 -0
- package/scripts/lib/skill-evolution/config-validation-gate.mjs +279 -0
- package/scripts/lib/skill-evolution/engine.mjs +719 -0
- package/scripts/lib/skill-evolution/idempotency.mjs +279 -0
- package/scripts/lib/skill-evolution/mr-opener.mjs +507 -0
- package/scripts/lib/skill-health/join.mjs +181 -0
- package/scripts/lib/skill-health/score.mjs +123 -0
- package/scripts/lib/skill-invocations-schema.mjs +214 -0
- package/scripts/lib/skill-judge.mjs +348 -0
- package/scripts/lib/skill-judgments-schema.mjs +264 -0
- package/scripts/lib/slopcheck.mjs +501 -0
- package/scripts/lib/soul-resolve.mjs +118 -0
- package/scripts/lib/spiral-carryover.mjs +495 -0
- package/scripts/lib/state-md/body-sections.mjs +851 -0
- package/scripts/lib/state-md/frontmatter-mutators.mjs +453 -0
- package/scripts/lib/state-md/mission-status.mjs +247 -0
- package/scripts/lib/state-md/recommendations.mjs +57 -0
- package/scripts/lib/state-md/yaml-parser.mjs +234 -0
- package/scripts/lib/state-md-peer-guard.mjs +232 -0
- package/scripts/lib/state-md.mjs +53 -0
- package/scripts/lib/subagents-schema.mjs +309 -0
- package/scripts/lib/sunset/walker.mjs +1192 -0
- package/scripts/lib/test-runner/artifact-paths.mjs +94 -0
- package/scripts/lib/test-runner/fingerprint.mjs +33 -0
- package/scripts/lib/test-runner/issue-reconcile.mjs +770 -0
- package/scripts/lib/tmux-layout/layouts.mjs +224 -0
- package/scripts/lib/tmux-layout/telemetry-stats.mjs +100 -0
- package/scripts/lib/tmux-layout/telemetry.mjs +88 -0
- package/scripts/lib/tmux-layout/tmux-shell.mjs +82 -0
- package/scripts/lib/tmux-layout/vcs-detector.mjs +88 -0
- package/scripts/lib/validate/check-agents.mjs +457 -0
- package/scripts/lib/validate/check-codex-plugin.mjs +37 -0
- package/scripts/lib/validate/check-commands.mjs +148 -0
- package/scripts/lib/validate/check-component-paths.mjs +112 -0
- package/scripts/lib/validate/check-dead-bridge.mjs +180 -0
- package/scripts/lib/validate/check-hooks-symmetry.mjs +258 -0
- package/scripts/lib/validate/check-json-files.mjs +116 -0
- package/scripts/lib/validate/check-owner-leakage.mjs +1011 -0
- package/scripts/lib/validate/check-path-utils-canary.mjs +175 -0
- package/scripts/lib/validate/check-peekaboo-driver-canary.mjs +201 -0
- package/scripts/lib/validate/check-pi-package.mjs +110 -0
- package/scripts/lib/validate/check-pi-prompts.mjs +43 -0
- package/scripts/lib/validate/check-playwright-mcp-canary.mjs +154 -0
- package/scripts/lib/validate/check-plugin-json.mjs +96 -0
- package/scripts/lib/validate/check-plugin-monitors.mjs +206 -0
- package/scripts/lib/validate/check-plugin-schema.mjs +137 -0
- package/scripts/lib/validate/check-rules.mjs +143 -0
- package/scripts/lib/validate/check-session-plan-routing.mjs +154 -0
- package/scripts/lib/validate/check-test-fixture-shapes.mjs +280 -0
- package/scripts/lib/validate/check-unicode-safety.mjs +533 -0
- package/scripts/lib/validate/confidential-names.mjs +169 -0
- package/scripts/lib/validate/dead-bridge-corpus.mjs +141 -0
- package/scripts/lib/validate/dead-bridge-detectors.mjs +568 -0
- package/scripts/lib/validate/tier-inference.mjs +100 -0
- package/scripts/lib/validate-vendored-rules.mjs +519 -0
- package/scripts/lib/vault-archive.mjs +404 -0
- package/scripts/lib/vault-backfill/glab.mjs +164 -0
- package/scripts/lib/vault-backfill/manifest.mjs +75 -0
- package/scripts/lib/vault-backfill/template.mjs +130 -0
- package/scripts/lib/vault-consolidate-fs.mjs +331 -0
- package/scripts/lib/vault-migration-rules.mjs +155 -0
- package/scripts/lib/vault-mirror/auto-commit.mjs +203 -0
- package/scripts/lib/vault-mirror/namespace.mjs +152 -0
- package/scripts/lib/vault-mirror/process.mjs +567 -0
- package/scripts/lib/vault-mirror/pseudonym-map.mjs +164 -0
- package/scripts/lib/vault-mirror/render-learnings.mjs +201 -0
- package/scripts/lib/vault-mirror/render-sessions.mjs +367 -0
- package/scripts/lib/vault-mirror/render.mjs +8 -0
- package/scripts/lib/vault-mirror/utils.mjs +217 -0
- package/scripts/lib/vault-relocation-rules.mjs +555 -0
- package/scripts/lib/vault-repo-backfill.mjs +235 -0
- package/scripts/lib/vault-staleness-banner.mjs +142 -0
- package/scripts/lib/vault-status/board-writer.mjs +769 -0
- package/scripts/lib/vault-status/narrative-mirror.mjs +544 -0
- package/scripts/lib/vault-sync-baseline.mjs +152 -0
- package/scripts/lib/wave-context.mjs +29 -0
- package/scripts/lib/wave-executor/pool.mjs +248 -0
- package/scripts/lib/wave-resource-gate.mjs +204 -0
- package/scripts/lib/wave-sizing.mjs +75 -0
- package/scripts/lib/webhook-url.mjs +105 -0
- package/scripts/lib/workspace.mjs +198 -0
- package/scripts/lib/worktree/constants.mjs +35 -0
- package/scripts/lib/worktree/index.mjs +17 -0
- package/scripts/lib/worktree/lifecycle.mjs +287 -0
- package/scripts/lib/worktree/listing.mjs +118 -0
- package/scripts/lib/worktree/meta.mjs +64 -0
- package/scripts/lib/worktree-freshness.mjs +313 -0
- package/scripts/lib/worktree.mjs +15 -0
- package/scripts/lifecycle-sim-v6.mjs +347 -0
- package/scripts/lock-reaper.mjs +185 -0
- package/scripts/mcp-server.sh +241 -0
- package/scripts/measure-policy-cache-effectiveness.mjs +427 -0
- package/scripts/memory-propose.mjs +464 -0
- package/scripts/migrate-cold-start-seed.mjs +404 -0
- package/scripts/migrate-learnings-jsonl.mjs +189 -0
- package/scripts/migrate-legacy-learnings.sh +61 -0
- package/scripts/migrate-sessions-jsonl.mjs +448 -0
- package/scripts/migrate-subagents-jsonl.mjs +196 -0
- package/scripts/migrate-vault-paths.mjs +796 -0
- package/scripts/parse-config.mjs +149 -0
- package/scripts/pi-install.mjs +117 -0
- package/scripts/print-applicable-rules.mjs +247 -0
- package/scripts/promote-vault-strict.mjs +496 -0
- package/scripts/relocate-vault-corpus.mjs +1178 -0
- package/scripts/run-migrate-v2-cross-repo.mjs +385 -0
- package/scripts/run-quality-gate.mjs +216 -0
- package/scripts/spikes/h3-agent-teams/preflight.sh +53 -0
- package/scripts/spikes/h3-agent-teams/run-h3.sh +112 -0
- package/scripts/spikes/h3-agent-teams/setup.sh +137 -0
- package/scripts/spikes/h3-agent-teams/toggle.sh +38 -0
- package/scripts/sweep-expired-learnings.mjs +135 -0
- package/scripts/sync-vault-schema.mjs +376 -0
- package/scripts/tests/fixtures/fetch-baseline/sample-rule.md +8 -0
- package/scripts/tmux-layout.mjs +245 -0
- package/scripts/token-audit.sh +191 -0
- package/scripts/typecheck.mjs +42 -0
- package/scripts/upload-social-preview.mjs +316 -0
- package/scripts/validate-config.mjs +46 -0
- package/scripts/validate-plugin-manifests.mjs +163 -0
- package/scripts/validate-plugin.mjs +264 -0
- package/scripts/validate-wave-scope.mjs +289 -0
- package/scripts/vault-backfill.mjs +404 -0
- package/scripts/vault-consolidate.mjs +596 -0
- package/scripts/vault-integration-watcher.mjs +394 -0
- package/scripts/vault-mirror.mjs +430 -0
- package/skills/_shared/bootstrap-gate.md +111 -0
- package/skills/_shared/config-reading.md +226 -0
- package/skills/_shared/instruction-file-resolution.md +79 -0
- package/skills/_shared/model-selection.md +64 -0
- package/skills/_shared/monitor-patterns.md +300 -0
- package/skills/_shared/parallel-aware-auq.md +121 -0
- package/skills/_shared/parallel-aware-preamble.md +185 -0
- package/skills/_shared/platform-tools.md +96 -0
- package/skills/_shared/state-ownership.md +221 -0
- package/skills/architecture/DEEPENING.md +37 -0
- package/skills/architecture/INTERFACE-DESIGN.md +44 -0
- package/skills/architecture/LANGUAGE.md +53 -0
- package/skills/architecture/SKILL.md +92 -0
- package/skills/autopilot/SKILL.md +419 -0
- package/skills/bootstrap/SKILL.md +592 -0
- package/skills/bootstrap/STATE.md.template +24 -0
- package/skills/bootstrap/_shared-template.md +243 -0
- package/skills/bootstrap/deep-template.md +659 -0
- package/skills/bootstrap/fast-template.md +251 -0
- package/skills/bootstrap/intensity-heuristic.md +80 -0
- package/skills/bootstrap/public-fallback.md +342 -0
- package/skills/bootstrap/standard-template.md +736 -0
- package/skills/bootstrap/templates/agents/project-code-review.md +18 -0
- package/skills/bootstrap/templates/agents/project-discovery.md +18 -0
- package/skills/bootstrap/templates/agents/project-quality-gate.md +18 -0
- package/skills/brainstorm/SKILL.md +268 -0
- package/skills/brainstorm/soul.md +49 -0
- package/skills/claude-md-drift-check/SKILL.md +186 -0
- package/skills/claude-md-drift-check/checker.mjs +1380 -0
- package/skills/claude-md-drift-check/checker.sh +37 -0
- package/skills/claude-md-drift-check/package.json +16 -0
- package/skills/convergence-monitoring/README.md +39 -0
- package/skills/convergence-monitoring/SIGNALS.md +246 -0
- package/skills/convergence-monitoring/SKILL.md +285 -0
- package/skills/daily/SKILL.md +222 -0
- package/skills/daily/generate.sh +92 -0
- package/skills/daily/templates/daily.md.tpl +36 -0
- package/skills/debug/SKILL.md +188 -0
- package/skills/debug/soul.md +35 -0
- package/skills/discovery/SKILL.md +567 -0
- package/skills/discovery/issue-templates.md +237 -0
- package/skills/discovery/probes/docs-staleness.mjs +195 -0
- package/skills/discovery/probes/frontend-slop.mjs +186 -0
- package/skills/discovery/probes/ssot-code-diff.mjs +310 -0
- package/skills/discovery/probes/supply-chain-slopcheck.mjs +440 -0
- package/skills/discovery/probes/vault-narrative-staleness.mjs +355 -0
- package/skills/discovery/probes/vault-staleness.mjs +272 -0
- package/skills/discovery/probes-arch.md +252 -0
- package/skills/discovery/probes-audit.md +95 -0
- package/skills/discovery/probes-code.md +329 -0
- package/skills/discovery/probes-docs.md +76 -0
- package/skills/discovery/probes-feature.md +150 -0
- package/skills/discovery/probes-infra.md +138 -0
- package/skills/discovery/probes-intro.md +25 -0
- package/skills/discovery/probes-session.md +495 -0
- package/skills/discovery/probes-supply-chain.md +94 -0
- package/skills/discovery/probes-ui.md +147 -0
- package/skills/discovery/probes-vault.md +64 -0
- package/skills/discovery/slop-patterns.md +115 -0
- package/skills/dispatcher/SKILL.md +173 -0
- package/skills/docs-orchestrator/SKILL.md +362 -0
- package/skills/docs-orchestrator/audience-mapping.md +140 -0
- package/skills/domain-model/ADR-FORMAT.md +47 -0
- package/skills/domain-model/CONTEXT-FORMAT.md +77 -0
- package/skills/domain-model/SKILL.md +85 -0
- package/skills/ecosystem-health/SKILL.md +119 -0
- package/skills/ecosystem-health/wizard.md +193 -0
- package/skills/eval/SKILL.md +293 -0
- package/skills/eval/rubric-v1.md +218 -0
- package/skills/evolve/SKILL.md +546 -0
- package/skills/frontmatter-guard/SKILL.md +126 -0
- package/skills/gitlab-ops/SKILL.md +368 -0
- package/skills/gitlab-portfolio/SKILL.md +196 -0
- package/skills/grill/SKILL.md +185 -0
- package/skills/grill/soul.md +55 -0
- package/skills/hook-development/SKILL.md +413 -0
- package/skills/mcp-builder/SKILL.md +260 -0
- package/skills/memory-cleanup/SKILL.md +310 -0
- package/skills/mode-selector/SKILL.md +226 -0
- package/skills/peekaboo-driver/SKILL.md +237 -0
- package/skills/peekaboo-driver/soul.md +32 -0
- package/skills/persona-panel/SKILL.md +365 -0
- package/skills/persona-panel/persona-format.md +205 -0
- package/skills/persona-panel/presets/designer-lens.md +87 -0
- package/skills/persona-panel/presets/engineer-lens.md +88 -0
- package/skills/persona-panel/presets/pm-lens.md +86 -0
- package/skills/plan/SKILL.md +496 -0
- package/skills/plan/mode-feature.md +141 -0
- package/skills/plan/mode-new.md +297 -0
- package/skills/plan/mode-retro.md +271 -0
- package/skills/plan/prd-feature-template.md +132 -0
- package/skills/plan/prd-full-template.md +151 -0
- package/skills/plan/prd-reviewer-prompt.md +103 -0
- package/skills/plan/retro-template.md +75 -0
- package/skills/plan/soul.md +62 -0
- package/skills/playwright-driver/SKILL.md +226 -0
- package/skills/playwright-driver/soul.md +30 -0
- package/skills/quality-gates/SKILL.md +212 -0
- package/skills/reconcile/SKILL.md +324 -0
- package/skills/repo-audit/SKILL.md +272 -0
- package/skills/session-end/SKILL.md +1044 -0
- package/skills/session-end/discovery-scan.md +37 -0
- package/skills/session-end/drift-operations.md +97 -0
- package/skills/session-end/learning-patterns.md +78 -0
- package/skills/session-end/metrics-collection.md +175 -0
- package/skills/session-end/phase-3-2-docs-verification.md +148 -0
- package/skills/session-end/phase-3-6-tail.md +344 -0
- package/skills/session-end/phase-3-7a-recommendations.md +86 -0
- package/skills/session-end/plan-verification.md +288 -0
- package/skills/session-end/session-metrics-write.md +223 -0
- package/skills/session-end/vault-operations.md +50 -0
- package/skills/session-end/verification-checklist.md +20 -0
- package/skills/session-plan/SKILL.md +554 -0
- package/skills/session-plan/wave-template.md +37 -0
- package/skills/session-start/SKILL.md +1043 -0
- package/skills/session-start/phase-2-5-docs-planning.md +119 -0
- package/skills/session-start/phase-4-5-resource-health.md +49 -0
- package/skills/session-start/phase-7-1-premise-check.md +47 -0
- package/skills/session-start/phase-7-5-mode-selector.md +237 -0
- package/skills/session-start/phase-8-5-express-path.md +61 -0
- package/skills/session-start/presentation-format.md +81 -0
- package/skills/session-start/soul.md +57 -0
- package/skills/skill-creator/SKILL.md +168 -0
- package/skills/spinout/SKILL.md +76 -0
- package/skills/sunset-review/SKILL.md +96 -0
- package/skills/test-runner/SKILL.md +362 -0
- package/skills/test-runner/rubric-v1.md +388 -0
- package/skills/test-runner/soul.md +46 -0
- package/skills/tmux-layout/SKILL.md +104 -0
- package/skills/ubiquitous-language/SKILL.md +97 -0
- package/skills/using-orchestrator/SKILL.md +144 -0
- package/skills/vault-mirror/SKILL.md +234 -0
- package/skills/vault-sync/SKILL.md +319 -0
- package/skills/vault-sync/package-lock.json +40 -0
- package/skills/vault-sync/package.json +11 -0
- package/skills/vault-sync/tests/fixtures/archive-test-vault/90-archive/bad-archived.md +8 -0
- package/skills/vault-sync/tests/fixtures/archive-test-vault/_meta/.gitkeep +0 -0
- package/skills/vault-sync/tests/fixtures/archive-test-vault/live-note.md +8 -0
- package/skills/vault-sync/tests/fixtures/broken-frontmatter-vault/_meta/.gitkeep +0 -0
- package/skills/vault-sync/tests/fixtures/broken-frontmatter-vault/bad-type.md +8 -0
- package/skills/vault-sync/tests/fixtures/broken-frontmatter-vault/good-note.md +8 -0
- package/skills/vault-sync/tests/fixtures/clean-vault/.obsidian/config.md +8 -0
- package/skills/vault-sync/tests/fixtures/clean-vault/01-projects/foo/projects-baseline.md +10 -0
- package/skills/vault-sync/tests/fixtures/clean-vault/03-daily/daily-2026-04-13.md +8 -0
- package/skills/vault-sync/tests/fixtures/clean-vault/README.md +3 -0
- package/skills/vault-sync/tests/fixtures/clean-vault/hello-world.md +11 -0
- package/skills/vault-sync/tests/fixtures/dangling-link-vault/_meta/.gitkeep +0 -0
- package/skills/vault-sync/tests/fixtures/dangling-link-vault/has-dangling.md +9 -0
- package/skills/vault-sync/tests/fixtures/dangling-link-vault/real-target.md +8 -0
- package/skills/vault-sync/tests/fixtures/empty-vault/_meta/.gitkeep +0 -0
- package/skills/vault-sync/tests/fixtures/missing-field-vault/_meta/.gitkeep +0 -0
- package/skills/vault-sync/tests/fixtures/missing-field-vault/missing-id.md +7 -0
- package/skills/vault-sync/tests/fixtures/nested-tag-vault/03-daily/daily-2026-04-13.md +9 -0
- package/skills/vault-sync/tests/fixtures/nested-tag-vault/_meta/.gitkeep +0 -0
- package/skills/vault-sync/tests/fixtures/nested-tag-vault/nested-tags-note.md +11 -0
- package/skills/vault-sync/tests/fixtures/no-frontmatter-vault/README.md +3 -0
- package/skills/vault-sync/tests/fixtures/no-frontmatter-vault/_MOC.md +3 -0
- package/skills/vault-sync/tests/fixtures/no-frontmatter-vault/_meta/.gitkeep +0 -0
- package/skills/vault-sync/tests/fixtures/with-moc-vault/_MOC.md +11 -0
- package/skills/vault-sync/tests/fixtures/with-moc-vault/_meta/.gitkeep +0 -0
- package/skills/vault-sync/tests/fixtures/with-moc-vault/hello-world.md +11 -0
- package/skills/vault-sync/tests/schema-drift.test.mjs +133 -0
- package/skills/vault-sync/validator.mjs +658 -0
- package/skills/vault-sync/validator.sh +55 -0
- package/skills/wave-executor/SKILL.md +496 -0
- package/skills/wave-executor/circuit-breaker.md +169 -0
- package/skills/wave-executor/wave-loop.md +1043 -0
- package/skills/write-executable-plan/SKILL.md +237 -0
- package/skills/write-executable-plan/plan-template.md +154 -0
- package/templates/_minimal/CLAUDE.md.tmpl +41 -0
- package/templates/_minimal/README.md.tmpl +15 -0
- package/templates/_minimal/gitignore.tmpl +47 -0
- package/templates/_shared/harte-regeln.md +16 -0
- package/templates/_shared/loop.md +90 -0
- package/templates/_shared/rules/parallel-sessions.md +77 -0
- package/templates/nextjs-minimal/README.md +30 -0
- package/templates/nextjs-minimal/app/layout.tsx +18 -0
- package/templates/nextjs-minimal/app/page.tsx +7 -0
- package/templates/nextjs-minimal/eslint.config.mjs +16 -0
- package/templates/nextjs-minimal/next.config.mjs +4 -0
- package/templates/nextjs-minimal/package.json +27 -0
- package/templates/nextjs-minimal/tsconfig.json +23 -0
- package/templates/node-minimal/README.md +33 -0
- package/templates/node-minimal/eslint.config.mjs +10 -0
- package/templates/node-minimal/package.json +21 -0
- package/templates/node-minimal/src/index.ts +1 -0
- package/templates/node-minimal/tests/sanity.test.ts +5 -0
- package/templates/node-minimal/tsconfig.json +17 -0
- package/templates/personas/README.md +150 -0
- package/templates/personas/accounting-compliance.v1.md +120 -0
- package/templates/personas/accounting-tax-advisor.v1.md +116 -0
- package/templates/personas/buyer-p1-cto.v1.md +125 -0
- package/templates/personas/buyer-p2-kanzlei.v1.md +134 -0
- package/templates/personas/buyer-p3-build.v1.md +130 -0
- package/templates/personas/buyer-p4-tech-veto.v1.md +130 -0
- package/templates/personas/buyer-p5-solo.v1.md +132 -0
- package/templates/personas/buyer-p6-ld.v1.md +130 -0
- package/templates/personas/klima-ai-expert.v1.md +114 -0
- package/templates/personas/klima-physicist.v1.md +117 -0
- package/templates/python-uv/README.md +28 -0
- package/templates/python-uv/pyproject.toml +32 -0
- package/templates/python-uv/src/__PROJECT_NAME__/__init__.py +0 -0
- package/templates/python-uv/src/__PROJECT_NAME__/main.py +6 -0
- package/templates/python-uv/tests/test_sanity.py +2 -0
- package/templates/static-html/README.md +19 -0
- package/templates/static-html/index.html +15 -0
- package/templates/static-html/script.js +1 -0
- package/templates/static-html/styles.css +26 -0
|
@@ -0,0 +1,413 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: hook-development
|
|
3
|
+
description: Use when creating, modifying, or debugging Claude Code hooks — PreToolUse, PostToolUse, Stop, SubagentStop, SessionStart, SessionEnd, UserPromptSubmit, PreCompact, Notification. Covers the plugin `hooks/hooks.json` wrapper format vs. the user `settings.json` direct format, matchers, security patterns, `$CLAUDE_PLUGIN_ROOT` portability, lifecycle limitations, and debugging. Trigger on "add a hook", "validate tool use", "block dangerous commands", "enforce completion", "hook-based automation".
|
|
4
|
+
model: sonnet
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Hook Development for Claude Code Plugins
|
|
8
|
+
|
|
9
|
+
Adapted from [claude-plugins-official/plugin-dev/skills/hook-development](https://github.com/anthropics/claude-plugins-official/tree/main/plugins/plugin-dev/skills/hook-development). Trimmed to what we actually author (our plugin already has 6 event matchers covering 7 hook handlers — see `hooks/hooks.json`).
|
|
10
|
+
|
|
11
|
+
## Hook types
|
|
12
|
+
|
|
13
|
+
### Prompt-based (LLM-driven, for complex reasoning)
|
|
14
|
+
|
|
15
|
+
```json
|
|
16
|
+
{
|
|
17
|
+
"type": "prompt",
|
|
18
|
+
"prompt": "Evaluate if this tool use is appropriate: $TOOL_INPUT",
|
|
19
|
+
"timeout": 30
|
|
20
|
+
}
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Supported events: `Stop`, `SubagentStop`, `UserPromptSubmit`, `PreToolUse`.
|
|
24
|
+
|
|
25
|
+
Use for: context-aware decisions, flexible evaluation, natural-language reasoning.
|
|
26
|
+
|
|
27
|
+
### Command (deterministic, for fast checks)
|
|
28
|
+
|
|
29
|
+
```json
|
|
30
|
+
{
|
|
31
|
+
"type": "command",
|
|
32
|
+
"command": "${CLAUDE_PLUGIN_ROOT}/hooks/validate.mjs",
|
|
33
|
+
"timeout": 60
|
|
34
|
+
}
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Use for: fast deterministic validations, file-system ops, external tools, performance-critical paths.
|
|
38
|
+
|
|
39
|
+
**Our convention:** all our command hooks are `.mjs` (Node.js) — see `hooks/pre-bash-destructive-guard.mjs`, `hooks/enforce-scope.mjs`. The v3.0 migration moved us off bash for native Windows support.
|
|
40
|
+
|
|
41
|
+
## Configuration formats
|
|
42
|
+
|
|
43
|
+
This is where people trip up. Two formats exist; they are NOT interchangeable.
|
|
44
|
+
|
|
45
|
+
### Plugin `hooks/hooks.json` — wrapper format
|
|
46
|
+
|
|
47
|
+
```json
|
|
48
|
+
{
|
|
49
|
+
"description": "Plugin hook description (optional)",
|
|
50
|
+
"hooks": {
|
|
51
|
+
"PreToolUse": [
|
|
52
|
+
{
|
|
53
|
+
"matcher": "Write|Edit",
|
|
54
|
+
"hooks": [
|
|
55
|
+
{ "type": "command", "command": "${CLAUDE_PLUGIN_ROOT}/hooks/validate.mjs" }
|
|
56
|
+
]
|
|
57
|
+
}
|
|
58
|
+
]
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
- `hooks` wrapper is required
|
|
64
|
+
- `description` is optional
|
|
65
|
+
|
|
66
|
+
### User `.claude/settings.json` — direct format
|
|
67
|
+
|
|
68
|
+
```json
|
|
69
|
+
{
|
|
70
|
+
"PreToolUse": [
|
|
71
|
+
{
|
|
72
|
+
"matcher": "Write|Edit",
|
|
73
|
+
"hooks": [
|
|
74
|
+
{ "type": "command", "command": "~/my-hook.sh" }
|
|
75
|
+
]
|
|
76
|
+
}
|
|
77
|
+
]
|
|
78
|
+
}
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
- No wrapper
|
|
82
|
+
- No description
|
|
83
|
+
|
|
84
|
+
Mixing these up is the #1 reason new hooks don't fire.
|
|
85
|
+
|
|
86
|
+
## Hook events
|
|
87
|
+
|
|
88
|
+
| Event | When | Use for |
|
|
89
|
+
|-------|------|---------|
|
|
90
|
+
| `PreToolUse` | Before tool runs | Validate, modify, block |
|
|
91
|
+
| `PostToolUse` | After tool completes | React to result, log |
|
|
92
|
+
| `UserPromptSubmit` | User submits prompt | Add context, validate |
|
|
93
|
+
| `Stop` | Main agent stopping | Completeness check |
|
|
94
|
+
| `SubagentStop` | Subagent stopping | Task validation |
|
|
95
|
+
| `SessionStart` | Session begins | Context load |
|
|
96
|
+
| `SessionEnd` | Session ends | Cleanup, logging |
|
|
97
|
+
| `PreCompact` | Before compaction | Preserve critical state |
|
|
98
|
+
| `Notification` | User notified | Logging, reactions |
|
|
99
|
+
|
|
100
|
+
### PreToolUse output schema
|
|
101
|
+
|
|
102
|
+
```json
|
|
103
|
+
{
|
|
104
|
+
"hookSpecificOutput": {
|
|
105
|
+
"permissionDecision": "allow|deny|ask",
|
|
106
|
+
"updatedInput": { "field": "modified_value" }
|
|
107
|
+
},
|
|
108
|
+
"systemMessage": "Explanation shown to Claude"
|
|
109
|
+
}
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### Stop / SubagentStop output
|
|
113
|
+
|
|
114
|
+
```json
|
|
115
|
+
{
|
|
116
|
+
"decision": "approve|block",
|
|
117
|
+
"reason": "Why blocked / approved",
|
|
118
|
+
"systemMessage": "Additional context"
|
|
119
|
+
}
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### SessionStart: persist env vars
|
|
123
|
+
|
|
124
|
+
```bash
|
|
125
|
+
echo "export PROJECT_TYPE=nodejs" >> "$CLAUDE_ENV_FILE"
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
`$CLAUDE_ENV_FILE` is unique to SessionStart hooks.
|
|
129
|
+
|
|
130
|
+
## Input schema
|
|
131
|
+
|
|
132
|
+
All hooks receive JSON on stdin:
|
|
133
|
+
|
|
134
|
+
```json
|
|
135
|
+
{
|
|
136
|
+
"session_id": "abc123",
|
|
137
|
+
"transcript_path": "/path/to/transcript.jsonl",
|
|
138
|
+
"cwd": "/current/working/dir",
|
|
139
|
+
"permission_mode": "ask|allow",
|
|
140
|
+
"hook_event_name": "PreToolUse"
|
|
141
|
+
}
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
Event-specific extras:
|
|
145
|
+
- `PreToolUse`/`PostToolUse`: `tool_name`, `tool_input`, `tool_result`
|
|
146
|
+
- `UserPromptSubmit`: `user_prompt`
|
|
147
|
+
- `Stop`/`SubagentStop`: `reason`
|
|
148
|
+
|
|
149
|
+
Access in prompt hooks via `$TOOL_INPUT`, `$TOOL_RESULT`, `$USER_PROMPT`.
|
|
150
|
+
|
|
151
|
+
## Environment variables
|
|
152
|
+
|
|
153
|
+
| Var | Scope | Purpose |
|
|
154
|
+
|-----|-------|---------|
|
|
155
|
+
| `$CLAUDE_PROJECT_DIR` | All | Project root |
|
|
156
|
+
| `$CLAUDE_PLUGIN_ROOT` | Plugin hooks | Plugin directory — **use this, never hardcode paths** |
|
|
157
|
+
| `$CLAUDE_ENV_FILE` | SessionStart only | Persist env vars |
|
|
158
|
+
| `$CLAUDE_CODE_REMOTE` | All (conditional) | Set if running remote |
|
|
159
|
+
|
|
160
|
+
### Portability rule
|
|
161
|
+
|
|
162
|
+
```json
|
|
163
|
+
// ✅ Portable — works everywhere the plugin installs
|
|
164
|
+
{ "command": "${CLAUDE_PLUGIN_ROOT}/hooks/guard.mjs" }
|
|
165
|
+
|
|
166
|
+
// ❌ Broken — only works on the operator's machine
|
|
167
|
+
{ "command": "~/Projects/.../guard.mjs" }
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
## Matchers
|
|
171
|
+
|
|
172
|
+
```json
|
|
173
|
+
"matcher": "Write" // Exact tool
|
|
174
|
+
"matcher": "Read|Write|Edit" // Multiple
|
|
175
|
+
"matcher": "*" // All tools
|
|
176
|
+
"matcher": "mcp__.*__delete.*" // Regex — all MCP delete tools
|
|
177
|
+
"matcher": "mcp__gitlab_.*" // Specific MCP server
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
Matchers are **case-sensitive**.
|
|
181
|
+
|
|
182
|
+
## Security best practices
|
|
183
|
+
|
|
184
|
+
### Validate inputs (command hooks)
|
|
185
|
+
|
|
186
|
+
```bash
|
|
187
|
+
#!/bin/bash
|
|
188
|
+
set -euo pipefail
|
|
189
|
+
|
|
190
|
+
input=$(cat)
|
|
191
|
+
tool_name=$(echo "$input" | jq -r '.tool_name')
|
|
192
|
+
|
|
193
|
+
if [[ ! "$tool_name" =~ ^[a-zA-Z0-9_]+$ ]]; then
|
|
194
|
+
echo '{"decision": "deny", "reason": "Invalid tool name"}' >&2
|
|
195
|
+
exit 2
|
|
196
|
+
fi
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
In Node/`.mjs` hooks (our convention), same principle — parse stdin JSON, validate structure before trusting.
|
|
200
|
+
|
|
201
|
+
### Path safety
|
|
202
|
+
|
|
203
|
+
```bash
|
|
204
|
+
file_path=$(echo "$input" | jq -r '.tool_input.file_path')
|
|
205
|
+
|
|
206
|
+
# Deny path traversal
|
|
207
|
+
[[ "$file_path" == *".."* ]] && { echo '{"decision":"deny","reason":"Path traversal"}' >&2; exit 2; }
|
|
208
|
+
|
|
209
|
+
# Deny sensitive files
|
|
210
|
+
[[ "$file_path" == *".env"* ]] && { echo '{"decision":"deny","reason":"Sensitive file"}' >&2; exit 2; }
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
Our `enforce-scope.mjs` implements this for wave-scope boundaries.
|
|
214
|
+
|
|
215
|
+
### Quote variables
|
|
216
|
+
|
|
217
|
+
```bash
|
|
218
|
+
echo "$file_path" # ✅
|
|
219
|
+
cd "$CLAUDE_PROJECT_DIR" # ✅
|
|
220
|
+
echo $file_path # ❌ unquoted injection risk
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
### Timeouts
|
|
224
|
+
|
|
225
|
+
Defaults: command hooks 60s, prompt hooks 30s. Set explicitly when the work is known-slow:
|
|
226
|
+
|
|
227
|
+
```json
|
|
228
|
+
{ "type": "command", "command": "...", "timeout": 10 }
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
## Parallel execution
|
|
232
|
+
|
|
233
|
+
All matching hooks run **in parallel** — they don't see each other's output, ordering is non-deterministic. Design for independence.
|
|
234
|
+
|
|
235
|
+
## Lifecycle limitation — NO hot-swap
|
|
236
|
+
|
|
237
|
+
Hooks load at session start. Changes to `hooks.json` or hook scripts do **not** affect the running session.
|
|
238
|
+
|
|
239
|
+
To test hook changes:
|
|
240
|
+
1. Edit hook
|
|
241
|
+
2. Exit Claude Code
|
|
242
|
+
3. Restart (`claude` or `cc`)
|
|
243
|
+
4. Verify with `/hooks` command or `claude --debug`
|
|
244
|
+
|
|
245
|
+
This is the #2 reason "my hook isn't working" — the change hasn't loaded yet.
|
|
246
|
+
|
|
247
|
+
## Debugging
|
|
248
|
+
|
|
249
|
+
### Debug mode
|
|
250
|
+
|
|
251
|
+
```bash
|
|
252
|
+
claude --debug
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
Surfaces hook registration, execution logs, stdin/stdout JSON, timing.
|
|
256
|
+
|
|
257
|
+
### Test a command hook directly
|
|
258
|
+
|
|
259
|
+
```bash
|
|
260
|
+
echo '{"tool_name":"Write","tool_input":{"file_path":"/test"}}' | \
|
|
261
|
+
${CLAUDE_PLUGIN_ROOT}/hooks/guard.mjs
|
|
262
|
+
echo "Exit code: $?"
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
### Validate JSON output
|
|
266
|
+
|
|
267
|
+
```bash
|
|
268
|
+
output=$(./your-hook.mjs < test-input.json)
|
|
269
|
+
echo "$output" | jq .
|
|
270
|
+
```
|
|
271
|
+
|
|
272
|
+
Invalid JSON breaks silently — always verify.
|
|
273
|
+
|
|
274
|
+
## Conditional activation
|
|
275
|
+
|
|
276
|
+
Pattern: check for a flag file or config before running:
|
|
277
|
+
|
|
278
|
+
```bash
|
|
279
|
+
#!/bin/bash
|
|
280
|
+
FLAG_FILE="$CLAUDE_PROJECT_DIR/.enable-strict-validation"
|
|
281
|
+
[[ ! -f "$FLAG_FILE" ]] && exit 0 # Flag not present, skip
|
|
282
|
+
# ... validation logic
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
Or config-based (matches our Session-Config pattern):
|
|
286
|
+
|
|
287
|
+
```bash
|
|
288
|
+
CONFIG_FILE="$CLAUDE_PROJECT_DIR/.claude/config.json"
|
|
289
|
+
enabled=$(jq -r '.strictMode // false' "$CONFIG_FILE" 2>/dev/null)
|
|
290
|
+
[[ "$enabled" != "true" ]] && exit 0
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
## Our in-house examples (read these, not the upstream `examples/`)
|
|
294
|
+
|
|
295
|
+
- `hooks/pre-bash-destructive-guard.mjs` — policy-driven command blocker, 13 rules in `.orchestrator/policy/blocked-commands.json`
|
|
296
|
+
- `hooks/enforce-scope.mjs` — wave-scope boundary enforcement using `.orchestrator/wave-scope.json`
|
|
297
|
+
- `hooks/on-session-start.mjs` — banner + session init
|
|
298
|
+
- `hooks/post-edit-validate.mjs` — validates edits after the fact
|
|
299
|
+
- `hooks/on-stop.mjs` — session-event capture + metrics
|
|
300
|
+
|
|
301
|
+
## Do / Don't
|
|
302
|
+
|
|
303
|
+
**Do:**
|
|
304
|
+
- Prompt-based hooks for complex logic, command hooks for fast deterministic checks
|
|
305
|
+
- Always `${CLAUDE_PLUGIN_ROOT}` for paths
|
|
306
|
+
- Validate every input field before trusting it
|
|
307
|
+
- Quote all shell variables
|
|
308
|
+
- Set explicit timeouts for known-slow work
|
|
309
|
+
- Return structured JSON on stdout
|
|
310
|
+
|
|
311
|
+
**Don't:**
|
|
312
|
+
- Hardcoded paths
|
|
313
|
+
- Trust `tool_input` without validation
|
|
314
|
+
- Long-running hooks (blocks the tool call)
|
|
315
|
+
- Rely on execution order (hooks run in parallel)
|
|
316
|
+
- Mutate global state
|
|
317
|
+
- Log sensitive data to stdout/stderr
|
|
318
|
+
|
|
319
|
+
## Runtime Profile Control (#211)
|
|
320
|
+
|
|
321
|
+
All hook handlers support runtime opt-out via two environment variables without any settings-file changes. This is implemented in `hooks/_lib/profile-gate.mjs`.
|
|
322
|
+
|
|
323
|
+
### Env vars
|
|
324
|
+
|
|
325
|
+
| Variable | Values | Behaviour |
|
|
326
|
+
|----------|--------|-----------|
|
|
327
|
+
| `SO_HOOK_PROFILE` | `full` \| `minimal` \| `off` | Preset bundle (default `full` = all on). |
|
|
328
|
+
| `SO_DISABLED_HOOKS` | Comma-separated names | Disable individual hooks; overrides profile. |
|
|
329
|
+
|
|
330
|
+
### Profile bundles
|
|
331
|
+
|
|
332
|
+
- **`full`** (default): all hooks run — identical to pre-#211 behaviour when env is unset.
|
|
333
|
+
- **`minimal`**: only `on-session-start` + `pre-bash-destructive-guard`.
|
|
334
|
+
- **`off`**: no hooks run.
|
|
335
|
+
|
|
336
|
+
### Wiring a new hook into the gate
|
|
337
|
+
|
|
338
|
+
Every new hook handler **must** add the gate call as the very first executable statement after imports. The pattern is two lines at the top of the file, immediately after the import block:
|
|
339
|
+
|
|
340
|
+
```js
|
|
341
|
+
import { shouldRunHook } from './_lib/profile-gate.mjs';
|
|
342
|
+
if (!shouldRunHook('your-hook-name')) process.exit(0);
|
|
343
|
+
```
|
|
344
|
+
|
|
345
|
+
Use the kebab-case file stem without the `.mjs` extension as the hook name (e.g. `my-hook` for `hooks/my-hook.mjs`). When the hook exits 0 here it is **silent** — no stdout, no stderr — so Claude Code sees a clean allow.
|
|
346
|
+
|
|
347
|
+
### Failure modes
|
|
348
|
+
|
|
349
|
+
- Unknown `SO_HOOK_PROFILE` value → falls back to `full` + single stderr warning.
|
|
350
|
+
- `SO_DISABLED_HOOKS` with extra whitespace or mixed case is normalised automatically.
|
|
351
|
+
- `defaultEnabled` param of `shouldRunHook` is for future opt-in hooks; pass `false` for any handler that should be off by default in `full` profile.
|
|
352
|
+
|
|
353
|
+
### Tests
|
|
354
|
+
|
|
355
|
+
`tests/hooks/profile-gate.test.mjs` (10 tests) covers: full/minimal/off profiles, disabled-list override, unknown-profile fallback + warning, defaultEnabled=false, whitespace normalisation, empty disabled-list.
|
|
356
|
+
|
|
357
|
+
## Robust Plugin Root Resolution (#212)
|
|
358
|
+
|
|
359
|
+
Hook handlers and scripts that need the plugin directory must NOT read
|
|
360
|
+
`process.env.CLAUDE_PLUGIN_ROOT` directly. Use `resolvePluginRoot()` from
|
|
361
|
+
`scripts/lib/plugin-root.mjs` instead, which implements a 4-level fallback
|
|
362
|
+
so manual installs (where the env var is absent) still work.
|
|
363
|
+
|
|
364
|
+
### Fallback order
|
|
365
|
+
|
|
366
|
+
| Level | Source | Condition |
|
|
367
|
+
|-------|--------|-----------|
|
|
368
|
+
| 1 | `CLAUDE_PLUGIN_ROOT` env var | Returned immediately when set and is a directory |
|
|
369
|
+
| 2 | `CODEX_PLUGIN_ROOT` env var | Returned immediately when set and is a directory |
|
|
370
|
+
| 3 | Walk up from `import.meta.url` | Looks for `package.json` with `name: "session-orchestrator"` |
|
|
371
|
+
| 4 | Walk up from `process.cwd()` | Same marker; catches manual install paths outside the repo tree |
|
|
372
|
+
|
|
373
|
+
Levels 1 and 2 are **fast paths** — no filesystem walk is performed when either
|
|
374
|
+
env var is set. This preserves backward compat with all existing deployments.
|
|
375
|
+
|
|
376
|
+
When all four levels fail a `PluginRootResolutionError` is thrown with a
|
|
377
|
+
`triedPaths` array listing what was attempted.
|
|
378
|
+
|
|
379
|
+
### Usage in hook handlers
|
|
380
|
+
|
|
381
|
+
```js
|
|
382
|
+
import { resolvePluginRoot, PluginRootResolutionError } from '../scripts/lib/plugin-root.mjs';
|
|
383
|
+
|
|
384
|
+
// Throws on failure — handle or let it bubble (hooks have top-level catch)
|
|
385
|
+
const pluginRoot = resolvePluginRoot();
|
|
386
|
+
```
|
|
387
|
+
|
|
388
|
+
`scripts/lib/platform.mjs`'s `resolvePluginRoot()` delegates to this helper
|
|
389
|
+
internally, so any caller already using the platform module gets the 4-level
|
|
390
|
+
fallback transparently.
|
|
391
|
+
|
|
392
|
+
### Tests
|
|
393
|
+
|
|
394
|
+
`tests/lib/plugin-root.test.mjs` (10 tests) covers: env-claude, env-codex,
|
|
395
|
+
walk-from-import-meta, walk-from-cwd, all-fail-throws-named-error,
|
|
396
|
+
env-precedence, PluginRootResolutionError class shape.
|
|
397
|
+
|
|
398
|
+
## Implementation checklist
|
|
399
|
+
|
|
400
|
+
- [ ] Event chosen (PreToolUse / Stop / …) matches intent
|
|
401
|
+
- [ ] Prompt-based vs. command decided based on whether reasoning is needed
|
|
402
|
+
- [ ] `hooks/hooks.json` uses **wrapper** format, NOT settings direct format
|
|
403
|
+
- [ ] `${CLAUDE_PLUGIN_ROOT}` for all paths
|
|
404
|
+
- [ ] Input validation on every field you read from stdin
|
|
405
|
+
- [ ] Timeout set if work is known-slow
|
|
406
|
+
- [ ] Tested directly via `echo '...' | hook.mjs`
|
|
407
|
+
- [ ] Tested in-session with `claude --debug`
|
|
408
|
+
- [ ] README/docs updated
|
|
409
|
+
|
|
410
|
+
## References
|
|
411
|
+
|
|
412
|
+
- [Official hooks docs](https://docs.claude.com/en/docs/claude-code/hooks)
|
|
413
|
+
- Upstream: [patterns.md](https://github.com/anthropics/claude-plugins-official/tree/main/plugins/plugin-dev/skills/hook-development/references/patterns.md), [advanced.md](https://github.com/anthropics/claude-plugins-official/tree/main/plugins/plugin-dev/skills/hook-development/references/advanced.md) — read these for edge cases we haven't hit yet
|
|
@@ -0,0 +1,260 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: mcp-builder
|
|
3
|
+
description: Use when creating a new MCP (Model Context Protocol) server, extending an existing one, or debugging tool discoverability/performance. Guides through research → implementation → test → eval phases with TypeScript-first guidance matching our stack. Trigger on phrases like "build an MCP server", "expose X as an MCP tool", "write MCP tools for Y", "integrate Z via MCP".
|
|
4
|
+
model: sonnet
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# MCP Server Development
|
|
8
|
+
|
|
9
|
+
Adapted from [anthropics/skills/mcp-builder](https://github.com/anthropics/skills/tree/main/skills/mcp-builder). MCP-server quality is measured by how well it lets LLMs accomplish real-world tasks — not by endpoint count.
|
|
10
|
+
|
|
11
|
+
## Stack default for our projects
|
|
12
|
+
|
|
13
|
+
- **Language:** TypeScript (matches our stack; static typing + Zod schemas + good LLM code-gen)
|
|
14
|
+
- **Transport:** `stdio` for local tools, **Streamable HTTP (stateless JSON)** for remote
|
|
15
|
+
- **SDK:** [`@modelcontextprotocol/sdk`](https://github.com/modelcontextprotocol/typescript-sdk)
|
|
16
|
+
- **Package manager:** pnpm (never npm/yarn in our repos)
|
|
17
|
+
|
|
18
|
+
## Phase 1 — Research & Plan
|
|
19
|
+
|
|
20
|
+
### 1.1 Design principles
|
|
21
|
+
|
|
22
|
+
**API coverage vs. workflow tools.** Balance comprehensive endpoint coverage with specialized workflow shortcuts. Default to coverage unless you have a clear reason — agents compose basic tools well; workflow tools ossify.
|
|
23
|
+
|
|
24
|
+
**Tool naming & discoverability.** Consistent prefix + action verb. Examples:
|
|
25
|
+
- `github_create_issue`, `github_list_repos`
|
|
26
|
+
- `gitlab_search_issues`, `gitlab_close_mr`
|
|
27
|
+
|
|
28
|
+
**Context management.** Return focused, paginated data. Agents suffer when a single tool call floods context.
|
|
29
|
+
|
|
30
|
+
**Actionable error messages.** Errors must guide the next action:
|
|
31
|
+
|
|
32
|
+
```
|
|
33
|
+
❌ "Invalid input"
|
|
34
|
+
✅ "Field 'project_id' is required. Call gitlab_list_projects to enumerate available IDs."
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### 1.2 Read the spec
|
|
38
|
+
|
|
39
|
+
- Sitemap: `https://modelcontextprotocol.io/sitemap.xml`
|
|
40
|
+
- Append `.md` to any page URL for markdown (e.g. `https://modelcontextprotocol.io/specification/draft.md`)
|
|
41
|
+
|
|
42
|
+
Focus on: tool definitions, resource definitions, transport mechanisms.
|
|
43
|
+
|
|
44
|
+
### 1.3 Load SDK docs
|
|
45
|
+
|
|
46
|
+
- TS SDK README: `https://raw.githubusercontent.com/modelcontextprotocol/typescript-sdk/main/README.md`
|
|
47
|
+
- Python SDK README: `https://raw.githubusercontent.com/modelcontextprotocol/python-sdk/main/README.md`
|
|
48
|
+
|
|
49
|
+
Fetch via WebFetch only when needed — don't dump entire docs into context upfront.
|
|
50
|
+
|
|
51
|
+
### 1.4 Plan implementation
|
|
52
|
+
|
|
53
|
+
- Review the target service's API docs (auth, core endpoints, data models)
|
|
54
|
+
- List endpoints by priority — most-common operations first
|
|
55
|
+
- Identify destructive vs. read-only operations (matters for tool annotations)
|
|
56
|
+
|
|
57
|
+
## Tool-Hosting Pattern — In-Process vs Stdio MCP
|
|
58
|
+
|
|
59
|
+
Before writing a line of implementation code, choose a hosting pattern. The wrong choice cannot be refactored cheaply once tooling is wired.
|
|
60
|
+
|
|
61
|
+
### Decision tree
|
|
62
|
+
|
|
63
|
+
```
|
|
64
|
+
≤ 5 tools AND latency-critical (<50ms tool resolution)?
|
|
65
|
+
│
|
|
66
|
+
├─ Yes → tools share the SDK process AND no external auth required?
|
|
67
|
+
│ │
|
|
68
|
+
│ ├─ Yes → In-process @tool decorator (single-process, sub-ms resolution)
|
|
69
|
+
│ └─ No → Stdio MCP Server
|
|
70
|
+
│
|
|
71
|
+
└─ No → Stdio MCP Server
|
|
72
|
+
(≥ 6 tools, external auth, language/runtime mismatch, long-lived process)
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### In-process @tool decorator (Python — anthropics/claude-agent-sdk-python)
|
|
76
|
+
|
|
77
|
+
Use `create_sdk_mcp_server` when your tools live entirely inside the SDK process and you need the lowest possible latency. Source reference: [`examples/mcp_calculator.py` L11–99](https://github.com/anthropics/claude-agent-sdk-python/blob/main/examples/mcp_calculator.py).
|
|
78
|
+
|
|
79
|
+
```python
|
|
80
|
+
from claude_agent_sdk import tool, create_sdk_mcp_server
|
|
81
|
+
|
|
82
|
+
@tool(name="add", description="Add two numbers", input_schema={"a": int, "b": int})
|
|
83
|
+
async def add(args):
|
|
84
|
+
return {"content": [{"type": "text", "text": str(args["a"] + args["b"])}]}
|
|
85
|
+
|
|
86
|
+
server = create_sdk_mcp_server(name="calc", version="1.0.0", tools=[add])
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### In-process registration (TypeScript — @modelcontextprotocol/sdk)
|
|
90
|
+
|
|
91
|
+
Our default stack uses `McpServer.registerTool()` from `@modelcontextprotocol/sdk`. The inline Zod schema is parsed at registration time — no separate schema file needed for small tool sets.
|
|
92
|
+
|
|
93
|
+
```typescript
|
|
94
|
+
import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
|
|
95
|
+
import { z } from 'zod';
|
|
96
|
+
|
|
97
|
+
const server = new McpServer({ name: 'calc', version: '1.0.0' });
|
|
98
|
+
|
|
99
|
+
server.registerTool(
|
|
100
|
+
'add',
|
|
101
|
+
{
|
|
102
|
+
title: 'Add two numbers',
|
|
103
|
+
inputSchema: { a: z.number(), b: z.number() },
|
|
104
|
+
},
|
|
105
|
+
async ({ a, b }) => ({
|
|
106
|
+
content: [{ type: 'text', text: String(a + b) }],
|
|
107
|
+
}),
|
|
108
|
+
);
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
### Tool annotations — `readOnlyHint` and `destructiveHint`
|
|
112
|
+
|
|
113
|
+
Annotations are first-class SDK metadata that Claude and downstream hooks use for permission decisions. Set them on every tool:
|
|
114
|
+
|
|
115
|
+
```typescript
|
|
116
|
+
server.registerTool(
|
|
117
|
+
'delete-file',
|
|
118
|
+
{
|
|
119
|
+
title: 'Delete a file',
|
|
120
|
+
inputSchema: { path: z.string() },
|
|
121
|
+
annotations: { readOnlyHint: false, destructiveHint: true },
|
|
122
|
+
},
|
|
123
|
+
handler,
|
|
124
|
+
);
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
- **`readOnlyHint: true`** — signals the tool only reads state; Claude can call it freely without a permission prompt.
|
|
128
|
+
- **`destructiveHint: true`** — signals irreversible side effects; our `pre-bash-destructive-guard` hook and `agents/security-reviewer.md` both elevate review priority for tools carrying this flag. Any tool that deletes, overwrites, or mutates shared state must set this.
|
|
129
|
+
- Missing `destructiveHint: true` on a destructive tool is a known pitfall — see the "Common pitfalls" table below.
|
|
130
|
+
|
|
131
|
+
### Pattern comparison
|
|
132
|
+
|
|
133
|
+
| Aspect | In-Process @tool | Stdio MCP Server |
|
|
134
|
+
|--------|-----------------|------------------|
|
|
135
|
+
| Tool count | ≤ 5 | 6+ |
|
|
136
|
+
| Latency | Sub-ms resolution | 5–50 ms IPC overhead |
|
|
137
|
+
| Auth complexity | Shares SDK auth | Separate auth context |
|
|
138
|
+
| Language constraint | Must match SDK | Any runtime |
|
|
139
|
+
| Process isolation | None (in-SDK) | Full (separate child) |
|
|
140
|
+
| Lifecycle | Bound to SDK session | Long-lived independent |
|
|
141
|
+
|
|
142
|
+
For the **stdio MCP server** implementation path (≥ 6 tools, external auth, or language mismatch), continue with [Phase 2 — Implementation](#phase-2--implementation) below, which covers project structure, core infrastructure, and the full TypeScript stdio setup.
|
|
143
|
+
|
|
144
|
+
### Alternative: Token-Frugal CLI Driver for MCP-Only Capabilities
|
|
145
|
+
|
|
146
|
+
If a future capability is **MCP-only** (no good native CLI of its own), the token-frugal path skips full `.mcp.json` wiring:
|
|
147
|
+
|
|
148
|
+
- **Standalone CLI driver:** `mcporter generate-cli <server> --bundle` mints a schema-baked standalone CLI for one MCP server (real flags: `--compile`, `--bundler rolldown|bun`, `--output <path>`, `--include-tools <csv>` / `--exclude-tools <csv>`). A driver skill dispatches it via Bash, writes deterministic JSON to a run-dir, and the orchestrator parses from disk — never via prompt context, so token cost stays flat. This is the same pattern `skills/playwright-driver/SKILL.md` and `skills/peekaboo-driver/SKILL.md` already use (dispatch CLI → write AX-snapshot/JSON → parse from disk).
|
|
149
|
+
- **One-shot tool call:** `mcporter call <server>.<tool>` (also: `mcporter call --server <s> --tool <t> --args '{...}'`) invokes a single MCP tool without a standing `.mcp.json` entry — a concrete implementation of the projects-baseline **MCP-002** discipline ("no cargo-cult `.mcp.json`"). Note: MCP-002 is a baseline cross-repo reference, not a local mandate in this repo.
|
|
150
|
+
|
|
151
|
+
**MCPJungle context:** this repo's local MCP layer is `session-orchestrator` declared in `.mcp.json` (a bash-based server). Baseline MCP aggregation is **MCPJungle** (machine-level gateway, not wired here). mcporter is therefore an *alternative recipe for MCP-only drivers*, not a drop-in for MCPJungle — it is optional (`skills/repo-audit/SKILL.md` Category 9 already uses it with graceful-degrade). **Only reach for this pattern when a real MCP-only-driver need arises; this is a forward-looking planning note.**
|
|
152
|
+
|
|
153
|
+
## Phase 2 — Implementation
|
|
154
|
+
|
|
155
|
+
### 2.1 Project structure (TypeScript)
|
|
156
|
+
|
|
157
|
+
```
|
|
158
|
+
mcp-server-name/
|
|
159
|
+
├── package.json
|
|
160
|
+
├── tsconfig.json
|
|
161
|
+
├── src/
|
|
162
|
+
│ ├── index.ts (server entry, transport wiring)
|
|
163
|
+
│ ├── tools/ (one file per tool or tool group)
|
|
164
|
+
│ ├── schemas.ts (shared Zod schemas)
|
|
165
|
+
│ └── client.ts (API client with auth + error handling)
|
|
166
|
+
└── README.md (setup + config)
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
### 2.2 Core infrastructure
|
|
170
|
+
|
|
171
|
+
Build once, reuse everywhere:
|
|
172
|
+
- API client with auth (env-var-driven, never hardcoded)
|
|
173
|
+
- Error-handler helper that returns actionable MCP error responses
|
|
174
|
+
- Pagination helper (most APIs paginate; most tools forget)
|
|
175
|
+
- Response formatter (JSON for structured, Markdown for human-readable where agents benefit from it)
|
|
176
|
+
|
|
177
|
+
### 2.3 Implement tools
|
|
178
|
+
|
|
179
|
+
For each tool:
|
|
180
|
+
|
|
181
|
+
**Input schema** — Zod, with descriptions per field:
|
|
182
|
+
```ts
|
|
183
|
+
z.object({
|
|
184
|
+
projectId: z.string().describe("GitLab project ID. Call gitlab_list_projects to discover."),
|
|
185
|
+
state: z.enum(["opened", "closed", "all"]).default("opened"),
|
|
186
|
+
});
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
**Output schema** — define `outputSchema` where possible; use `structuredContent` in tool responses (TS SDK feature). This helps downstream agents parse results.
|
|
190
|
+
|
|
191
|
+
**Annotations** — set all four:
|
|
192
|
+
- `readOnlyHint: true/false`
|
|
193
|
+
- `destructiveHint: true/false`
|
|
194
|
+
- `idempotentHint: true/false`
|
|
195
|
+
- `openWorldHint: true/false`
|
|
196
|
+
|
|
197
|
+
These inform Claude's hook decisions (destructive-guard, permission prompts).
|
|
198
|
+
|
|
199
|
+
**Implementation** — async/await for I/O; errors must surface with enough context for the LLM to fix them.
|
|
200
|
+
|
|
201
|
+
## Phase 3 — Review & Test
|
|
202
|
+
|
|
203
|
+
### 3.1 Code quality
|
|
204
|
+
|
|
205
|
+
- DRY — no duplicated API-call logic
|
|
206
|
+
- Consistent error handling (one helper, not ad-hoc throws)
|
|
207
|
+
- Full TypeScript coverage — `tsgo --noEmit` or `tsc --noEmit` clean
|
|
208
|
+
- Clear tool descriptions
|
|
209
|
+
|
|
210
|
+
### 3.2 Build & test
|
|
211
|
+
|
|
212
|
+
```bash
|
|
213
|
+
pnpm build # or npm run build in non-pnpm projects
|
|
214
|
+
npx @modelcontextprotocol/inspector # interactive testing UI
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
Walk through every tool in the Inspector. If a tool can fail, trigger the failure and verify the error message is actionable.
|
|
218
|
+
|
|
219
|
+
## Phase 4 — Evaluations
|
|
220
|
+
|
|
221
|
+
Create 10 evaluation questions. An MCP server without evals is a guess, not a deliverable.
|
|
222
|
+
|
|
223
|
+
Each question must be:
|
|
224
|
+
- **Independent** — doesn't depend on a previous question's answer
|
|
225
|
+
- **Read-only** — no destructive side effects
|
|
226
|
+
- **Complex** — requires multiple tool calls, not a single lookup
|
|
227
|
+
- **Realistic** — a real user would actually ask this
|
|
228
|
+
- **Verifiable** — has a single correct answer checkable by string comparison
|
|
229
|
+
- **Stable** — answer doesn't change over time
|
|
230
|
+
|
|
231
|
+
### Output format
|
|
232
|
+
|
|
233
|
+
```xml
|
|
234
|
+
<evaluation>
|
|
235
|
+
<qa_pair>
|
|
236
|
+
<question>Which GitLab project in group 'X' has the highest number of open issues labeled 'bug'?</question>
|
|
237
|
+
<answer>project-name-here</answer>
|
|
238
|
+
</qa_pair>
|
|
239
|
+
</evaluation>
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
Run the eval via: Claude-with-MCP-server on each question, compare output to expected answer. Any eval below 80% accuracy signals tool-design problems (usually: unclear descriptions, missing pagination, or bad error messages).
|
|
243
|
+
|
|
244
|
+
## Common pitfalls
|
|
245
|
+
|
|
246
|
+
| Pitfall | Fix |
|
|
247
|
+
|---------|-----|
|
|
248
|
+
| Tool returns 10k rows, agent context blows up | Add pagination + default page size |
|
|
249
|
+
| Agent can't figure out auth failure | Error message: "Set ENV_VAR_NAME — current value is empty" |
|
|
250
|
+
| Tool name collision across MCP servers | Always prefix with service name |
|
|
251
|
+
| Destructive tools without `destructiveHint: true` | Breaks our destructive-guard hook |
|
|
252
|
+
| Async errors swallowed | Wrap every handler in try/catch that returns structured error |
|
|
253
|
+
|
|
254
|
+
## References
|
|
255
|
+
|
|
256
|
+
Upstream reference material (worth reading once, not mirroring here):
|
|
257
|
+
- [MCP Best Practices](https://github.com/anthropics/skills/blob/main/skills/mcp-builder/reference/mcp_best_practices.md)
|
|
258
|
+
- [TypeScript Implementation Guide](https://github.com/anthropics/skills/blob/main/skills/mcp-builder/reference/node_mcp_server.md)
|
|
259
|
+
- [Python Implementation Guide](https://github.com/anthropics/skills/blob/main/skills/mcp-builder/reference/python_mcp_server.md)
|
|
260
|
+
- [Evaluation Guide](https://github.com/anthropics/skills/blob/main/skills/mcp-builder/reference/evaluation.md)
|