@bridge_gpt/mcp-server 0.2.62 → 0.2.66
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/README.md +66 -15
- package/build/agent-launchers/claude-executor-adapter.js +145 -20
- package/build/agent-launchers/executor-adapter.js +81 -2
- package/build/agents.generated.js +10 -1
- package/build/bounded-wait.js +32 -1
- package/build/bridge-config.js +104 -0
- package/build/codex-bridge-profile.js +10 -1
- package/build/commands.generated.js +7 -6
- package/build/conductor/bridge-api-client.js +565 -32
- package/build/conductor/bring-up-facts.js +3 -1
- package/build/conductor/doctor.js +23 -14
- package/build/conductor/epic-child-continuation.js +351 -0
- package/build/conductor/epic-implementer-cli.js +154 -17
- package/build/conductor/git-hooks.js +529 -118
- package/build/conductor/guided-repair.js +323 -0
- package/build/conductor/hook-runtime-qualification.js +340 -0
- package/build/conductor/readiness-cli.js +30 -9
- package/build/conductor/readiness-sections.js +5 -4
- package/build/conductor/readiness.js +45 -12
- package/build/conductor/recovery-cli.js +859 -27
- package/build/conductor/recovery-operations.js +574 -5
- package/build/conductor/repair-contract.js +69 -3
- package/build/conductor-bundle-artifacts.js +1 -0
- package/build/credential-store.js +52 -13
- package/build/diagnostic-text.js +36 -0
- package/build/docs.generated.js +3 -2
- package/build/doctor.js +147 -21
- package/build/drive-epic-key.js +12 -0
- package/build/drive-epic.js +1537 -125
- package/build/epic-coherence-input-cli.js +137 -0
- package/build/epic-coherence-input.js +920 -0
- package/build/epic-coherence-input.test-fixtures.js +175 -0
- package/build/epic-implementer-bin.js +41 -33
- package/build/epic-implementer-bundle-cli.js +14 -1
- package/build/epic-launch-diagnostic.js +31 -0
- package/build/epic-launch-profile.js +58 -19
- package/build/epic-run-status.js +5 -0
- package/build/epic-shared/bridge-client.js +46 -4
- package/build/executor/cli.js +39 -0
- package/build/executor/completion-contract.js +423 -0
- package/build/executor/completion-supervision.js +291 -0
- package/build/executor/correction-dispatch.js +60 -0
- package/build/executor/credentials.js +3 -1
- package/build/executor/deps.js +65 -1
- package/build/executor/env.js +12 -0
- package/build/executor/heartbeat.js +13 -3
- package/build/executor/http-client.js +91 -4
- package/build/executor/integration-job.js +6 -1
- package/build/executor/job-errors.js +61 -4
- package/build/executor/job-log-registry.js +340 -73
- package/build/executor/job-runner.js +1550 -55
- package/build/executor/job-types.js +9 -6
- package/build/executor/preflight.js +189 -1
- package/build/executor/process-containment.js +756 -0
- package/build/executor/process.js +235 -5
- package/build/executor/prompt-spec.js +366 -1
- package/build/executor/provider-checks.js +69 -0
- package/build/executor/rebase-finalization.js +351 -0
- package/build/executor/reconcile-overlap-job.js +77 -84
- package/build/executor/required-verification.js +313 -0
- package/build/executor/required-work-ledger.js +1121 -0
- package/build/executor/results.js +142 -0
- package/build/executor/resume-pre-spawn.js +87 -4
- package/build/executor/runner.js +168 -0
- package/build/executor/stale-artifacts.js +5 -4
- package/build/executor/test-declaration.js +20 -0
- package/build/executor/types.js +13 -0
- package/build/executor/watch-cli.js +35 -8
- package/build/executor/worker-command.js +70 -34
- package/build/executor/worker-finalization.js +168 -26
- package/build/executor/worker-guard-hook.js +75 -14
- package/build/executor/worker-log.js +137 -70
- package/build/executor/worktree-gc.js +30 -6
- package/build/executor/worktree.js +13 -0
- package/build/executor-launch.js +658 -0
- package/build/index.js +594 -1152
- package/build/init.js +107 -4
- package/build/install-bridge-conductor.js +231 -41
- package/build/install-bridge.js +284 -20
- package/build/install-doctor.js +172 -30
- package/build/install-reexec.js +69 -7
- package/build/macos-terminal-permission-guidance.js +16 -0
- package/build/merge-pull-request.js +1 -1
- package/build/model-thresholds-tool.js +185 -0
- package/build/pipelines.generated.js +9 -8
- package/build/plan-discovery.js +137 -0
- package/build/plan-epic-implementer-eligibility.js +2 -2
- package/build/plane/cli.js +37 -3
- package/build/plane/member-logs.js +3 -0
- package/build/plane/member-roster.js +7 -1
- package/build/plane/shutdown.js +59 -1
- package/build/plane/status.js +4 -0
- package/build/plane/supervisor.js +146 -0
- package/build/plane/worker-exit-code.js +2 -0
- package/build/project-root.js +99 -0
- package/build/readme.generated.js +1 -1
- package/build/review-tickets.js +156 -13
- package/build/scripts/executor-protocol-contract-driver.js +13 -3
- package/build/setup-epic.js +208 -125
- package/build/sfcc/setup-status.js +2 -0
- package/build/sfcc/tool-wrapper.js +2 -0
- package/build/sfcc/tools-configured.js +96 -0
- package/build/start-tickets.js +163 -58
- package/build/upgrade-cli.js +109 -24
- package/build/version.generated.js +3 -3
- package/build/windows-npm-entry.js +103 -0
- package/build/worker-guard-hook-bin.js +5 -4
- package/build/worktree-core.js +6 -5
- package/docs/CONDUCTOR.md +116 -2
- package/docs/install/mcp-tool-integrations.md +1 -0
- package/docs/install/sfcc-integration.md +12 -7
- package/package.json +2 -1
- package/pipelines/implement-ticket.json +1 -1
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* The shared contract for the
|
|
3
|
-
* `scope-reparse`, `dispatch-remediation`, and `merge-child`,
|
|
4
|
-
* `scope-catch-up`, `patch-policy`, and `resume-run
|
|
2
|
+
* The shared contract for the seven operator repair verbs: BAPI-1154's
|
|
3
|
+
* `scope-reparse`, `dispatch-remediation`, and `merge-child`, BAPI-1176's
|
|
4
|
+
* `scope-catch-up`, `patch-policy`, and `resume-run`, and BAPI-1326's
|
|
5
|
+
* ticket-addressed `resume-ci`.
|
|
5
6
|
*
|
|
6
7
|
* CLI-only, exactly like the BAPI-872 recovery verbs: none of these names is ever
|
|
7
8
|
* registered as an MCP tool (`index-static.test.ts` pins that). This module is the
|
|
@@ -20,6 +21,7 @@ export const VERB_MERGE_CHILD = "merge-child";
|
|
|
20
21
|
export const VERB_SCOPE_CATCH_UP = "scope-catch-up";
|
|
21
22
|
export const VERB_PATCH_POLICY = "patch-policy";
|
|
22
23
|
export const VERB_RESUME_RUN = "resume-run";
|
|
24
|
+
export const VERB_RESUME_CI = "resume-ci";
|
|
23
25
|
/** Every repair verb, in the order an operator meets them. */
|
|
24
26
|
export const OPERATOR_REPAIR_VERBS = [
|
|
25
27
|
VERB_SCOPE_REPARSE,
|
|
@@ -28,6 +30,7 @@ export const OPERATOR_REPAIR_VERBS = [
|
|
|
28
30
|
VERB_SCOPE_CATCH_UP,
|
|
29
31
|
VERB_PATCH_POLICY,
|
|
30
32
|
VERB_RESUME_RUN,
|
|
33
|
+
VERB_RESUME_CI,
|
|
31
34
|
];
|
|
32
35
|
/**
|
|
33
36
|
* The ONE cap on driver context, in UTF-8 BYTES — the same number the server
|
|
@@ -43,6 +46,14 @@ export const DRIVER_CONTEXT_MAX_BYTES = 16384;
|
|
|
43
46
|
* never parsed, printed, or transmitted.
|
|
44
47
|
*/
|
|
45
48
|
export const POLICY_PATCH_MAX_BYTES = 16384;
|
|
49
|
+
/**
|
|
50
|
+
* BAPI-1294 — the bounded `unavailable` message for a `resume-run` whose outcome
|
|
51
|
+
* the client cannot confirm (a 5xx, timeout, dropped connection, or unreadable
|
|
52
|
+
* 2xx). It never repeats server body text and never claims either outcome.
|
|
53
|
+
*/
|
|
54
|
+
export const RESUME_RUN_UNCONFIRMED_MESSAGE = "resume-run outcome could not be confirmed: the server may or may not have " +
|
|
55
|
+
"committed the resume. Inspect the run read-only before choosing any separately " +
|
|
56
|
+
"authorized mutation";
|
|
46
57
|
/**
|
|
47
58
|
* The closed refusal-code vocabulary, mirroring the server table.
|
|
48
59
|
*
|
|
@@ -84,9 +95,64 @@ export const OPERATOR_REPAIR_REFUSAL_CODES = [
|
|
|
84
95
|
"RUN_STOPPED",
|
|
85
96
|
"QUARANTINE_CLEARANCE_REQUIRED",
|
|
86
97
|
"RUN_CONTROL_CONFLICT",
|
|
98
|
+
// BAPI-1326
|
|
99
|
+
"CI_STOP_NOT_ELIGIBLE",
|
|
100
|
+
"CI_RESUME_STALE_OPERATION",
|
|
101
|
+
"CI_RESUME_OPERATION_CONFLICT",
|
|
102
|
+
"CI_RESUME_BINDING_CHANGED",
|
|
103
|
+
"CI_RESUME_POLICY_CHANGED",
|
|
104
|
+
"CI_RESUME_SPEC_CHANGED",
|
|
105
|
+
"CI_RESUME_CHECKS_NOT_GREEN",
|
|
106
|
+
"CI_RESUME_VERDICT_UNAVAILABLE",
|
|
107
|
+
"CI_RESUME_HELD",
|
|
108
|
+
"CI_RESUME_LIVE_WORK",
|
|
109
|
+
"CI_RESUME_BUDGET_EXHAUSTED",
|
|
110
|
+
"CI_RESUME_BUSY",
|
|
111
|
+
// BAPI-1333
|
|
112
|
+
"GUIDED_REPAIR_DISABLED",
|
|
113
|
+
"REPAIR_SUBJECT_STALE",
|
|
87
114
|
];
|
|
88
115
|
/** True when `code` is one of the closed repair refusal codes. */
|
|
89
116
|
export function isOperatorRepairRefusalCode(code) {
|
|
90
117
|
return (typeof code === "string" &&
|
|
91
118
|
OPERATOR_REPAIR_REFUSAL_CODES.includes(code));
|
|
92
119
|
}
|
|
120
|
+
// ---------------------------------------------------------------------------
|
|
121
|
+
// BAPI-1326 — `resume-ci`
|
|
122
|
+
// ---------------------------------------------------------------------------
|
|
123
|
+
/**
|
|
124
|
+
* The closed `resume-ci` refusal subset, in the order the server checks them —
|
|
125
|
+
* mirrors `CI_RESUME_REFUSAL_CODES` in `operator_repair_contract.py`.
|
|
126
|
+
*/
|
|
127
|
+
export const CI_RESUME_REFUSAL_CODES = [
|
|
128
|
+
"TICKET_NOT_IN_RUN",
|
|
129
|
+
"CI_STOP_NOT_ELIGIBLE",
|
|
130
|
+
"CI_RESUME_STALE_OPERATION",
|
|
131
|
+
"CI_RESUME_OPERATION_CONFLICT",
|
|
132
|
+
"ROW_VERSION_CONFLICT",
|
|
133
|
+
"RUN_NOT_DISPATCHABLE",
|
|
134
|
+
"CI_RESUME_BUDGET_EXHAUSTED",
|
|
135
|
+
"CI_RESUME_HELD",
|
|
136
|
+
"CI_RESUME_LIVE_WORK",
|
|
137
|
+
"CI_RESUME_SPEC_CHANGED",
|
|
138
|
+
"CI_RESUME_POLICY_CHANGED",
|
|
139
|
+
"CI_RESUME_BINDING_CHANGED",
|
|
140
|
+
"CI_RESUME_CHECKS_NOT_GREEN",
|
|
141
|
+
"CI_RESUME_VERDICT_UNAVAILABLE",
|
|
142
|
+
"CI_RESUME_BUSY",
|
|
143
|
+
];
|
|
144
|
+
/**
|
|
145
|
+
* The closed outcome vocabulary. The server answers `committed` or `replayed`;
|
|
146
|
+
* `refused` is a structured error, and `unconfirmed` is minted only by the client
|
|
147
|
+
* when no durable answer arrived.
|
|
148
|
+
*/
|
|
149
|
+
export const CI_RESUME_OUTCOMES = ["committed", "replayed", "refused", "unconfirmed"];
|
|
150
|
+
/**
|
|
151
|
+
* Receipt retention: only the latest committed operation per ticket is kept. A
|
|
152
|
+
* request whose receipt was displaced is refused as stale, never replayed.
|
|
153
|
+
*/
|
|
154
|
+
export const CI_RESUME_RECEIPT_RETENTION = "latest_only";
|
|
155
|
+
/** True when `code` is one of the closed `resume-ci` refusal codes. */
|
|
156
|
+
export function isCiResumeRefusalCode(code) {
|
|
157
|
+
return (typeof code === "string" && CI_RESUME_REFUSAL_CODES.includes(code));
|
|
158
|
+
}
|
|
@@ -225,6 +225,7 @@ export async function validateConductorBundleInputs(args, fs) {
|
|
|
225
225
|
epic_plan_path: path.join(resolvedEpicDir.value, "epic-plan.md"),
|
|
226
226
|
sidecar_path: path.join(resolvedEpicDir.value, "epic-plan.dag.json"),
|
|
227
227
|
manifest_path: path.join(resolvedEpicDir.value, "sibling-ticket-manifest.json"),
|
|
228
|
+
meta_path: path.join(resolvedEpicDir.value, "epic-plan.meta.json"),
|
|
228
229
|
report_path: path.join(resolvedEpicDir.value, "harmonization-report.json"),
|
|
229
230
|
plan_version: planVersion.value,
|
|
230
231
|
mappings: resolvedMappings,
|
|
@@ -38,6 +38,7 @@
|
|
|
38
38
|
* user-scoped `~/.config/bridge/credentials.json` store written here.
|
|
39
39
|
*/
|
|
40
40
|
import path from "path";
|
|
41
|
+
import { diagnosticComponent } from "./epic-launch-diagnostic.js";
|
|
41
42
|
// ---------------------------------------------------------------------------
|
|
42
43
|
// Path resolution
|
|
43
44
|
// ---------------------------------------------------------------------------
|
|
@@ -1443,16 +1444,21 @@ function normalizeBoundBaseUrl(raw) {
|
|
|
1443
1444
|
* - An ambient `BAPI_API_KEY` is used only when the same environment also sets
|
|
1444
1445
|
* `BAPI_BASE_URL` to exactly the target — the pair is its provenance.
|
|
1445
1446
|
* Anything else is `ambient-key-unbound`, and the key is NOT sent.
|
|
1446
|
-
* - A stored key is used
|
|
1447
|
-
* {@link BAPI_EPIC_LAUNCH_BOUND_BASE_URL_FIELD} equal to the target.
|
|
1448
|
-
*
|
|
1449
|
-
*
|
|
1447
|
+
* - A stored key is used when its entry carries
|
|
1448
|
+
* {@link BAPI_EPIC_LAUNCH_BOUND_BASE_URL_FIELD} equal to the target.
|
|
1449
|
+
* - BAPI-1272: a stored key with NO binding field is also used when the
|
|
1450
|
+
* target normalizes to `options.productionBaseUrl` (`production-default`).
|
|
1451
|
+
* For any other target an entry with no binding is `binding-unbound` (a
|
|
1452
|
+
* legacy credential, upgraded once through guided setup).
|
|
1453
|
+
* - A binding to a different endpoint — or a binding field that is present
|
|
1454
|
+
* but empty — is `binding-mismatch`, even when the target is production:
|
|
1455
|
+
* a key approved for a local server is never sent to production.
|
|
1450
1456
|
*
|
|
1451
1457
|
* Read-only and migration-free: it never writes the store. Errors name the
|
|
1452
1458
|
* logical target and the store path only — never a secret or the entry's
|
|
1453
1459
|
* contents.
|
|
1454
1460
|
*/
|
|
1455
|
-
export async function resolveEpicLaunchCredential(repoName, targetBaseUrl, deps) {
|
|
1461
|
+
export async function resolveEpicLaunchCredential(repoName, targetBaseUrl, deps, options = {}) {
|
|
1456
1462
|
const target = normalizeBoundBaseUrl(targetBaseUrl);
|
|
1457
1463
|
const bundleKey = `bapi:${repoName}`;
|
|
1458
1464
|
if (target === null || repoName.trim().length === 0) {
|
|
@@ -1482,27 +1488,60 @@ export async function resolveEpicLaunchCredential(repoName, targetBaseUrl, deps)
|
|
|
1482
1488
|
});
|
|
1483
1489
|
if (!stored.ok)
|
|
1484
1490
|
return { ok: false, kind: stored.kind, error: stored.error };
|
|
1485
|
-
const
|
|
1491
|
+
const binding = await readStoredBindingState(bundleKey, deps);
|
|
1486
1492
|
const primaryPath = getPrimaryCredentialStorePath(deps);
|
|
1487
|
-
if (
|
|
1493
|
+
if (binding.state === "absent" || binding.state === "no-entry") {
|
|
1494
|
+
const production = normalizeBoundBaseUrl(options.productionBaseUrl);
|
|
1495
|
+
if (binding.state === "absent" && production !== null && production === target) {
|
|
1496
|
+
return { ok: true, apiKey: stored.values.BAPI_API_KEY, source: "file", binding: "production-default" };
|
|
1497
|
+
}
|
|
1488
1498
|
return {
|
|
1489
1499
|
ok: false,
|
|
1490
1500
|
kind: "binding-unbound",
|
|
1491
|
-
error: `The stored credential "${bundleKey}" has not been approved for
|
|
1492
|
-
`(${primaryPath}).
|
|
1493
|
-
|
|
1501
|
+
error: `The stored credential "${diagnosticComponent(bundleKey)}" has not been approved for this Bridge API endpoint ` +
|
|
1502
|
+
`(${diagnosticComponent(primaryPath)}). Production needs no approval; any other endpoint does. Run guided setup ` +
|
|
1503
|
+
`once to bind it: install conductor --launch-profile <name> --base-url ${diagnosticComponent(target)}.`,
|
|
1494
1504
|
};
|
|
1495
1505
|
}
|
|
1496
|
-
|
|
1506
|
+
// An unreadable read-back is refused like a mismatch: the key was read a
|
|
1507
|
+
// moment ago, so failing closed is the only safe reading.
|
|
1508
|
+
if (binding.state === "invalid" || binding.state === "unreadable" || binding.baseUrl !== target) {
|
|
1497
1509
|
return {
|
|
1498
1510
|
ok: false,
|
|
1499
1511
|
kind: "binding-mismatch",
|
|
1500
|
-
error: `The stored credential "${bundleKey}" is approved for a different Bridge API endpoint than the ` +
|
|
1501
|
-
"selected target. It was not sent.
|
|
1512
|
+
error: `The stored credential "${diagnosticComponent(bundleKey)}" is approved for a different Bridge API endpoint than the ` +
|
|
1513
|
+
"selected target. It was not sent. A key approved for a local server is never sent to " +
|
|
1514
|
+
"production: pass that server's --launch-profile <name> or --base-url <url>, or bind the key " +
|
|
1515
|
+
"once with install conductor --launch-profile <name> --base-url <url>.",
|
|
1502
1516
|
};
|
|
1503
1517
|
}
|
|
1504
1518
|
return { ok: true, apiKey: stored.values.BAPI_API_KEY, source: "file", binding: "store-bound" };
|
|
1505
1519
|
}
|
|
1520
|
+
/**
|
|
1521
|
+
* Read the binding field of one bundle in the three states of
|
|
1522
|
+
* {@link StoredBindingState}. Never throws.
|
|
1523
|
+
*/
|
|
1524
|
+
export async function readStoredBindingState(bundleKey, deps) {
|
|
1525
|
+
try {
|
|
1526
|
+
const resolution = await resolveCredentialStorePath(deps);
|
|
1527
|
+
if (!resolution.found)
|
|
1528
|
+
return { state: "no-entry" };
|
|
1529
|
+
const parsed = parseCredentialStoreJson(await deps.readFile(resolution.path));
|
|
1530
|
+
if (!parsed.ok)
|
|
1531
|
+
return { state: "unreadable" };
|
|
1532
|
+
const entry = parsed.value[bundleKey];
|
|
1533
|
+
if (entry === undefined)
|
|
1534
|
+
return { state: "no-entry" };
|
|
1535
|
+
if (!Object.prototype.hasOwnProperty.call(entry, BAPI_EPIC_LAUNCH_BOUND_BASE_URL_FIELD)) {
|
|
1536
|
+
return { state: "absent" };
|
|
1537
|
+
}
|
|
1538
|
+
const baseUrl = normalizeBoundBaseUrl(entry[BAPI_EPIC_LAUNCH_BOUND_BASE_URL_FIELD]);
|
|
1539
|
+
return baseUrl === null ? { state: "invalid" } : { state: "bound", baseUrl };
|
|
1540
|
+
}
|
|
1541
|
+
catch {
|
|
1542
|
+
return { state: "unreadable" };
|
|
1543
|
+
}
|
|
1544
|
+
}
|
|
1506
1545
|
/**
|
|
1507
1546
|
* Read the non-secret bound base URL for one bundle, or `null` when the store,
|
|
1508
1547
|
* the entry, or the field is absent or unreadable. Never throws.
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Single-line rendering for untrusted values in diagnostics (BAPI-1318).
|
|
3
|
+
*
|
|
4
|
+
* Project names read from `.bridge/config` or an MCP config env block, and paths
|
|
5
|
+
* read from `BAPI_PROJECT_ROOT`, are user-controlled. A newline or other control
|
|
6
|
+
* character in one of them could forge an extra line in a stderr diagnostic or a
|
|
7
|
+
* doctor report. This renderer escapes every ASCII control character and bounds
|
|
8
|
+
* the length, so each value always occupies exactly one line of output.
|
|
9
|
+
*/
|
|
10
|
+
/** Longest rendered value; anything longer is cut and marked with an ellipsis. */
|
|
11
|
+
export const DIAGNOSTIC_VALUE_MAX_LENGTH = 200;
|
|
12
|
+
/**
|
|
13
|
+
* Render `value` for a one-line diagnostic: control characters become `\xNN`
|
|
14
|
+
* (with `\n`, `\r`, and `\t` spelled out), and the result is bounded to
|
|
15
|
+
* {@link DIAGNOSTIC_VALUE_MAX_LENGTH} characters.
|
|
16
|
+
*/
|
|
17
|
+
export function renderDiagnosticValue(value) {
|
|
18
|
+
let out = "";
|
|
19
|
+
for (const ch of value) {
|
|
20
|
+
const code = ch.charCodeAt(0);
|
|
21
|
+
if (ch === "\n")
|
|
22
|
+
out += "\\n";
|
|
23
|
+
else if (ch === "\r")
|
|
24
|
+
out += "\\r";
|
|
25
|
+
else if (ch === "\t")
|
|
26
|
+
out += "\\t";
|
|
27
|
+
else if (code <= 0x1f || code === 0x7f)
|
|
28
|
+
out += `\\x${code.toString(16).padStart(2, "0")}`;
|
|
29
|
+
else
|
|
30
|
+
out += ch;
|
|
31
|
+
}
|
|
32
|
+
if (out.length > DIAGNOSTIC_VALUE_MAX_LENGTH) {
|
|
33
|
+
out = `${out.slice(0, DIAGNOSTIC_VALUE_MAX_LENGTH)}…`;
|
|
34
|
+
}
|
|
35
|
+
return out;
|
|
36
|
+
}
|
package/build/docs.generated.js
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
// This file is produced by scripts/bundle-docs.js
|
|
3
3
|
export const DOCS = {
|
|
4
4
|
"docs/mcp-tool-integrations.md": "# MCP tool integrations — the human \"why\" behind the capability report\n\nThis catalog is **explanatory prose only**. It exists so the `/install-bridge`\ncapability report can cite a human-readable \"why\" for each gate. It is **not** a\nsource of truth for gating: the server computes every `locked_tools` /\n`unlocked_tools` membership decision itself and the agent must never recompute a\ntool's dependencies from this document.\n\n**Authoritative source of gating.** The enforced rules — which tools are blocked,\nwhich are degraded, and what each requires — live in\n`api/library/vcs/vcs_route_operations.py`:\n\n- `VCS_ROUTE_REQUIREMENTS` — routes that **BLOCK** (are unavailable) without a\n VCS connection.\n- `VCS_ROUTE_WARNINGS` — routes that **DEGRADE** (stay usable, but without\n codebase context) without a VCS connection.\n- `NEVER_GATED_ROUTE_KEYS` — routes that are never gated on any integration.\n- `INDEX_REQUIRED_ROUTE_KEYS`, `INDEX_REQUIRED_COUNCIL_MODES`,\n `CREATE_DOC_CODEBASE_CONTEXT_DOC_TYPES`, `CREATE_DOC_WARN_DOC_TYPES` — the\n conditional \"requires a successful code index\" dimension.\n- The resolver helpers `get_required_vcs_operation()`, `get_warn_vcs_operation()`,\n and `requires_successful_index()` are the authoritative functions that decide a\n case. The capability report is derived from these; this catalog explains them.\n\n## Reading the capability report\n\nEach tool entry the server returns has the exact shape\n`{tool, effect, missing, semantics}`:\n\n- **`effect`**\n - **`BLOCK`** — the tool is **unavailable** until every listed dependency is\n met. It will refuse to run without them.\n - **`DEGRADE`** — the tool is **usable right now**, but **without codebase\n context** (it cannot ground its output in your repository). Connecting the\n listed dependency upgrades it from \"works blind\" to \"works with full context\".\n A `DEGRADE` tool is never \"failed\".\n- **`missing`** — the server-computed dependency identifiers still needed:\n integration ids such as `github_app` / `vcs_access_token`, and the synthetic\n `code_index` (a successful repository index).\n- **`semantics`**\n - **`all_of`** — every id in `missing` is required.\n - **`any_of`** — the VCS-provider candidates in `missing` are alternatives:\n **either** `github_app` **or** `vcs_access_token` satisfies the VCS\n requirement (this is the \"provider unknown\" case). When `code_index` also\n appears, it remains separately required — `semantics` describes only the VCS\n provider candidates, and a code index is always mandatory in addition.\n\nThe three readiness dimensions `configured` / `learned` / `indexed` are reported\nindependently. `indexed` may be `true`, `false`, or `null` — a `null` means the\nindex status could not be confirmed and must **not** be read as \"indexed\".\n\n## The integrations\n\n| Integration id | What it is | What it unlocks |\n| --- | --- | --- |\n| `jira` | Jira API access | Ticket reads/writes, estimation and review automations, status transitions. |\n| `github_app` | GitHub App installation | Pull requests, code review, and private-repo parsing on GitHub projects. |\n| `vcs_access_token` | VCS access token | Pull requests, code review, and private-repo parsing on Bitbucket projects. |\n| `vcs_webhook` | VCS webhook secret | Merge webhooks and CI follow-up triggers. |\n| `code_index` | A successful repository index | Codebase-grounded planning, architecture, reimplementation, and technical/discovery AI councils. Produced by `/parse-repository`. |\n\nA project's `github_app` **or** `vcs_access_token` provides the VCS connection;\nwhich one applies depends on the project's version-control system. When the\nproject's provider is unknown, either credential satisfies the requirement — the\nreport expresses that as `semantics: any_of`.\n\n## The gates, by capability\n\n### Pull requests and CI (BLOCK on VCS)\n\nTools like `create_pull_request`, `resolve_ci_checks`, `poll_ci_checks`, and\n`fresh_base` are **unavailable** (`BLOCK`) until a VCS connection is\nconfigured. They act directly on the version-control host, so without a\nconnection there is nothing for them to talk to.\n\n### Repository indexing and maps (BLOCK on VCS)\n\n`parse_repository` and `regenerate_directory_map` need a VCS connection to read\nthe repository. They **BLOCK** until VCS is connected.\n\n### Codebase-grounded generation (BLOCK on VCS **and** a code index)\n\nPlanning and architecture tools — `generate_plan_direct`,\n`generate_architecture_direct`, `request_reimplement_context`,\n`code_writer_generate_plan`, `code_writer_generate_architecture`, and\n`create_doc` for **TDD** / **architecture** documents — ground their output in\nyour indexed codebase. They **BLOCK** until BOTH a VCS connection AND a\nsuccessful code index exist (`all_of`, with `code_index` in `missing`).\n\n### AI Council (BLOCK on a code index, mode-dependent)\n\n`request_council` in **technical** or **discovery** mode searches your indexed\ncodebase, so it **BLOCK**s on `code_index`. **Design**-mode AI council requests never\nquery the index and are never gated.\n\n### Document generation that DEGRADEs (usable without codebase context)\n\nTools like `generate_prd_direct`, `generate_fsd_direct`,\n`code_writer_generate_fsd`, `generate_clarifying_questions_direct`,\n`generate_ticket_critique_direct`, `generate_ticket_review_direct`, and\n`create_doc` for **PRD** / **FSD** documents **DEGRADE** rather than block: they\nrun today from the ticket alone, and connecting VCS simply lets them ground their\noutput in your codebase. They always appear under \"Tools you can use now\", with a\nreduced-context caveat when the VCS connection is missing.\n\n### Never gated\n\nSetup and bootstrap tools (`ping`, `config_field`, `get_install_manifest`,\n`apply_install_manifest`, `persist_routing_credential`, and the\nbootstrap-invite exchange) are always available — they\nare how you configure everything else.\n",
|
|
5
|
-
"docs/install/sfcc-integration.md": "# Installing the SFCC Integration (OCAPI)\n\nBridge's Salesforce B2C Commerce (SFCC) tools give an AI coding agent read access to\na sandbox's object model, custom object definitions, and site preferences — plus a\nsmall set of sandbox-only writes — through the **OCAPI Data API**. This guide covers\nsetting up the OCAPI client that those tools authenticate against.\n\n> **Sandbox / local development only.** This integration is intended for a **developer\n> sandbox**, and that restriction is **enforced in code**: before any SFCC tool runs,\n> Bridge validates the hostname your credentials actually resolve to — from `dw.json`\n> or `SFCC_*` — against the sandbox forms listed below. An unrecognized host is refused\n> with a `403` (`error.code: \"TARGET_NOT_SANDBOX\"`) before any request leaves your\n> machine. The check reads the resolved hostname, never the `instance` tool argument,\n> so omitting `instance` or passing `\"sandbox\"` cannot bypass it.\n>\n> Accepted sandbox hostname forms:\n>\n> - `<realm>-<nnn>.sandbox.<region>.dx.commercecloud.salesforce.com`\n> - `<realm>-<nnn>.sandbox.dx.commercecloud.salesforce.com`\n> - `<realm>-<nnn>.dx.commercecloud.salesforce.com`\n>\n> Anything else — a `production-`/`staging-`/`development-` prefixed host, or any\n> `*.demandware.net` host — is rejected.\n>\n> Still do not configure the grants below on an instance that holds real data.\n> Credentials stay local (in `dw.json` or `SFCC_*` env vars) and are never sent to\n> Bridge.\n\nFor the full per-tool list and what each SFCC tool depends on, see\n[MCP Tool Integration Dependencies](./mcp-tool-integrations.md). For the tool reference\nand the `BRIDGE_MCP_PROFILE` gating, see the SFCC section of the\n[package README](../../README.md).\n\n## Prerequisites\n\n- A running SFCC **developer sandbox** and its hostname\n (e.g. `zzzz-001.sandbox.us01.dx.commercecloud.salesforce.com`).\n- An **Account Manager API client** — a `client-id` and `client-secret`. This is the\n OCAPI client the tools use to obtain an OAuth token. Create one in Account Manager\n (**API Client** → *Add API Client*) if you don't already have it, and note its\n `client_id`.\n- Business Manager access to the sandbox with permission to edit **Open Commerce API\n Settings**.\n\n## 1. Grant the OCAPI client access in Business Manager\n\nIn Business Manager for the sandbox:\n\n**Administration → Site Development → Open Commerce API Settings → Data API** tab.\n\nAdd the client entry below to the `clients` array of the Data API settings, then\n**Save**. It grants only the resource families and HTTP methods Bridge's SFCC tools\nactually call — not a global `/**` grant. `check_permissions` prints the same JSON on\na 401/403, split into the two blocks.\n\n**READ/SEARCH TOOL GRANTS** — required by the `sfcc` read tools. (`post` is OCAPI's\nconvention for its `*_search` endpoints, not a mutation.)\n\n```json\n{\n \"client_id\": \"<your-client-id-here>\",\n \"resources\": [\n { \"resource_id\": \"/system_object_definitions\", \"methods\": [\"get\"], \"read_attributes\": \"(**)\", \"write_attributes\": \"(**)\" },\n { \"resource_id\": \"/system_object_definitions/**\", \"methods\": [\"get\", \"post\"], \"read_attributes\": \"(**)\", \"write_attributes\": \"(**)\" },\n { \"resource_id\": \"/site_preferences/**\", \"methods\": [\"get\", \"post\"], \"read_attributes\": \"(**)\", \"write_attributes\": \"(**)\" },\n { \"resource_id\": \"/custom_object_definitions/**\", \"methods\": [\"get\", \"post\"], \"read_attributes\": \"(**)\", \"write_attributes\": \"(**)\" }\n ]\n}\n```\n\n**MUTATION GRANTS** — required **only if you enable `BRIDGE_MCP_PROFILE=sfcc-write`**,\nwhich registers the nine destructive write tools. These are shipped capabilities, not\nfuture work. No `delete` is granted, because no shipped write tool performs one; the\n`get` entries are needed for the If-Match ETag round trip that precedes each `PATCH`.\n\n```json\n{\n \"client_id\": \"<your-client-id-here>\",\n \"resources\": [\n { \"resource_id\": \"/system_object_definitions\", \"methods\": [\"get\"], \"read_attributes\": \"(**)\", \"write_attributes\": \"(**)\" },\n { \"resource_id\": \"/system_object_definitions/**\", \"methods\": [\"get\", \"put\", \"patch\"], \"read_attributes\": \"(**)\", \"write_attributes\": \"(**)\" },\n { \"resource_id\": \"/custom_object_definitions/**\", \"methods\": [\"get\", \"put\", \"patch\"], \"read_attributes\": \"(**)\", \"write_attributes\": \"(**)\" },\n { \"resource_id\": \"/site_preferences/**\", \"methods\": [\"get\", \"patch\"], \"read_attributes\": \"(**)\", \"write_attributes\": \"(**)\" }\n ]\n}\n```\n\nNotes:\n\n- The `client_id` **must match** the Account Manager API client whose credentials you\n put in `dw.json` / `SFCC_*` below. Replace the value above with your own client id if\n it differs.\n- If the Data API settings are empty, wrap the entries in the standard settings\n envelope. Merge the resource lists from the block(s) above into one `resources`\n array — do not substitute a global `\"resource_id\": \"/**\"` grant:\n\n ```json\n {\n \"_v\": \"23.2\",\n \"clients\": [\n {\n \"client_id\": \"<your-client-id-here>\",\n \"resources\": [\n { \"resource_id\": \"/system_object_definitions\", \"methods\": [\"get\"], \"read_attributes\": \"(**)\", \"write_attributes\": \"(**)\" },\n { \"resource_id\": \"/system_object_definitions/**\", \"methods\": [\"get\", \"post\"], \"read_attributes\": \"(**)\", \"write_attributes\": \"(**)\" },\n { \"resource_id\": \"/site_preferences/**\", \"methods\": [\"get\", \"post\"], \"read_attributes\": \"(**)\", \"write_attributes\": \"(**)\" },\n { \"resource_id\": \"/custom_object_definitions/**\", \"methods\": [\"get\", \"post\"], \"read_attributes\": \"(**)\", \"write_attributes\": \"(**)\" }\n ]\n }\n ]\n }\n ```\n\n- `check_permissions` (below) prints a ready-to-paste grant JSON on a 401/403, so you can\n also let the tool tell you exactly what to add.\n\n## 2. Provide credentials locally\n\nCreate a `dw.json` in your project root (auto-added to git exclude — never commit it):\n\n```json\n{\n \"hostname\": \"zzzz-001.sandbox.us01.dx.commercecloud.salesforce.com\",\n \"client-id\": \"<your-client-id-here>\",\n \"client-secret\": \"<account-manager-client-secret>\"\n}\n```\n\nAccepted key spellings: `hostname`/`host`, `client-id`/`clientId`/`client_id`,\n`client-secret`/`clientSecret`/`client_secret`.
|
|
6
|
-
"docs/bridge-ticket-authoring.md": "# Bridge ticket-authoring posture\n\nBridge has several surfaces that can create a ticket. Without a shared posture\neach one behaves differently, and the most-used surface carries none of the\nmaintainer's preferences at all. This document is the deep reference behind the\nshort posture block that every one of those surfaces carries verbatim.\n\nThe block itself is short on purpose — it competes for attention inside prompts\nthat are already long. Everything that explains *why* lives here.\n\n## The canonical block\n\nThis file **is** the canonical source. The marker-delimited block below is\nduplicated byte-identically onto every carrier — every surface that decides\nticket shape holds these exact bytes, so no surface can quietly drift into its\nown house style.\n\nCarriers (all four hold the block verbatim):\n\n- `agents/src/jira-ticket-writer.md` — the writer itself, plus a compressed\n posture line in its `description:` frontmatter, which is the only coverage a\n bare-chat session gets with no file read and no `tools/list` cost.\n- `commands/src/define-tickets.md` — Stage 9, the most-used authoring surface.\n- `mcp_server/instructions/decompose-epic-candidate.md` — the `idea-to-ticket`\n decomposition step.\n- `mcp_server/instructions/decompose-epic.md` — the `plan-epic` decomposition\n step.\n\nEdit the block here, copy it verbatim to each carrier, and let\n`tests/pytest/mcp_server/test_ticket_authoring_posture_assets.py` prove it\nlanded. That test permits **no** per-surface variation.\n\n<!-- BEGIN BRIDGE TICKET-AUTHORING POSTURE -->\n<!-- Canonical source: docs/bridge-ticket-authoring.md.\n This block is duplicated byte-identically onto every carrier. Never edit a\n copy: edit the canonical source and re-copy it verbatim. A cross-surface\n byte-equality test fails the build if any copy drifts by a single byte. -->\n\n## Ticket-authoring posture\n\nDeep reference: `docs/bridge-ticket-authoring.md`.\n\n**Draft through the writer.** Every ticket body — an epic parent, an epic child,\nand an ordinary sibling alike — is drafted by the `jira-ticket-writer` agent\nbefore `create_ticket` is called. Do not compose a ticket description inline.\n\n**Size the work.** Size each ticket by file-touch breadth and depth plus rough\nlines of code (LOC) changed:\n\n- `S = 1-2 files / <~80 LOC`\n- `M = ~3-8 files / ~80-400 LOC`\n- `L = ~8-15 files / ~400-900 LOC`\n- `XL = >15 files / >~900 LOC`\n\nTarget size priority: **L (target) -> XL (when the work does not fit in L) -> M\n(third choice) -> S (only when unavoidable)**. This applies equally to a\nstandalone ticket and to an epic child.\n\nAim each slice at L. When one will not fit, grow it to XL rather than splitting\nit — split only when the slice is genuinely two independent pieces of work,\nnever merely to land inside a band. Bridge's grooming and implementation process\nhandles a large vertical slice well and is overkill on small ones: every extra\nticket is another worktree, another PR, another rebase, and another chance for\ntwo workers to touch the same file. Reach for M because the work genuinely is\nthat size, not to avoid an XL.\n\nBeyond roughly 40 files or ~3000 LOC, split anyway. Past that point review\nturnaround and rebase cost dominate the run's budget, and a review that wedges\nholds the gate to its full retry ceiling before anyone notices.\n\n**Group at three.** Three or more implementable tickets is an epic: propose an\nepic parent plus an ordered child manifest, and resolve this surface's own\napproval gate before anything is created. One or two tickets are ordinary\nsiblings — no epic parent, no manifest. The threshold is exactly three.\n\n**Hand off once.** An epic handoff names exactly one conductor entry point,\n`drive-epic`, which selects the runnable path itself. Never present a choice\nbetween conductors.\n\n**Departure is closed-list only.** These three exceptions, and no others, permit\ndeparting from the rules above. Invoking one requires no announcement.\n\n- **E1 External-tracker mirroring** — a recorded upstream identifier exists and\n its granularity is contractual. Bypasses sizing and the epic threshold.\n- **E2 Discovery-only spike** — no committed production-code deliverable.\n Bypasses sizing only; does not bypass drafting through the writer.\n- **E3 Authorized incident containment** — tied to an active incident record,\n not to schedule pressure. Bypasses sizing and the epic threshold.\n\nThe list is closed. Anything outside it is an escalation to the operator, not a\njudgement call. Explicitly refused as grounds for departure: a single-file\ntrivial fix (that is `S` reached through the normal path, not an exception),\ngeneric time pressure, \"already well specified\", \"faster without the writer\",\ndeveloper discretion, minor refactor, unattended mode, context limits, and \"hard\nto decompose\" (XL is the normal overflow, so that is the ordinary path and not a\ndeparture). Writer unavailability escalates; it never silently authorizes inline\ndrafting.\n\n<!-- END BRIDGE TICKET-AUTHORING POSTURE -->\n\nThe rest of this document is the rationale the block is deliberately too short to\ncarry.\n\n## Decision: Jira ticket authoring ships through the Jira Ticket Writer (BAPI-900)\n\nBridge ships two very different kinds of ticket-authoring surface, and customers\nneed to know which one they actually have.\n\n**Shipped customer surface.** A customer project gets the `jira-ticket-writer`\nagent — the same writer this posture requires every ticket body to go through —\nplus the agent-directed capability to revise an existing ticket's description.\nAsk your agent to draft a ticket with the Jira Ticket Writer, and ask your agent\nto update an existing ticket's description when it needs revising. Both reach a\ncustomer project because they are packaged: the writer through `AGENTS`\n(`mcp_server/src/agents.generated.ts`) and the description-update path through\nthe registered `update_ticket_description` / `request_ticket_update` MCP tools.\n\n**Repository-local workflows.** `.claude/commands/write-ticket.md` and\n`.claude/commands/update-ticket.md` are bridge-api's own repository-maintenance\ncommands. They are **not** scaffolded into a customer project by `--init`, have\nno `commands/src/` source, and have no generated Cursor or `mcp_server/`\nmirror — deliberately, not by omission. A customer asking their agent to run\nthe write-ticket or update-ticket slash command will not find either one,\nbecause neither ships.\n\n**Why (Option B, not a promotion to shipped status).** The Jira Ticket Writer is\nalready the packaged drafting surface this posture mandates, so shipping\n`write-ticket.md` as a second drafting entry point would duplicate it. More\nimportantly, `write-ticket.md` is today an autonomous, single-ticket, no-halt\npipeline (\"No human confirmation gates — run end-to-end\") with no decomposition\nstep and no approval gate — it cannot honor the \"group at three\" epic rule or\nthe epic approval gate this posture requires, because it was never built to\npropose an epic at all. Promoting it to a shipped surface without that redesign\nwould ship a customer-facing command that silently violates this file's own\nposture. Until that redesign happens, `write-ticket.md` and `update-ticket.md`\nstay repository-local, and every packaged surface directs customers to the Jira\nTicket Writer and to agent-directed description updates instead.\n\n\n## The four rules\n\n### 1. Draft through `jira-ticket-writer`\n\nEvery ticket body is drafted by the `jira-ticket-writer` agent before\n`create_ticket` is called — an epic parent, an epic child, and an ordinary\nsibling alike. Nothing composes a ticket description inline.\n\nThe writer is not a formatter. It runs a codebase-research pass first, so its\ntickets cite the files, functions, and extension points a change actually\ntouches. A description written inline skips that pass, and the difference shows\nup two steps later: plan generation and implementation both ground themselves in\nthe ticket body, so a body with no code references produces a plan with no code\nreferences.\n\n\"The ticket is already well specified\" is not a reason to skip the writer. A\nwell-specified *request* is the writer's input, not a substitute for its output.\n\n### 2. Size toward L\n\nSize each ticket by file-touch breadth and depth plus rough lines of code\nchanged:\n\n| Band | Files | LOC |\n| --- | --- | --- |\n| `S` | 1–2 | `<~80` |\n| `M` | ~3–8 | ~80–400 |\n| `L` | ~8–15 | ~400–900 |\n| `XL` | >15 | `>~900` |\n\nPriority: **L (target) → XL (when the work does not fit in L) → M (third choice)\n→ S (only when unavoidable)**.\n\nThe target is L because the Bridge implementation tooling works best on\nindependently implementable vertical slices. What matters as much as the target\nis the **direction you move when a slice misses it**: upward, not downward.\n\nA slice that will not fit in L becomes **one XL ticket**, not two L ones. Split\nonly when the slice is genuinely two independent pieces of work — never merely to\nland inside a band. Fragmenting a coherent slice to fit is the failure this\nladder exists to prevent: every extra ticket is another worktree, another PR,\nanother rebase, and another chance for two workers to touch the same file, and\nBridge's grooming process is overkill on small tickets. Fewer, larger slices\nspend less of the run's budget on coordination.\n\nThis applies equally to a standalone ticket and to an epic child. There is no\nsize ceiling on a child that a lone ticket does not also have.\n\n`M` is where you land when the work genuinely is three to eight files — not\nsomewhere to retreat to in order to avoid an XL. `S` is likewise not forbidden:\nit is simply what you reach when the work genuinely is one or two files. A\nsingle-file trivial fix is `S` arrived at through the normal path. It is not an\nexception to anything, and it does not license skipping the writer.\n\n**Beyond roughly 40 files or ~3000 LOC, split anyway.** XL is the preferred\noverflow, not an unbounded one. Past that point review turnaround and rebase cost\ndominate the run's budget, and a review that wedges holds the gate to its full\nretry ceiling before anyone notices. That is a real bound, not a preference — and\nit is high enough that reaching it means the work really is two things.\n\n### 3. Group at three\n\nThree or more implementable tickets is an epic. The surface proposes an epic\nparent plus an **ordered child manifest**, and resolves its own approval gate\nbefore anything is created.\n\nOne or two tickets are ordinary siblings: no epic parent, no manifest. The\nthreshold is exactly three — not \"several\", not \"a lot\".\n\nThe manifest carries, per child: the boundary of its scope, its size band,\n`depends_on` (hard prerequisites that must land first), `recommended_after` (soft\nsequencing preferences that are not blockers), and a one-line order rationale.\nHard prerequisites and soft sequencing stay strictly separate, because the\nrecommended implementation order is derived from them and conflating the two\nproduces a serialized order where a parallel one was available.\n\nApproval follows each surface's **existing** attended/unattended rule. Nothing\nhere introduces a new gate policy: `/define-tickets` requires an explicit\naffirmative because creation is irreversible, and the recipe path gates on the\npipeline's own auto-approval variable. What is *not* conditional is the grouping\nitself — an unattended run still produces the epic; only the gate's behavior\nvaries.\n\nDecomposition happens **once**. The pass that decides the split freezes the\nmanifest; body rendering then fans out one writer invocation per entry against\nthat frozen manifest. A rendering invocation may not re-split, merge, reorder,\nrenumber, or rescope. Two independent decisions about the same split disagree,\nand the disagreement surfaces as children that overlap or contradict their\nparent.\n\n### 4. Hand off to exactly one conductor\n\nAn epic handoff names exactly one conductor entry point: `drive-epic`.\n\nBridge currently has two conductors — the v2 server-side engine and the LLM\nconductor pilot — and a standing rule that they must never operate on the same\nepic, because two transition authorities on one epic wedge it permanently. Asking\na model to pick correctly every time is not a control. `drive-epic` makes the\nchoice structural instead: it reads conductor readiness and routes to the one\npath the project can actually run, so no prompt names either underlying conductor\nand no prompt can present both.\n\nTwo conductors is a transitional state. When one is eliminated, `drive-epic` is\nthe only thing that changes — no prompt, bundled doc, command mirror, or posture\ntest moves.\n\n## The closed exception list\n\nExactly three exceptions permit departing from the rules above. Invoking one\nrequires **no announcement** — the departure is silent by design, because a\nmandatory announcement would be one more instruction to drift from, and the cost\nof silence was weighed and accepted.\n\n| Id | Exception | Objective trigger | Bypasses |\n| --- | --- | --- | --- |\n| **E1** | External-tracker mirroring | A recorded upstream identifier exists and its granularity is contractual | Sizing and the epic threshold |\n| **E2** | Discovery-only spike | No committed production-code deliverable | Sizing only — **not** drafting through the writer |\n| **E3** | Authorized incident containment | Tied to an active incident record, not to schedule pressure | Sizing and the epic threshold |\n\nEach trigger is objective: an identifier that exists, a deliverable that is\nabsent, an incident record that is open. None of them is a judgement about how\nthe work feels.\n\n### The list is closed\n\nAnything outside the three rows above is an **escalation to the operator**, not a\njudgement call. The following are explicitly refused as grounds for departure:\n\n- a single-file trivial fix — that is `S` reached through the normal path;\n- generic time pressure;\n- \"the request is already well specified\";\n- \"it would be faster without the writer\";\n- developer discretion;\n- \"it's just a minor refactor\";\n- running unattended;\n- context limits;\n- \"this is hard to decompose\" — XL is the normal overflow, so that is the\n ordinary path and not a departure.\n\n**Writer unavailability escalates.** It never silently authorizes inline\ndrafting. A surface that cannot reach `jira-ticket-writer` stops and says so.\n\n## The spike ticket format (BAPI-986)\n\nA spike ticket defines a finding to be produced, not code to be written, so it\ngets its own body shape. This is a second **format**, not a fourth exception:\nthe writer still drafts it, the sizing ladder still applies, and E2 still governs\nwhether the posture's sizing rule is bypassed at all.\n\n### Who chooses, and on what\n\nThe run manifest's `scope` chooses, and it is resolved once, upstream, in\n`mcp_server/instructions/preflight-and-readiness.md`. The writer receives that\nvalue and never decides it. Only `scope: spike` selects the spike format.\n\nThe trigger is E2's exact objective condition — **no committed production-code\ndeliverable**. A deliverable that is absent, not a judgement about how the work\nfeels. Every other case produces the ordinary code-ticket format:\n\n- `scope: task` and `scope: epic_candidate`;\n- a missing scope value;\n- a malformed or unrecognized scope value;\n- a standalone writer invocation with no resolved spike scope;\n- any ambiguity.\n\nCode is the default **in code, not in prose**: it is what every unresolved path\nalready produces, so no one has to remember a rule to get it.\n\n### The five body sections\n\nA spike draft's substantive body is exactly these five, in order:\n\n1. `## Question` — the single question the investigation must answer.\n2. `## Scope` — the systems, code paths, data, and behavior in bounds.\n3. `## Out-of-scope` — what it will not examine, stated explicitly.\n4. `## What the findings must answer (the deliverable)` — names an inspectable\n findings artifact at a specific repository path, and states what that artifact\n must contain: the decisions it settles, the evidence it cites, the\n recommendations it makes, and the unresolved risks it records. This is the\n spike's analogue of Acceptance Criteria — a reviewer holds the finished\n artifact against it to tell whether the spike is done.\n5. `## Which related tickets consume the finding` — names real consumer tickets\n by key, or the literal `none yet`. Never an invented key.\n\nThose five are the spike-specific **body** sections. They are not the whole\ndraft. The following remain mandatory structural metadata, identical to a code\ndraft, and are not additional spike sections:\n\n- the `# [Title]` heading;\n- the execution-class marker line (below);\n- a `## Regression Completeness Notes` block when the gated regression pass\n applies;\n- the trailing `## Materials & Access` section, always last.\n\nThe code-ticket structure — Summary, Requirements, Acceptance Criteria,\nMaterials & Access — is unchanged, and a code draft carries no marker.\n\n### The execution-class marker\n\nA spike draft carries exactly one canonical marker line, alone on its own line,\nimmediately after the title and before `## Question`:\n\n```markdown\n# [Concise Title Describing the Investigation]\n<!-- bridge:execution-class=investigation -->\n\n## Question\n```\n\nIt appears **exactly once**, never in a code-format ticket, and never\nillustratively inside a generated ticket body — not in prose, not in a fence,\nnot in backticks. Duplicates do not reinforce it: a second occurrence makes the\ndescription ambiguous and the parser discards the whole thing, leaving no signal.\n\n**It renders as visible text.** Bridge converts the description from Markdown to\nAtlassian Document Format, and ADF has no comment node, so the marker becomes one\nvisible line in the Jira description rather than a hidden comment. The exact\ntoken survives conversion and stays parseable from the stored description, which\nis what it is for. The placement immediately after the title is therefore an\neditorial choice as much as a parsing one.\n\n**It is a weak hint.** One non-authoritative input alongside the existing weak\nJira issue-type signal. It never overrides the five-way ticket-type\nclassification and never bypasses a human gate. A classifier verdict that\ncontradicts it wins, and the disagreement is reported rather than reconciled.\n\nThe marker's shape lives in exactly one runtime place —\n`parse_execution_class_marker` in\n`src/python/llms/agents/planner_agent/ticket_evaluator/execution_class_marker_utils.py`,\nwhich imports the `code`/`investigation` vocabulary from BAPI-980's constants in\n`api/models/epic_run.py` rather than redeclaring it. The literal in this document\nand in `agents/src/jira-ticket-writer.md` is pinned against that runtime constant\nby test, because Markdown cannot import a Python value.\n\n### The marker survives to the ticket record\n\nThe single-ticket path creates the Jira issue from `slim_description`; the full\ndraft is only an attachment. A marker preserved solely in the attachment would\nleave the ticket record with no signal at all. Two rules close that:\n\n- `mcp_server/instructions/draft-and-critique.md` carries the title and marker\n into `slim_description` in their original order, exactly once, and exempts that\n one literal from the forbidden-raw-HTML hygiene rule that would otherwise strip\n it. A `task` draft has no exemption, and slimming must not synthesize a marker.\n- `mcp_server/instructions/upload-and-track.md` passes `slim_description`\n unchanged as `create_ticket`'s `description`, without stripping, reconstructing,\n relocating, duplicating, or validating the marker.\n\n`create_ticket` gains no execution-class parameter and the MCP tool schema is\nunchanged: the marker rides in `description` and nowhere else.\n\n### Post-creation marker loss is out of scope\n\nA later description rewrite can drop the marker. `ticket_store_lib.update_ticket`\nforwards a full replacement description and the Jira backend re-renders all of it\nthrough `render_adf`, so anything a rewrite omits is simply gone — there is no\nmerge. Preserving the marker across rewrites would mean auditing every\ndescription-rewriting surface, which is excluded here.\n\nThis is a named, owned gap rather than an unstated one: preservation belongs to\nthe downstream slice that enables investigation routing. No local design record\nnames that slice yet, so its ownership is recorded here as an unresolved\ndownstream discovery rather than assigned to an invented slice name.\n\n## Residual risks and their operational contracts\n\nFour limitations ship with the spike format. Each is stated as detection,\ncontainment, and escalation, because a residual-risk note without those three\nreads as coverage while providing none.\n\n### Incorrect E1/E2/E3 invocation\n\n- **Detection**: manual ticket review only. There is no log, counter, or report\n (see the accepted trade-off below).\n- **Containment**: the objective selection rule — any ambiguity produces a code\n ticket — plus the marker's non-authority over classification and every human\n gate.\n- **Escalation**: suspected misuse goes to the authoring-workflow owner.\n\n### Class observability does not cover departure invocation\n\nThe marker makes a spike's intended execution **class** observable. It does not\nmake E1/E2/E3 posture-departure **invocation** observable; that remains silent by\naccepted design, and the accepted trade-off below is unchanged by this slice.\n\n- **Detection**: none for invocation, by design. Ticket review is the only signal.\n- **Containment**: the closed exception list itself — anything outside those\n three rows is an escalation, not a judgement call.\n- **Escalation**: the authoring-workflow owner, as above.\n\n### Premature routing on the marker\n\nMarker-bearing tickets exist before any consumer does. Nothing routes on the\nmarker yet, and the guard for that is **structural, not a feature flag** — no\nsuch flag exists, and naming an imaginary control would be exactly the failure\nthe accepted trade-off below warns about.\n\n- **Detection**: the absence of any marker reader outside the parse/normalize\n helper and the disagreement observer. A static test pins that set, so the first\n premature consumer fails at review time.\n- **Containment**: BAPI-980 seeds every run node `execution_class = 'code'` and\n exposes no caller-controlled `investigation` override anywhere — not on the DAL\n seed signature, not on a Pydantic request model, not on an MCP input. No code\n path writes `investigation`.\n- **Escalation**: any proposal to consume the field in runtime conductor behavior\n goes to the Conductor owner before implementation, per BAPI-980's decision D10;\n any discovered marker-based routing is a release-blocking regression on that\n same path. Enabling investigation routing belongs to the downstream epic\n rollout owner, once the complete path and its human gate exist.\n\n### Marker/classifier disagreement\n\n- **Detection**: the reserved structured-log event\n `ticket_classification_event=execution_class_marker_disagreement`, emitted at\n warning level when an investigation marker meets a code-facing classifier\n verdict. Every `evaluate_ticket_type` entry point compares, so the signal\n covers the ordinary Bridge classification path and not only the estimator\n backfill; a cached verdict is not a classification and is not compared.\n Persistent or high-volume disagreement is surfaced by querying that reserved\n key through the existing logging/Sentry workflow.\n- **Containment**: the comparison is non-authoritative. The classifier verdict is\n persisted and returned exactly as produced, whether or not an event fires.\n- **Escalation**: the event is **diagnostic-only** and the Bridge platform team\n owns it operationally. No alert rule, threshold, or paging behavior ships with\n it; that is net-new work belonging to the slice that enables routing. The field\n and redaction contract lives in\n `docs/claude/jira-optional-ticket-storage.md`, not here.\n\n## Isolation binding for shared-state test support\n\nA ticket that builds or changes test support which resets shared state — a\nharness, a fixture, a reset helper, anything that truncates, drops, or\nreinitializes state another process or another run can also read or write —\nmust state its isolation binding as a requirement: which database, directory,\nor other shared resource the reset targets, and how the ticket's own\ndeliverable proves that target's identity before it destroys anything.\n\nThis doctrine exists because BAPI-1006 shipped a conductor integration-test\nharness with nothing in its ticket stating what the harness's destructive\nreset was bound to, and a v2 worker dispatched to build it truncated the\noperator's operational `bridgeapi` database (Architecture Miss 28). The\ncontainment-hazard classifier this repository runs at planning time\n(`api/library/github/workflow_planning_prediction.py`) can flag such a ticket\nfrom its text, but the flag is advisory — it surfaces the hazard before\ndispatch, it does not prevent a destructive worker on its own. Stating the\nisolation binding in the ticket itself is the durable requirement; treat this\nas an authoring-posture rule, not as runtime enforcement.\n\n## Accepted trade-off: silent departure is unobservable\n\nObservability was deliberately dropped when this posture was ratified. A model\nmay invoke E1, E2, or E3 without recording that it did, so posture drift is only\ndetectable through ticket quality — not through a log, a counter, or a report.\n\nThis is known and accepted. The alternative was another mandatory instruction on\nevery surface, and an instruction that is skipped silently is worse than one that\ndoes not exist: it reads as coverage while providing none.\n\n## Why duplication, not a shared include\n\nCommands, agents, instructions, and docs have four separate build paths in this\nrepository and no shared compiler. Introducing a generated include step to share\none block would mean a fifth build path, a placeholder that can go unresolved,\nand a failure mode where a carrier ships with the placeholder text still in it.\n\nMarker-delimited duplication plus one byte-equality test is the right mechanism\nat this scale. The test reads the canonical sources directly — never the\ngenerated command mirrors, whose byte-identity the command tests already cover —\nand permits **no** per-surface variation. Any drift, down to a single byte, fails.\n\n## A fresh install inherits this\n\nNo configuration step, no server call. The posture reaches a new project through\nthe packaged bundles that `--init` scaffolds:\n\n- `COMMANDS` (`mcp_server/src/commands.generated.ts`) — carries\n `commands/src/define-tickets.md`;\n- `AGENTS` (`mcp_server/src/agents.generated.ts`) — carries\n `agents/src/jira-ticket-writer.md`, including the compressed posture line in\n its `description:` frontmatter;\n- `INSTRUCTIONS` (`mcp_server/src/pipelines.generated.ts`) — carries the\n canonical source and both decomposition instructions;\n- `DOCS` (`mcp_server/src/docs.generated.ts`) — carries this document.\n\nThe compressed frontmatter line matters more than its size suggests: agent\ndescriptions land in every session's system prompt with no file read and no\n`tools/list` cost, so it is the entire bare-chat coverage story.\n\n## Worked examples\n\n**One ticket.** \"Add a `--json` flag to `doctor`.\" Two files and a test, ~90 LOC.\nThat is `M`. One ticket, drafted by the writer, no epic, no manifest, no\nconductor handoff.\n\n**Two tickets.** \"Add rate limiting to the LLM client, and surface the limit in\nthe config UI.\" Backend and frontend are independently implementable and land\nseparately: two ordinary siblings. Still no epic — the threshold is three.\n\n**Four tickets → an epic.** \"Make local ticket mode a first-class system.\"\nDecomposition freezes a parent plus four children, each `L`, with `depends_on`\nnaming the one child that must land first. The full manifest goes to the approval\ngate; on approval, four writer invocations render four bodies against their\nfrozen entries; creation follows `upload-epic-hierarchy.md`; the handoff names\n`drive-epic` and nothing else.\n\n**A child that outgrows `L`.** A proposed child comes out at 19 files. It ships\nas one `XL` child. Do not split it into two `L` children to make it fit — the\nslice is one coherent piece of work, and halving it buys a second worktree, a\nsecond PR, and a rebase between them in exchange for nothing. Split only if the\n19 files really are two independent deliverables.\n\n**Past the ceiling.** A proposed ticket comes out at 60 files and ~5000 LOC.\nThat is over the bound, so it splits — but into the largest coherent pieces\navailable, not into a swarm. Two `XL` tickets is the right answer here; six `M`\nones is not.\n"
|
|
5
|
+
"docs/install/sfcc-integration.md": "# Installing the SFCC Integration (OCAPI)\n\nBridge's Salesforce B2C Commerce (SFCC) tools give an AI coding agent read access to\na sandbox's object model, custom object definitions, and site preferences — plus a\nsmall set of sandbox-only writes — through the **OCAPI Data API**. This guide covers\nsetting up the OCAPI client that those tools authenticate against.\n\n> **Sandbox / local development only.** This integration is intended for a **developer\n> sandbox**, and that restriction is **enforced in code**: before any SFCC tool runs,\n> Bridge validates the hostname your credentials actually resolve to — from `dw.json`\n> or `SFCC_*` — against the sandbox forms listed below. An unrecognized host is refused\n> with a `403` (`error.code: \"TARGET_NOT_SANDBOX\"`) before any request leaves your\n> machine. The check reads the resolved hostname, never the `instance` tool argument,\n> so omitting `instance` or passing `\"sandbox\"` cannot bypass it.\n>\n> Accepted sandbox hostname forms:\n>\n> - `<realm>-<nnn>.sandbox.<region>.dx.commercecloud.salesforce.com`\n> - `<realm>-<nnn>.sandbox.dx.commercecloud.salesforce.com`\n> - `<realm>-<nnn>.dx.commercecloud.salesforce.com`\n>\n> Anything else — a `production-`/`staging-`/`development-` prefixed host, or any\n> `*.demandware.net` host — is rejected.\n>\n> Still do not configure the grants below on an instance that holds real data.\n> Credentials stay local (in `dw.json` or `SFCC_*` env vars) and are never sent to\n> Bridge.\n\nFor the full per-tool list and what each SFCC tool depends on, see\n[MCP Tool Integration Dependencies](./mcp-tool-integrations.md). For the tool reference\nand the `BRIDGE_MCP_PROFILE` gating, see the SFCC section of the\n[package README](../../README.md).\n\n## Prerequisites\n\n- A running SFCC **developer sandbox** and its hostname\n (e.g. `zzzz-001.sandbox.us01.dx.commercecloud.salesforce.com`).\n- An **Account Manager API client** — a `client-id` and `client-secret`. This is the\n OCAPI client the tools use to obtain an OAuth token. Create one in Account Manager\n (**API Client** → *Add API Client*) if you don't already have it, and note its\n `client_id`.\n- Business Manager access to the sandbox with permission to edit **Open Commerce API\n Settings**.\n\n## 1. Grant the OCAPI client access in Business Manager\n\nIn Business Manager for the sandbox:\n\n**Administration → Site Development → Open Commerce API Settings → Data API** tab.\n\nAdd the client entry below to the `clients` array of the Data API settings, then\n**Save**. It grants only the resource families and HTTP methods Bridge's SFCC tools\nactually call — not a global `/**` grant. `check_permissions` prints the same JSON on\na 401/403, split into the two blocks.\n\n**READ/SEARCH TOOL GRANTS** — required by the `sfcc` read tools. (`post` is OCAPI's\nconvention for its `*_search` endpoints, not a mutation.)\n\n```json\n{\n \"client_id\": \"<your-client-id-here>\",\n \"resources\": [\n { \"resource_id\": \"/system_object_definitions\", \"methods\": [\"get\"], \"read_attributes\": \"(**)\", \"write_attributes\": \"(**)\" },\n { \"resource_id\": \"/system_object_definitions/**\", \"methods\": [\"get\", \"post\"], \"read_attributes\": \"(**)\", \"write_attributes\": \"(**)\" },\n { \"resource_id\": \"/site_preferences/**\", \"methods\": [\"get\", \"post\"], \"read_attributes\": \"(**)\", \"write_attributes\": \"(**)\" },\n { \"resource_id\": \"/custom_object_definitions/**\", \"methods\": [\"get\", \"post\"], \"read_attributes\": \"(**)\", \"write_attributes\": \"(**)\" }\n ]\n}\n```\n\n**MUTATION GRANTS** — required **only if you enable `BRIDGE_MCP_PROFILE=sfcc-write`**,\nwhich registers the nine destructive write tools. These are shipped capabilities, not\nfuture work. No `delete` is granted, because no shipped write tool performs one; the\n`get` entries are needed for the If-Match ETag round trip that precedes each `PATCH`.\n\n```json\n{\n \"client_id\": \"<your-client-id-here>\",\n \"resources\": [\n { \"resource_id\": \"/system_object_definitions\", \"methods\": [\"get\"], \"read_attributes\": \"(**)\", \"write_attributes\": \"(**)\" },\n { \"resource_id\": \"/system_object_definitions/**\", \"methods\": [\"get\", \"put\", \"patch\"], \"read_attributes\": \"(**)\", \"write_attributes\": \"(**)\" },\n { \"resource_id\": \"/custom_object_definitions/**\", \"methods\": [\"get\", \"put\", \"patch\"], \"read_attributes\": \"(**)\", \"write_attributes\": \"(**)\" },\n { \"resource_id\": \"/site_preferences/**\", \"methods\": [\"get\", \"patch\"], \"read_attributes\": \"(**)\", \"write_attributes\": \"(**)\" }\n ]\n}\n```\n\nNotes:\n\n- The `client_id` **must match** the Account Manager API client whose credentials you\n put in `dw.json` / `SFCC_*` below. Replace the value above with your own client id if\n it differs.\n- If the Data API settings are empty, wrap the entries in the standard settings\n envelope. Merge the resource lists from the block(s) above into one `resources`\n array — do not substitute a global `\"resource_id\": \"/**\"` grant:\n\n ```json\n {\n \"_v\": \"23.2\",\n \"clients\": [\n {\n \"client_id\": \"<your-client-id-here>\",\n \"resources\": [\n { \"resource_id\": \"/system_object_definitions\", \"methods\": [\"get\"], \"read_attributes\": \"(**)\", \"write_attributes\": \"(**)\" },\n { \"resource_id\": \"/system_object_definitions/**\", \"methods\": [\"get\", \"post\"], \"read_attributes\": \"(**)\", \"write_attributes\": \"(**)\" },\n { \"resource_id\": \"/site_preferences/**\", \"methods\": [\"get\", \"post\"], \"read_attributes\": \"(**)\", \"write_attributes\": \"(**)\" },\n { \"resource_id\": \"/custom_object_definitions/**\", \"methods\": [\"get\", \"post\"], \"read_attributes\": \"(**)\", \"write_attributes\": \"(**)\" }\n ]\n }\n ]\n }\n ```\n\n- `check_permissions` (below) prints a ready-to-paste grant JSON on a 401/403, so you can\n also let the tool tell you exactly what to add.\n\n## 2. Provide credentials locally\n\nCreate a `dw.json` in your project root (auto-added to git exclude — never commit it):\n\n```json\n{\n \"hostname\": \"zzzz-001.sandbox.us01.dx.commercecloud.salesforce.com\",\n \"client-id\": \"<your-client-id-here>\",\n \"client-secret\": \"<account-manager-client-secret>\"\n}\n```\n\nAccepted key spellings: `hostname`/`host`, `client-id`/`clientId`/`client_id`,\n`client-secret`/`clientSecret`/`client_secret`. Use a single config — a multi-entry\n`configs[]` array is rejected outright, not worked around with an explicit `instance`\n(see the README's SFCC section for why). Alternatively, export\n`SFCC_HOSTNAME` / `SFCC_CLIENT_ID` / `SFCC_CLIENT_SECRET` in the MCP server environment.\n\n## 3. Set the repo `version` config field\n\nSet the repo's `version` config to your SFCC project type — one of\n`sfra | pwakit | sitegenesis | storefrontnext | hybrid`. The call-time gate reads this;\na non-SFCC value blocks the OCAPI tools (the eight reads, the nine writes, and\n`check_permissions`). It does not block `sfcc_setup_status` or `sfcc_log_query` — log\nquery has its own backend gate. Set it via your\nnormal config path, the `config_field` MCP tool (operation `update`, field `version`),\nor the `/teach-bridge` skill.\n\n## 4. Enable the SFCC tools\n\nNo SFCC tool is registered by default — a session on the default `core` profile has\nnone. Every SFCC tool sits behind **two independent profile groups**:\n\n| Group | Registers |\n|---|---|\n| `sfcc` | the two diagnostics (`sfcc_setup_status`, `check_permissions`), the 8 OCAPI read tools, and `sfcc_log_query` — read-only |\n| `sfcc-write` | the 9 destructive write tools |\n\nNeither implies the other. An `sfcc-write`-only session has no diagnostics, so it\ncannot run `check_permissions` to print the grant JSON; use `sfcc,sfcc-write` when\nyou need writes. Add what you need to `BRIDGE_MCP_PROFILE` in the MCP server\n`env` block (it is comma-separated), then **restart the MCP client**:\n\n```json\n\"env\": { \"BRIDGE_MCP_PROFILE\": \"sfcc\" }\n```\n\nFor reads plus writes, use `\"sfcc,sfcc-write\"`. `full` expands to every group and is\ntherefore write-capable.\n\n> **Migration.** `sfcc` used to register the nine write tools too. It no longer does.\n> If you were relying on SFCC writes through `BRIDGE_MCP_PROFILE=sfcc`, change it to\n> `BRIDGE_MCP_PROFILE=sfcc,sfcc-write`. `full` users keep write access and need no\n> change.\n\n## 5. Verify\n\nAsk your agent to run:\n\n1. `sfcc_setup_status` — expect all prerequisite checks ✓ (Bridge API key, repo name,\n `version` config, `dw.json` presence/uniqueness, AM/OCAPI token acquisition).\n2. `check_permissions` — probes OCAPI via `GET /system_object_definitions`. A 200 (with\n the OCAPI version) confirms the grant. On 401/403 it prints the exact grant JSON to\n paste back in step 1.\n\nRestart the MCP client after any credential, grant, or env change — a running session\ndoes not pick them up.\n\n## Notes\n\n- **WebDAV logs are separate.** `sfcc_log_query` authenticates with a Business Manager\n username + a 40-character **WebDAV access key** over HTTP Basic auth — *not* the OCAPI\n OAuth token configured here. `sfcc_setup_status` reports OCAPI (step 5) and WebDAV\n (step 6) independently; one can be green while the other is not.\n- **Writes are sandbox-only.** The write tools (attribute/preference create/update) target\n a developer sandbox and echo a paste-ready grant JSON on a 403.\n",
|
|
6
|
+
"docs/bridge-ticket-authoring.md": "# Bridge ticket-authoring posture\n\nBridge has several surfaces that can create a ticket. Without a shared posture\neach one behaves differently, and the most-used surface carries none of the\nmaintainer's preferences at all. This document is the deep reference behind the\nshort posture block that every one of those surfaces carries verbatim.\n\nThe block itself is short on purpose — it competes for attention inside prompts\nthat are already long. Everything that explains *why* lives here.\n\n## The canonical block\n\nThis file **is** the canonical source. The marker-delimited block below is\nduplicated byte-identically onto every carrier — every surface that decides\nticket shape holds these exact bytes, so no surface can quietly drift into its\nown house style.\n\nCarriers (all four hold the block verbatim):\n\n- `agents/src/jira-ticket-writer.md` — the writer itself, plus a compressed\n posture line in its `description:` frontmatter, which is the only coverage a\n bare-chat session gets with no file read and no `tools/list` cost.\n- `commands/src/define-tickets.md` — Stage 9, the most-used authoring surface.\n- `mcp_server/instructions/decompose-epic-candidate.md` — the `idea-to-ticket`\n decomposition step.\n- `mcp_server/instructions/decompose-epic.md` — the `plan-epic` decomposition\n step.\n\nEdit the block here, copy it verbatim to each carrier, and let\n`tests/pytest/mcp_server/test_ticket_authoring_posture_assets.py` prove it\nlanded. That test permits **no** per-surface variation.\n\n<!-- BEGIN BRIDGE TICKET-AUTHORING POSTURE -->\n<!-- Canonical source: docs/bridge-ticket-authoring.md.\n This block is duplicated byte-identically onto every carrier. Never edit a\n copy: edit the canonical source and re-copy it verbatim. A cross-surface\n byte-equality test fails the build if any copy drifts by a single byte. -->\n\n## Ticket-authoring posture\n\nDeep reference: `docs/bridge-ticket-authoring.md`.\n\n**Draft through the writer.** Every ticket body — an epic parent, an epic child,\nand an ordinary sibling alike — is drafted by the `jira-ticket-writer` agent\nbefore `create_ticket` is called. Do not compose a ticket description inline.\n\n**Size the work.** Size each ticket by file-touch breadth and depth plus rough\nlines of code (LOC) changed:\n\n- `S = 1-2 files / <~80 LOC`\n- `M = ~3-8 files / ~80-400 LOC`\n- `L = ~8-15 files / ~400-900 LOC`\n- `XL = >15 files / >~900 LOC`\n\nTarget size priority: **L (target) -> XL (when the work does not fit in L) -> M\n(third choice) -> S (only when unavoidable)**. This applies equally to a\nstandalone ticket and to an epic child.\n\nAim each slice at L. When one will not fit, grow it to XL rather than splitting\nit — split only when the slice is genuinely two independent pieces of work,\nnever merely to land inside a band. Bridge's grooming and implementation process\nhandles a large vertical slice well and is overkill on small ones: every extra\nticket is another worktree, another PR, another rebase, and another chance for\ntwo workers to touch the same file. Reach for M because the work genuinely is\nthat size, not to avoid an XL.\n\nBeyond roughly 40 files or ~3000 LOC, split anyway. Past that point review\nturnaround and rebase cost dominate the run's budget, and a review that wedges\nholds the gate to its full retry ceiling before anyone notices.\n\n**Group at three.** Three or more implementable tickets is an epic: propose an\nepic parent plus an ordered child manifest, and resolve this surface's own\napproval gate before anything is created. One or two tickets are ordinary\nsiblings — no epic parent, no manifest. The threshold is exactly three.\n\n**Hand off once.** An epic handoff names exactly one conductor entry point,\n`drive-epic`, which selects the runnable path itself. Never present a choice\nbetween conductors.\n\n**Departure is closed-list only.** These three exceptions, and no others, permit\ndeparting from the rules above. Invoking one requires no announcement.\n\n- **E1 External-tracker mirroring** — a recorded upstream identifier exists and\n its granularity is contractual. Bypasses sizing and the epic threshold.\n- **E2 Discovery-only spike** — no committed production-code deliverable.\n Bypasses sizing only; does not bypass drafting through the writer.\n- **E3 Authorized incident containment** — tied to an active incident record,\n not to schedule pressure. Bypasses sizing and the epic threshold.\n\nThe list is closed. Anything outside it is an escalation to the operator, not a\njudgement call. Explicitly refused as grounds for departure: a single-file\ntrivial fix (that is `S` reached through the normal path, not an exception),\ngeneric time pressure, \"already well specified\", \"faster without the writer\",\ndeveloper discretion, minor refactor, unattended mode, context limits, and \"hard\nto decompose\" (XL is the normal overflow, so that is the ordinary path and not a\ndeparture). Writer unavailability escalates; it never silently authorizes inline\ndrafting.\n\n<!-- END BRIDGE TICKET-AUTHORING POSTURE -->\n\nThe rest of this document is the rationale the block is deliberately too short to\ncarry.\n\n## Decision: Jira ticket authoring ships through the Jira Ticket Writer (BAPI-900)\n\nBridge ships two very different kinds of ticket-authoring surface, and customers\nneed to know which one they actually have.\n\n**Shipped customer surface.** A customer project gets the `jira-ticket-writer`\nagent — the same writer this posture requires every ticket body to go through —\nplus the agent-directed capability to revise an existing ticket's description.\nAsk your agent to draft a ticket with the Jira Ticket Writer, and ask your agent\nto update an existing ticket's description when it needs revising. Both reach a\ncustomer project because they are packaged: the writer through `AGENTS`\n(`mcp_server/src/agents.generated.ts`) and the description-update path through\nthe registered `update_ticket_description` / `request_ticket_update` MCP tools.\n\n**Repository-local workflows.** `.claude/commands/write-ticket.md` and\n`.claude/commands/update-ticket.md` are bridge-api's own repository-maintenance\ncommands. They are **not** scaffolded into a customer project by `--init`, have\nno `commands/src/` source, and have no generated Cursor or `mcp_server/`\nmirror — deliberately, not by omission. A customer asking their agent to run\nthe write-ticket or update-ticket slash command will not find either one,\nbecause neither ships.\n\n**Why (Option B, not a promotion to shipped status).** The Jira Ticket Writer is\nalready the packaged drafting surface this posture mandates, so shipping\n`write-ticket.md` as a second drafting entry point would duplicate it. More\nimportantly, `write-ticket.md` is today an autonomous, single-ticket, no-halt\npipeline (\"No human confirmation gates — run end-to-end\") with no decomposition\nstep and no approval gate — it cannot honor the \"group at three\" epic rule or\nthe epic approval gate this posture requires, because it was never built to\npropose an epic at all. Promoting it to a shipped surface without that redesign\nwould ship a customer-facing command that silently violates this file's own\nposture. Until that redesign happens, `write-ticket.md` and `update-ticket.md`\nstay repository-local, and every packaged surface directs customers to the Jira\nTicket Writer and to agent-directed description updates instead.\n\n\n## The four rules\n\n### 1. Draft through `jira-ticket-writer`\n\nEvery ticket body is drafted by the `jira-ticket-writer` agent before\n`create_ticket` is called — an epic parent, an epic child, and an ordinary\nsibling alike. Nothing composes a ticket description inline.\n\nThe writer is not a formatter. It runs a codebase-research pass first, so its\ntickets cite the files, functions, and extension points a change actually\ntouches. A description written inline skips that pass, and the difference shows\nup two steps later: plan generation and implementation both ground themselves in\nthe ticket body, so a body with no code references produces a plan with no code\nreferences.\n\n\"The ticket is already well specified\" is not a reason to skip the writer. A\nwell-specified *request* is the writer's input, not a substitute for its output.\n\n### 2. Size toward L\n\nSize each ticket by file-touch breadth and depth plus rough lines of code\nchanged:\n\n| Band | Files | LOC |\n| --- | --- | --- |\n| `S` | 1–2 | `<~80` |\n| `M` | ~3–8 | ~80–400 |\n| `L` | ~8–15 | ~400–900 |\n| `XL` | >15 | `>~900` |\n\nPriority: **L (target) → XL (when the work does not fit in L) → M (third choice)\n→ S (only when unavoidable)**.\n\nThe target is L because the Bridge implementation tooling works best on\nindependently implementable vertical slices. What matters as much as the target\nis the **direction you move when a slice misses it**: upward, not downward.\n\nA slice that will not fit in L becomes **one XL ticket**, not two L ones. Split\nonly when the slice is genuinely two independent pieces of work — never merely to\nland inside a band. Fragmenting a coherent slice to fit is the failure this\nladder exists to prevent: every extra ticket is another worktree, another PR,\nanother rebase, and another chance for two workers to touch the same file, and\nBridge's grooming process is overkill on small tickets. Fewer, larger slices\nspend less of the run's budget on coordination.\n\nThis applies equally to a standalone ticket and to an epic child. There is no\nsize ceiling on a child that a lone ticket does not also have.\n\n`M` is where you land when the work genuinely is three to eight files — not\nsomewhere to retreat to in order to avoid an XL. `S` is likewise not forbidden:\nit is simply what you reach when the work genuinely is one or two files. A\nsingle-file trivial fix is `S` arrived at through the normal path. It is not an\nexception to anything, and it does not license skipping the writer.\n\n**Beyond roughly 40 files or ~3000 LOC, split anyway.** XL is the preferred\noverflow, not an unbounded one. Past that point review turnaround and rebase cost\ndominate the run's budget, and a review that wedges holds the gate to its full\nretry ceiling before anyone notices. That is a real bound, not a preference — and\nit is high enough that reaching it means the work really is two things.\n\n### 3. Group at three\n\nThree or more implementable tickets is an epic. The surface proposes an epic\nparent plus an **ordered child manifest**, and resolves its own approval gate\nbefore anything is created.\n\nOne or two tickets are ordinary siblings: no epic parent, no manifest. The\nthreshold is exactly three — not \"several\", not \"a lot\".\n\nThe manifest carries, per child: the boundary of its scope, its size band,\n`depends_on` (hard prerequisites that must land first), `recommended_after` (soft\nsequencing preferences that are not blockers), and a one-line order rationale.\nHard prerequisites and soft sequencing stay strictly separate, because the\nrecommended implementation order is derived from them and conflating the two\nproduces a serialized order where a parallel one was available.\n\nApproval follows each surface's **existing** attended/unattended rule. Nothing\nhere introduces a new gate policy: `/define-tickets` requires an explicit\naffirmative because creation is irreversible, and the recipe path gates on the\npipeline's own auto-approval variable. What is *not* conditional is the grouping\nitself — an unattended run still produces the epic; only the gate's behavior\nvaries.\n\nDecomposition happens **once**. The pass that decides the split freezes the\nmanifest; body rendering then fans out one writer invocation per entry against\nthat frozen manifest. A rendering invocation may not re-split, merge, reorder,\nrenumber, or rescope. Two independent decisions about the same split disagree,\nand the disagreement surfaces as children that overlap or contradict their\nparent.\n\n### 4. Hand off to exactly one conductor\n\nAn epic handoff names exactly one conductor entry point: `drive-epic`.\n\nBridge currently has two conductors — the v2 server-side engine and the LLM\nconductor pilot — and a standing rule that they must never operate on the same\nepic, because two transition authorities on one epic wedge it permanently. Asking\na model to pick correctly every time is not a control. `drive-epic` makes the\nchoice structural instead: it reads conductor readiness and routes to the one\npath the project can actually run, so no prompt names either underlying conductor\nand no prompt can present both.\n\nTwo conductors is a transitional state. When one is eliminated, `drive-epic` is\nthe only thing that changes — no prompt, bundled doc, command mirror, or posture\ntest moves.\n\n## Epic coherence check before creation\n\nBefore an epic's tickets are created or its plan approved, its children are\nchecked **as a set** against the epic's own acceptance criteria. The check asks\nwhether every epic criterion has a child that carries out its verification, and\nwhether each cross-child hand-off is owned at both ends. It runs through one\nshared procedure, [`review-epic-coherence.md`](../mcp_server/instructions/review-epic-coherence.md),\nwhich writes `epic-coherence.json` (the record) and `epic-coherence.md` (a short\nsummary) beside the frozen manifest.\n\n**Where it runs.** Three call sites run the check:\n\n- `/define-tickets` Stage 9 — after the epic split is frozen, before the outline\n and the `(y/N)` gate.\n- `idea-to-ticket` (attended, `--auto`, and inside `/idea-to-pr`) — in the Epic\n path of `upload-and-track.md`, after `decomposition-plan.json` and before\n rendering and the external approval gate.\n- `plan-epic` — in `decompose-epic.md`, after the plan artifacts are written and\n before the decomposition is presented for approval.\n\nEvery decomposition pass fills in each child's `owns_verifications`: which epic\ncriterion it proves, and the concrete part of that criterion's verification it\ncarries out. When a criterion is proven by an owner-run step a person runs\noutside the conductor — a release-checklist step, say — the pass declares a\n`non_child_owners` entry naming who runs it, the step, its verbatim text, and\nwhere the result is recorded, instead of forcing a child to own it. Owner-run\nowners count toward coverage only; hand-offs stay child-owned.\n\n**The render preflight.** `render-ticket-manifest.md` refuses to render an epic\nunless the record exists beside the manifest, all three of its digests\n(`manifest_sha256`, `child_evidence_sha256`, and `non_child_owners_sha256`) match\nwhat is being rendered, those digests equal the last reviewer round's, and\nits verdict is `pass`, `accepted_with_gaps`, or `not_checked` with a recorded\nbypass. A missing record, a mismatch, `blocked`, or an un-bypassed `not_checked`\nstops the flow before any writer runs or any ticket is created. `/define-tickets`\nstates the same rule in its own creation step.\n\n**Attended runs: fix or accept.** Each remaining blocking finding is either\nfixed — the manifest is amended, re-frozen, and checked again — or accepted with\na typed reason, which is recorded and turns the verdict into `accepted_with_gaps`.\nWhen the reviewer cannot run, the verdict is `not_checked`. The operator can\nretry, or bypass with a typed reason. A bypass is recorded, and the verdict stays\n`not_checked`; it is never shown as a pass.\n\n**Unattended runs: the risk-scaled round limit, then halt.** An unattended\n`idea-to-ticket` run amends and re-checks within the procedure's risk-scaled\nround limit: at most 2 reviewer runs for a low-risk epic and 3 for a high-risk\none. If a blocking finding remains, it halts with `blocked` before any ticket is\ncreated. A fix made after the last round gets one confirmation pass. An unavailable reviewer, or a check\nthat could not run independently, halts with `not_checked`.\n\nUnattended runs have no bypass; an operator who needs one reruns attended.\n\n**Siblings skip it.** A one- or two-ticket outcome runs no check, writes no\nrecord, and costs nothing extra. The residual risk — a pair that really needed a\nset-level check — is contained by the existing manifest-identity and\nwriter-draft gates. If the work is really epic-shaped, regroup it as an epic\nbefore creation. `plan-epic` is the one exception: the epic already exists, so it\nchecks even a one- or two-sub-task decomposition.\n\n**What lands in the tickets.** Each epic child carries its obligations verbatim\nas acceptance criteria. The epic parent carries a `## Epic coverage map`\nsection: the verdict, one bullet per epic criterion naming its owning child and\nobligation, and any accepted findings or bypasses with their reasons.\n\n## The closed exception list\n\nExactly three exceptions permit departing from the rules above. Invoking one\nrequires **no announcement** — the departure is silent by design, because a\nmandatory announcement would be one more instruction to drift from, and the cost\nof silence was weighed and accepted.\n\n| Id | Exception | Objective trigger | Bypasses |\n| --- | --- | --- | --- |\n| **E1** | External-tracker mirroring | A recorded upstream identifier exists and its granularity is contractual | Sizing and the epic threshold |\n| **E2** | Discovery-only spike | No committed production-code deliverable | Sizing only — **not** drafting through the writer |\n| **E3** | Authorized incident containment | Tied to an active incident record, not to schedule pressure | Sizing and the epic threshold |\n\nEach trigger is objective: an identifier that exists, a deliverable that is\nabsent, an incident record that is open. None of them is a judgement about how\nthe work feels.\n\n### The list is closed\n\nAnything outside the three rows above is an **escalation to the operator**, not a\njudgement call. The following are explicitly refused as grounds for departure:\n\n- a single-file trivial fix — that is `S` reached through the normal path;\n- generic time pressure;\n- \"the request is already well specified\";\n- \"it would be faster without the writer\";\n- developer discretion;\n- \"it's just a minor refactor\";\n- running unattended;\n- context limits;\n- \"this is hard to decompose\" — XL is the normal overflow, so that is the\n ordinary path and not a departure.\n\n**Writer unavailability escalates.** It never silently authorizes inline\ndrafting. A surface that cannot reach `jira-ticket-writer` stops and says so.\n\n## The spike ticket format (BAPI-986)\n\nA spike ticket defines a finding to be produced, not code to be written, so it\ngets its own body shape. This is a second **format**, not a fourth exception:\nthe writer still drafts it, the sizing ladder still applies, and E2 still governs\nwhether the posture's sizing rule is bypassed at all.\n\n### Who chooses, and on what\n\nThe run manifest's `scope` chooses, and it is resolved once, upstream, in\n`mcp_server/instructions/preflight-and-readiness.md`. The writer receives that\nvalue and never decides it. Only `scope: spike` selects the spike format.\n\nThe trigger is E2's exact objective condition — **no committed production-code\ndeliverable**. A deliverable that is absent, not a judgement about how the work\nfeels. Every other case produces the ordinary code-ticket format:\n\n- `scope: task` and `scope: epic_candidate`;\n- a missing scope value;\n- a malformed or unrecognized scope value;\n- a standalone writer invocation with no resolved spike scope;\n- any ambiguity.\n\nCode is the default **in code, not in prose**: it is what every unresolved path\nalready produces, so no one has to remember a rule to get it.\n\n### The five body sections\n\nA spike draft's substantive body is exactly these five, in order:\n\n1. `## Question` — the single question the investigation must answer.\n2. `## Scope` — the systems, code paths, data, and behavior in bounds.\n3. `## Out-of-scope` — what it will not examine, stated explicitly.\n4. `## What the findings must answer (the deliverable)` — names an inspectable\n findings artifact at a specific repository path, and states what that artifact\n must contain: the decisions it settles, the evidence it cites, the\n recommendations it makes, and the unresolved risks it records. This is the\n spike's analogue of Acceptance Criteria — a reviewer holds the finished\n artifact against it to tell whether the spike is done.\n5. `## Which related tickets consume the finding` — names real consumer tickets\n by key, or the literal `none yet`. Never an invented key.\n\nThose five are the spike-specific **body** sections. They are not the whole\ndraft. The following remain mandatory structural metadata, identical to a code\ndraft, and are not additional spike sections:\n\n- the `# [Title]` heading;\n- the execution-class marker line (below);\n- a `## Regression Completeness Notes` block when the gated regression pass\n applies;\n- the trailing `## Materials & Access` section, always last.\n\nThe code-ticket structure — Summary, Requirements, Acceptance Criteria,\nMaterials & Access — is unchanged, and a code draft carries no marker.\n\n### The execution-class marker\n\nA spike draft carries exactly one canonical marker line, alone on its own line,\nimmediately after the title and before `## Question`:\n\n```markdown\n# [Concise Title Describing the Investigation]\n<!-- bridge:execution-class=investigation -->\n\n## Question\n```\n\nIt appears **exactly once**, never in a code-format ticket, and never\nillustratively inside a generated ticket body — not in prose, not in a fence,\nnot in backticks. Duplicates do not reinforce it: a second occurrence makes the\ndescription ambiguous and the parser discards the whole thing, leaving no signal.\n\n**It renders as visible text.** Bridge converts the description from Markdown to\nAtlassian Document Format, and ADF has no comment node, so the marker becomes one\nvisible line in the Jira description rather than a hidden comment. The exact\ntoken survives conversion and stays parseable from the stored description, which\nis what it is for. The placement immediately after the title is therefore an\neditorial choice as much as a parsing one.\n\n**It is a weak hint.** One non-authoritative input alongside the existing weak\nJira issue-type signal. It never overrides the five-way ticket-type\nclassification and never bypasses a human gate. A classifier verdict that\ncontradicts it wins, and the disagreement is reported rather than reconciled.\n\nThe marker's shape lives in exactly one runtime place —\n`parse_execution_class_marker` in\n`src/python/llms/agents/planner_agent/ticket_evaluator/execution_class_marker_utils.py`,\nwhich imports the `code`/`investigation` vocabulary from BAPI-980's constants in\n`api/models/epic_run.py` rather than redeclaring it. The literal in this document\nand in `agents/src/jira-ticket-writer.md` is pinned against that runtime constant\nby test, because Markdown cannot import a Python value.\n\n### The marker survives to the ticket record\n\nThe single-ticket path creates the Jira issue from `slim_description`; the full\ndraft is only an attachment. A marker preserved solely in the attachment would\nleave the ticket record with no signal at all. Two rules close that:\n\n- `mcp_server/instructions/draft-and-critique.md` carries the title and marker\n into `slim_description` in their original order, exactly once, and exempts that\n one literal from the forbidden-raw-HTML hygiene rule that would otherwise strip\n it. A `task` draft has no exemption, and slimming must not synthesize a marker.\n- `mcp_server/instructions/upload-and-track.md` passes `slim_description`\n unchanged as `create_ticket`'s `description`, without stripping, reconstructing,\n relocating, duplicating, or validating the marker.\n\n`create_ticket` gains no execution-class parameter and the MCP tool schema is\nunchanged: the marker rides in `description` and nowhere else.\n\n### Post-creation marker loss is out of scope\n\nA later description rewrite can drop the marker. `ticket_store_lib.update_ticket`\nforwards a full replacement description and the Jira backend re-renders all of it\nthrough `render_adf`, so anything a rewrite omits is simply gone — there is no\nmerge. Preserving the marker across rewrites would mean auditing every\ndescription-rewriting surface, which is excluded here.\n\nThis is a named, owned gap rather than an unstated one: preservation belongs to\nthe downstream slice that enables investigation routing. No local design record\nnames that slice yet, so its ownership is recorded here as an unresolved\ndownstream discovery rather than assigned to an invented slice name.\n\n## Residual risks and their operational contracts\n\nFour limitations ship with the spike format. Each is stated as detection,\ncontainment, and escalation, because a residual-risk note without those three\nreads as coverage while providing none.\n\n### Incorrect E1/E2/E3 invocation\n\n- **Detection**: manual ticket review only. There is no log, counter, or report\n (see the accepted trade-off below).\n- **Containment**: the objective selection rule — any ambiguity produces a code\n ticket — plus the marker's non-authority over classification and every human\n gate.\n- **Escalation**: suspected misuse goes to the authoring-workflow owner.\n\n### Class observability does not cover departure invocation\n\nThe marker makes a spike's intended execution **class** observable. It does not\nmake E1/E2/E3 posture-departure **invocation** observable; that remains silent by\naccepted design, and the accepted trade-off below is unchanged by this slice.\n\n- **Detection**: none for invocation, by design. Ticket review is the only signal.\n- **Containment**: the closed exception list itself — anything outside those\n three rows is an escalation, not a judgement call.\n- **Escalation**: the authoring-workflow owner, as above.\n\n### Premature routing on the marker\n\nMarker-bearing tickets exist before any consumer does. Nothing routes on the\nmarker yet, and the guard for that is **structural, not a feature flag** — no\nsuch flag exists, and naming an imaginary control would be exactly the failure\nthe accepted trade-off below warns about.\n\n- **Detection**: the absence of any marker reader outside the parse/normalize\n helper and the disagreement observer. A static test pins that set, so the first\n premature consumer fails at review time.\n- **Containment**: BAPI-980 seeds every run node `execution_class = 'code'` and\n exposes no caller-controlled `investigation` override anywhere — not on the DAL\n seed signature, not on a Pydantic request model, not on an MCP input. No code\n path writes `investigation`.\n- **Escalation**: any proposal to consume the field in runtime conductor behavior\n goes to the Conductor owner before implementation, per BAPI-980's decision D10;\n any discovered marker-based routing is a release-blocking regression on that\n same path. Enabling investigation routing belongs to the downstream epic\n rollout owner, once the complete path and its human gate exist.\n\n### Marker/classifier disagreement\n\n- **Detection**: the reserved structured-log event\n `ticket_classification_event=execution_class_marker_disagreement`, emitted at\n warning level when an investigation marker meets a code-facing classifier\n verdict. Every `evaluate_ticket_type` entry point compares, so the signal\n covers the ordinary Bridge classification path and not only the estimator\n backfill; a cached verdict is not a classification and is not compared.\n Persistent or high-volume disagreement is surfaced by querying that reserved\n key through the existing logging/Sentry workflow.\n- **Containment**: the comparison is non-authoritative. The classifier verdict is\n persisted and returned exactly as produced, whether or not an event fires.\n- **Escalation**: the event is **diagnostic-only** and the Bridge platform team\n owns it operationally. No alert rule, threshold, or paging behavior ships with\n it; that is net-new work belonging to the slice that enables routing. The field\n and redaction contract lives in\n `docs/claude/jira-optional-ticket-storage.md`, not here.\n\n## Isolation binding for shared-state test support\n\nA ticket that builds or changes test support which resets shared state — a\nharness, a fixture, a reset helper, anything that truncates, drops, or\nreinitializes state another process or another run can also read or write —\nmust state its isolation binding as a requirement: which database, directory,\nor other shared resource the reset targets, and how the ticket's own\ndeliverable proves that target's identity before it destroys anything.\n\nThis doctrine exists because BAPI-1006 shipped a conductor integration-test\nharness with nothing in its ticket stating what the harness's destructive\nreset was bound to, and a v2 worker dispatched to build it truncated the\noperator's operational `bridgeapi` database (Architecture Miss 28). The\ncontainment-hazard classifier this repository runs at planning time\n(`api/library/github/workflow_planning_prediction.py`) can flag such a ticket\nfrom its text, but the flag is advisory — it surfaces the hazard before\ndispatch, it does not prevent a destructive worker on its own. Stating the\nisolation binding in the ticket itself is the durable requirement; treat this\nas an authoring-posture rule, not as runtime enforcement.\n\n## Accepted trade-off: silent departure is unobservable\n\nObservability was deliberately dropped when this posture was ratified. A model\nmay invoke E1, E2, or E3 without recording that it did, so posture drift is only\ndetectable through ticket quality — not through a log, a counter, or a report.\n\nThis is known and accepted. The alternative was another mandatory instruction on\nevery surface, and an instruction that is skipped silently is worse than one that\ndoes not exist: it reads as coverage while providing none.\n\n## Why duplication, not a shared include\n\nCommands, agents, instructions, and docs have four separate build paths in this\nrepository and no shared compiler. Introducing a generated include step to share\none block would mean a fifth build path, a placeholder that can go unresolved,\nand a failure mode where a carrier ships with the placeholder text still in it.\n\nMarker-delimited duplication plus one byte-equality test is the right mechanism\nat this scale. The test reads the canonical sources directly — never the\ngenerated command mirrors, whose byte-identity the command tests already cover —\nand permits **no** per-surface variation. Any drift, down to a single byte, fails.\n\n## A fresh install inherits this\n\nNo configuration step, no server call. The posture reaches a new project through\nthe packaged bundles that `--init` scaffolds:\n\n- `COMMANDS` (`mcp_server/src/commands.generated.ts`) — carries\n `commands/src/define-tickets.md`;\n- `AGENTS` (`mcp_server/src/agents.generated.ts`) — carries\n `agents/src/jira-ticket-writer.md`, including the compressed posture line in\n its `description:` frontmatter;\n- `INSTRUCTIONS` (`mcp_server/src/pipelines.generated.ts`) — carries the\n canonical source and both decomposition instructions;\n- `DOCS` (`mcp_server/src/docs.generated.ts`) — carries this document.\n\nThe compressed frontmatter line matters more than its size suggests: agent\ndescriptions land in every session's system prompt with no file read and no\n`tools/list` cost, so it is the entire bare-chat coverage story.\n\n## Worked examples\n\n**One ticket.** \"Add a `--json` flag to `doctor`.\" Two files and a test, ~90 LOC.\nThat is `M`. One ticket, drafted by the writer, no epic, no manifest, no\nconductor handoff.\n\n**Two tickets.** \"Add rate limiting to the LLM client, and surface the limit in\nthe config UI.\" Backend and frontend are independently implementable and land\nseparately: two ordinary siblings. Still no epic — the threshold is three.\n\n**Four tickets → an epic.** \"Make local ticket mode a first-class system.\"\nDecomposition freezes a parent plus four children, each `L`, with `depends_on`\nnaming the one child that must land first. The full manifest goes to the approval\ngate; on approval, four writer invocations render four bodies against their\nfrozen entries; creation follows `upload-epic-hierarchy.md`; the handoff names\n`drive-epic` and nothing else.\n\n**A child that outgrows `L`.** A proposed child comes out at 19 files. It ships\nas one `XL` child. Do not split it into two `L` children to make it fit — the\nslice is one coherent piece of work, and halving it buys a second worktree, a\nsecond PR, and a rebase between them in exchange for nothing. Split only if the\n19 files really are two independent deliverables.\n\n**Past the ceiling.** A proposed ticket comes out at 60 files and ~5000 LOC.\nThat is over the bound, so it splits — but into the largest coherent pieces\navailable, not into a swarm. Two `XL` tickets is the right answer here; six `M`\nones is not.\n",
|
|
7
|
+
"docs/install/review-epic-coherence-procedure.md": "# Review Epic Coherence\n\nThis is the shared procedure for checking an epic's children **as a set**. It answers two\nquestions no per-ticket review asks: does every epic acceptance criterion have a child that\ncarries out its verification, and is everything one child produces wired to whatever consumes\nit? Drafting surfaces and the on-demand `/review-epic-coherence` command run this same text.\n\nThe check fails **visibly**. A run that cannot finish is `not_checked`. It is never `pass`.\n\n**Enforcement status.** The three drafting surfaces — `define-tickets`, `plan-epic`, and\n`idea-to-ticket` — call this procedure in drafting mode before creation or approval, and\n`render-ticket-manifest.md` refuses to render an epic without a clearing record. A\nreport-mode result from the on-demand command is a diagnostic, not a gate: it clears nothing.\n\n## Inputs\n\nState these four values before starting:\n\n1. **Input document path** — the path to `epic-coherence-input.json`.\n2. **Output directory** — a directory beneath the `docs_dir` that the `ping` tool returned.\n3. **Mode** — `drafting` or `report`.\n4. **Unattended** — true only when `auto_approve_external == \"true\"`. Otherwise the run is\n attended.\n\nIf any of the four is missing, stop and report which one. Do not guess a default.\n\n## The input document\n\nThe document carries artifacts only. It never carries the drafting conversation.\n\n```json\n{\n \"epic\": {\n \"key\": \"EPIC-1\",\n \"title\": \"Short epic title\",\n \"acceptance_criteria\": [\n { \"id\": \"AC-1\", \"text\": \"What must be true\", \"verification\": \"How it is proven\" }\n ]\n },\n \"design_text\": \"Goals and design text: the exploration's Proposed Design, the epic parent body, or equivalent.\",\n \"manifest\": [\n {\n \"id\": \"1\",\n \"title\": \"Child title\",\n \"scope\": \"What the child does\",\n \"size_band\": \"L\",\n \"depends_on\": [],\n \"recommended_after\": [],\n \"touched_files\": [\"path/relative/to/repo.py\"],\n \"read_files\": [\"path/the/child/only/reads.py\"],\n \"owns_verifications\": [\n { \"epic_ac\": \"AC-1\", \"obligation\": \"The concrete part of AC-1's verification this child carries out\" }\n ]\n }\n ],\n \"child_evidence\": [\n {\n \"id\": \"1\",\n \"acceptance_criteria\": [\"Each acceptance criterion of the child, verbatim\"],\n \"body\": \"The child ticket body, if available\"\n }\n ],\n \"non_child_owners\": [\n {\n \"id\": \"OR-1\",\n \"kind\": \"owner_run\",\n \"who\": \"Release owner\",\n \"step_ref\": \"Release checklist step 6\",\n \"step_text\": \"Release checklist step 6: the release owner runs the smoke test against production and posts the output as a comment on the epic.\",\n \"records_result_in\": \"a comment on the epic\",\n \"owns_verifications\": [\n { \"epic_ac\": \"AC-2\", \"obligation\": \"Run the production smoke test and post its output on the epic\" }\n ]\n }\n ]\n}\n```\n\nField rules:\n\n- `epic` carries either `key` or `slug` (one is enough), plus `title` and\n `acceptance_criteria`. Each acceptance criterion has `id`, `text`, and `verification`. When\n an epic AC has no verification sentence, coverage is judged against its text, the basis is\n `text_only`, and the reviewer raises an advisory input finding naming the missing sentence.\n- `design_text` is the goals and design text.\n- `manifest` is the **complete, ordered** child list. Each entry carries `id` (a placeholder\n index or a real ticket key), `title`, `scope`, `size_band`, `depends_on`, and\n `recommended_after`. These are the same field names `decompose-epic.md` and\n `decompose-epic-candidate.md` already use.\n- `touched_files` is optional. It lists the files the child **edits or creates**. When absent,\n the fit check uses the file paths the child's scope and body name. A `touched_files` path that\n does not exist yet can be a planned creation; that alone is not a problem.\n- `read_files` is optional. It lists files the child **only reads**. It lives in the manifest,\n so it is hashed. Reads inform the fit check. Only edits (`touched_files`) count toward edit\n overlap between children and toward the high-risk path check in \"Escalation rule\". A path\n must not appear in both lists. A `read_files` path that does not exist is an `input` problem,\n because a child cannot read a file that is not there. When `read_files` is absent, behavior is\n unchanged.\n- `owns_verifications` is optional. It is a list of entries with `epic_ac` (an epic AC id) and\n `obligation` (the concrete part of that AC's *verification* this child will carry out, in\n words a reviewer can hold against the verification sentence). It is a **claim** the reviewer\n checks. It is never proof by itself. When it is absent (older epics, the on-demand path), the\n reviewer derives candidate owners from each child's own acceptance criteria, and the record\n says `owns_verifications_source: derived`. When it is present, the record says `declared`.\n- `child_evidence` is a **separate top-level array**, keyed by child `id`. Each entry may carry\n `acceptance_criteria` and `body`. It lives **outside** the hashed manifest, so evidence can be\n refreshed without changing manifest identity. Derived ownership counts only when a child's\n acceptance criteria contain a concrete commitment to the obligation. When the material needed\n to establish ownership is absent, that is an explicit `input` gap, not coverage.\n- `non_child_owners` is an optional **top-level array** beside `child_evidence`. It names the\n owners of epic AC verifications that no child carries out, such as a step in an owner-run\n release checklist. Each entry has:\n - `id` — for example `OR-1`. It is unique across the array and never equal to any child `id`.\n - `kind` — a closed vocabulary with one value: `owner_run`.\n - `who` — a named person or role, for example \"Release owner\".\n - `step_ref` — the step it points at, for example \"Release checklist step 6\".\n - `step_text` — the step's text, copied **verbatim** from `design_text`.\n - `records_result_in` — where the result is recorded, for example \"a comment on the epic\".\n - `owns_verifications` — a list of `epic_ac` plus `obligation` entries, the same shape\n children use.\n\n `step_text` is copied into the entry on purpose. `design_text` is not hashed, so a step that\n lived only there could change without changing the review's identity. The copied, hashed\n `step_text` is the reviewed commitment. An owner-run owner owns **coverage only**: it never\n fills a hand-off grid cell. When the array is absent, no AC has a non-child owner.\n\n**Local markdown drafts.** When an epic is drafted as local markdown files outside a drafting\nsurface, build this document with the packaged `epic-coherence-input build` subcommand of the\nBridge MCP package: `epic-coherence-input build --outline <outline-path> --out <output-path>`.\nDo not assemble it by hand. The outline names the epic draft, each child's draft, its\ndependencies, size band, `edits` (which become `touched_files`), `reads` (which become\n`read_files`), and `owns_verifications`, plus any `non_child_owners`. Every epic AC bullet in the\nepic draft must start with an explicit id such as `AC-3:`; the builder never numbers ACs by\nposition or matches them by keyword. `epic-coherence-input check <input-path>` validates an\nexisting document against the structural rules in \"Validation\" and prints the three digests. It\nnever judges coverage; that stays the reviewer's job. The three drafting surfaces keep their\nstructured normalization, and the on-demand `/review-epic-coherence` command keeps building its\ninput from ticket data.\n\n## Identities\n\nThree digests identify what was reviewed. All three use the same canonical JSON encoding.\n\n- `manifest_sha256` is the SHA-256 hex digest of\n `json.dumps(manifest, sort_keys=True, separators=(\",\", \":\"), ensure_ascii=False).encode(\"utf-8\")`,\n computed over the `manifest` array only. Compute it locally with this one line:\n\n ```bash\n python3 -c 'import hashlib,json,sys; manifest=json.load(open(sys.argv[1], encoding=\"utf-8\"))[\"manifest\"]; print(hashlib.sha256(json.dumps(manifest, sort_keys=True, separators=(\",\", \":\"), ensure_ascii=False).encode(\"utf-8\")).hexdigest())' <input-path>\n ```\n\n- `child_evidence_sha256` is the SHA-256 hex digest of the same encoding applied to the\n `child_evidence` array (an absent array hashes as an empty array).\n- `non_child_owners_sha256` is the SHA-256 hex digest of the same encoding applied to the\n `non_child_owners` array. An absent array hashes as an empty array, as `child_evidence`\n does. Compute it locally with this one line:\n\n ```bash\n python3 -c 'import hashlib,json,sys; owners=json.load(open(sys.argv[1], encoding=\"utf-8\")).get(\"non_child_owners\", []); print(hashlib.sha256(json.dumps(owners, sort_keys=True, separators=(\",\", \":\"), ensure_ascii=False).encode(\"utf-8\")).hexdigest())' <input-path>\n ```\n\nRecord **all three** digests, at the top level and in every round. A caller that wants to\nreuse a prior review must compare **all three** identities against the manifest, evidence,\nand non-child owners it is about to use. A matching manifest with changed evidence or changed\nowners is not the same review. The sibling integration's preflight must compare all three.\n\n`design_text` deliberately stays **outside** identity. The copied and hashed `step_text` is\nthe reviewed commitment of an owner-run step. There is no fourth digest, and no render-time\ncheck that `design_text` still contains the step.\n\n## Validation\n\nBefore any reviewer run, validate the input document. Every problem becomes a visible `input`\nfinding. Nothing is silently dropped.\n\n- Child ids are unique. Epic AC ids are unique. Every `owns_verifications.epic_ac` names a real\n epic AC, and every `child_evidence.id` names a real manifest child.\n- The document shapes and the key or slug syntax are valid.\n- Every `non_child_owners` entry is well formed. Its `id` is unique across the array and never\n collides with a child id. Its `kind` is `owner_run`. Its `who`, `step_ref`, `step_text`, and\n `records_result_in` are non-empty. Every one of its `owns_verifications.epic_ac` values names\n a real epic AC. A malformed entry, a colliding id, an invalid AC reference, and a missing\n required field are each a visible `input` finding.\n- Every named file path is repository-relative. Reject absolute paths and any path that\n traverses upward. A path listed in both `touched_files` and `read_files` of the same child is\n an `input` finding.\n- The output directory is beneath the `docs_dir` that `ping` resolved. Refuse to write anywhere\n else.\n- A missing, invalid, or unreadable named file is an `input` finding. So is inaccessible child\n material and a missing set of epic acceptance criteria. A nonexistent `touched_files` path can\n be a planned creation and is not, by itself, a finding. A nonexistent `read_files` path is an\n `input` finding.\n- A missing verification sentence alone is **advisory**. Any problem that prevents a meaningful\n review (no epic acceptance criteria, an empty manifest, an unreadable input document) makes\n the verdict `not_checked`. It never produces a complete-looking coverage map.\n\nDescribe variable paths in words or angle brackets, such as `<output-directory>`. Do not write\nany literal brace-wrapped identifier other than `docs_dir`, including in examples.\n\n## Reviewer run\n\nInvoke the `epic-coherence-reviewer` agent in a **fresh context**. Pass it only the input\ndocument path. Run it **once per round over the whole frozen manifest** — never per child and\nnever over a subset. The reviewer must not receive the drafting conversation.\n\nResolve the agent the way `draft-ticket.md` resolves `jira-ticket-writer`: through the Task tool\nor a host equivalent you have confirmed can resolve it. Cursor has no agent mirror for this\nagent, so on Cursor resolution normally fails.\n\n**Fresh-context fallback.** If no fresh context can be obtained, read the agent file\n`agents/src/epic-coherence-reviewer.md` (or its installed mirror) and execute its methodology\ninline. Set `independent: false` in the record and say so in the report. An inline run is never\na silent independent pass.\n\n- In an **attended** run, offer a fresh-context rerun when one becomes available.\n- In an **unattended drafting** run, an inline `pass` is not the independent gate. Halt.\n\n## Escalation rule\n\nEscalate to a council **only** when at least one of these is true:\n\n1. Any blocking finding has `confidence: uncertain`.\n2. The caller **disputes** a blocking finding instead of amending it. The caller is the drafting\n agent in drafting mode and the operator in report mode.\n3. The epic is **high risk**.\n\nHigh risk means the epic has **six or more children**, or any child's `touched_files` falls\nunder one of these paths:\n\n- `db/migrations/` and `db/alembic/` (the design says `db/migrations/`; this repository's\n migrations live in `db/alembic/`, so match both)\n- `api/library/billing/`\n- `api/routes/setup/auth.py`\n- `api/library/auth/`\n- Epic Implementer enforcement code — every prefix in `_CONTAINMENT_HAZARD_PATHS` in\n `api/library/github/workflow_planning_prediction.py`:\n `mcp_server/src/executor/`, `mcp_server/src/agent-launchers/`,\n `mcp_server/src/claude-settings.ts`, `.github/workflows/`,\n `tests/integration/conductor_harness/`, `api/library/db/`, and `db/alembic/`\n\nOnly edits count. A path a child lists in `read_files` never makes the epic high risk, even\nunder one of these prefixes, so a child that only reads `api/library/db/` does not trigger\nthis rule.\n\nWhen `touched_files` is absent for a child, apply the same path check to the concrete paths its\nscope and body name. When a child's file ownership is unknown, record **uncertainty**. Do not\ndeclare the epic low risk.\n\n**Classify the risk before round 1.** Decide the initial risk tier from the input alone,\nbefore the first reviewer run, using the child count and the edit paths. The tier is `high`\nwhen this rule matches, and also when unknown file ownership leaves the question open. It is\n`low` otherwise. Record it as `risk_tier` with its `risk_reasons`, for example \"Child 1 edits\n`api/library/db/`\". Trigger 3 therefore fires **before round 1**. Triggers 1 and 2 still fire\nafter any later round.\n\nAn uncompleted required escalation leaves the result unresolved. It is never a quiet pass.\n\n## Council call\n\nBefore **every** billable council request, state:\n\n- the cost: **26–65 credits and about 15 minutes** (26 credits for standard models, 65 credits\n for frontier models; state the applicable tier if providers are pinned). The source is\n `api/library/billing/pricing.py`;\n- the escalation reason (which of the three triggers fired);\n- that council output cannot itself clear a blocker.\n\nAn **attended** run asks the operator to approve before proceeding. An **unattended** run states\nthe cost in its output and proceeds. This holds for every request, including a `mode: general`\nretry.\n\n**When the council starts.**\n\n- **High-risk trigger.** For an epic classified high risk before round 1, state the cost and,\n when attended, get the operator's approval **before** round 1 starts. Then request the\n council and start the round-1 reviewer run **in parallel**. Do not wait for a later round.\n- **Uncertain or disputed trigger.** Request the council after the round that raised the\n finding.\n- **How many.** One council per drafting run for the initial high-risk trigger. A later\n qualifying trigger (an uncertain or disputed blocking finding) may start **at most one more**\n council, with its own cost statement and approval.\n\nCall `request_council` with:\n\n- `mode`: `technical`\n- `wait_for_result`: `false`\n- no `repo_name`\n- task text containing **only** the input document's artifacts and the contested findings.\n The early high-risk council has no reviewer findings yet, so its task text holds **only** the\n input document's artifacts. Never invent findings for it. Ask it to look for cross-child and\n release-level risks, such as concurrent writers, migration and rollback order, and rollout\n that runs ahead of the code.\n\nThen poll `get_council` for a bounded period. If technical mode cannot run because the\nrepository is not indexed, repeat the request with `mode: general`, and state the cost again\nbefore that request too.\n\n**The amendment freeze.** The round-1 amendment freezes at the moment the caller begins writing\nthe amended input document after collecting the round-1 findings. Poll `get_council` while the\nround-1 reviewer runs. Council conclusions received before the freeze join that **same**\namendment pass. Conclusions received after it join the next pass. A frozen round is never\nchanged after the fact.\n\nCouncil conclusions join the finding list as **separate** findings with `source: council`. The\noriginal reviewer finding is kept unchanged. It is never edited, downgraded, or removed because\na council failed, timed out, is still running, left the dispute unresolved, or concluded.\nRecord the `council_id` and the council outcome. Record still-running and failed outcomes as\nunresolved.\n\n**An unfinished required council.** A required council that is `still_running`, `failed`, or\n`timed_out` when the last round or confirmation pass ends is unresolved. The verdict is never\n`pass`. An **attended** operator, after being shown the council's id, cost, and elapsed time,\nmay accept it with a typed override of kind `accept` that names its `council_id`. An\n**unattended** run records `blocked` and halts before any ticket is created.\n\n## Drafting mode\n\nDrafting mode is for a drafting surface that can still change the manifest.\n\n- **Amend and recheck.** The reviewer only describes amendments. The **caller** amends the\n manifest (adds or rescopes children), re-freezes it, and writes a **new** input document. The\n procedure then reruns the reviewer in a fresh context. Record each round with its own\n `manifest_sha256`, `child_evidence_sha256`, and `non_child_owners_sha256`, blocking and\n advisory counts, whether a council ran, and whether it was a confirmation pass.\n- **Risk-scaled round limit.** The number of ordinary reviewer runs, `round_limit`, depends on\n the risk tier from \"Escalation rule\":\n - **Low risk** (the epic is not high risk and no blocking finding is `uncertain`):\n `round_limit` is **2**. Run one round, and one recheck only when blocking findings remain.\n That is at most **2 reviewer runs**.\n - **High risk**: `round_limit` is **3**. Allow at most **2 re-checks**, which is\n **3 reviewer runs in total**.\n - **Promotion.** A low-risk epic whose round produces a blocking finding with\n `confidence: uncertain` becomes high risk from that point. It gets the high-risk limit, and\n trigger 1 fires.\n\n Record the final `risk_tier`, `risk_reasons`, and `round_limit`. A confirmation pass is not an\n ordinary run and does not count toward `round_limit`.\n- **Confirmation pass.** When the caller changes the input after the last allowed ordinary\n round, run **one confirmation pass**. It is a fresh-context reviewer run over the **whole**\n amended manifest, never a subset. Its requested focus is narrower: the amended children, the\n hand-offs they touch, and whether the findings the amendment targeted are closed. It must\n still report **any** blocking finding it observes anywhere in the manifest; the narrower\n focus never suppresses one. When it cannot establish where an amendment's impact ends, it\n raises that as a blocking finding with `confidence: uncertain` instead of calling the\n amendment confirmed. Record it in `rounds[]` with `\"confirmation\": true`.\n - A confirmation pass **never** starts another automatic amendment loop. A new blocking\n finding goes to attended fix-or-accept, or to the unattended halt.\n - In an **attended** run, the operator may direct a fix of a confirmation blocker. Then run\n another whole-manifest confirmation pass, so the last round bears the final digests. A typed\n acceptance stays available instead.\n- **Final identity.** The top-level `manifest_sha256`, `child_evidence_sha256`, and\n `non_child_owners_sha256` equal the digests of the **last** entry in `rounds[]`. A record\n whose top-level digests no round saw does not clear. The sole exception is a confirmation\n pass that cannot run: an **attended** operator may record `amended_after_final_round: true`\n with an override of kind `bypass` carrying a typed reason. The verdict is then\n `not_checked`, never `pass` or `accepted_with_gaps`, and the top-level digests still describe\n the amended input. An **unattended** run halts instead.\n- **Attended resolution.** After the bound, each remaining blocking finding must be fixed or\n accepted with a typed reason. An accepted finding is an override with `kind: accept`, plus\n `finding_id`, `reason`, `accepted_by`, and `round`. Declining keeps the verdict `blocked`.\n When **every** remaining blocking finding is accepted, the verdict is `accepted_with_gaps`.\n- **Unattended halt.** If any blocking finding remains after the bound, the verdict is\n `blocked`. Return an explicit halt signal: **do not call `create_ticket`**. The caller must\n stop.\n\n## When the review cannot run\n\nIf the reviewer cannot run (a tool error, a timeout, or a host that lacks the capability while\ninline execution also fails), or the material prevents a meaningful review, the verdict is\n`not_checked`. It is never `pass`.\n\n- **Attended:** offer a retry, or a bypass with a typed reason. A bypass is recorded as an\n override with `kind: bypass`. The verdict stays `not_checked`.\n- **Unattended:** halt.\n\n## Report mode\n\nReport mode is diagnostic. It runs the reviewer **once**. There is no amendment loop and no halt\nsignal. Escalation still applies, with the cost stated and confirmation asked. The verdict is\n`pass`, `blocked`, or `not_checked`.\n\nA `blocked` or `not_checked` report is **diagnostic and not a clearance**.\n\n## The record: epic-coherence.json\n\nWrite `epic-coherence.json` into the output directory:\n\n```json\n{\n \"schema_version\": 2,\n \"checked_at\": \"2026-01-01T00:00:00Z\",\n \"mode\": \"drafting\",\n \"unattended\": false,\n \"manifest_sha256\": \"<64 hex characters, or null>\",\n \"child_evidence_sha256\": \"<64 hex characters, or null>\",\n \"non_child_owners_sha256\": \"<64 hex characters, or null>\",\n \"owns_verifications_source\": \"declared\",\n \"verdict\": \"pass\",\n \"independent\": true,\n \"risk_tier\": \"low\",\n \"risk_reasons\": [\"Three children; no child edits a high-risk path\"],\n \"round_limit\": 2,\n \"amended_after_final_round\": false,\n \"rounds\": [\n {\n \"manifest_sha256\": \"<64 hex characters>\",\n \"child_evidence_sha256\": \"<64 hex characters>\",\n \"non_child_owners_sha256\": \"<64 hex characters>\",\n \"blocking_count\": 0,\n \"advisory_count\": 0,\n \"council_ran\": false,\n \"confirmation\": false\n }\n ],\n \"owner_run_acs\": [\"AC-2\"],\n \"coverage_map\": [\n {\n \"epic_ac\": \"AC-1\",\n \"judgment_basis\": \"verification\",\n \"status\": \"covered\",\n \"owners\": [\n {\n \"owner_kind\": \"child\",\n \"child\": \"1\",\n \"obligation\": \"Concrete obligation\",\n \"child_ac\": \"The child AC id or a quoted child AC\",\n \"source\": \"declared\"\n }\n ]\n },\n {\n \"epic_ac\": \"AC-2\",\n \"judgment_basis\": \"verification\",\n \"status\": \"covered\",\n \"owners\": [\n {\n \"owner_kind\": \"owner_run\",\n \"child\": null,\n \"owner\": \"OR-1\",\n \"who\": \"Release owner\",\n \"step_ref\": \"Release checklist step 6\",\n \"records_result_in\": \"a comment on the epic\",\n \"obligation\": \"Run the production smoke test and post its output on the epic\",\n \"source\": \"declared\"\n }\n ]\n }\n ],\n \"handoff_grid\": [\n {\n \"thing\": \"The stored field, endpoint, flag, event, job payload, or scope\",\n \"consumer\": \"The consuming piece\",\n \"write_path\": \"child id or null\",\n \"read_path\": \"child id or null\",\n \"caller\": \"child id or null\",\n \"start\": \"child id or null\",\n \"steady_state\": \"child id or null\",\n \"wind_down\": \"child id or null\"\n }\n ],\n \"findings\": [\n {\n \"id\": \"F-1\",\n \"kind\": \"coverage\",\n \"severity\": \"blocking\",\n \"confidence\": \"certain\",\n \"concerns\": \"AC-1\",\n \"evidence\": \"What was observed, with file and line where code was read\",\n \"smallest_amendment\": \"The smallest change that would close it\",\n \"source\": \"reviewer\"\n }\n ],\n \"overrides\": [\n { \"kind\": \"accept\", \"finding_id\": \"F-1\", \"reason\": \"Typed reason\", \"accepted_by\": \"Operator\", \"round\": 3 }\n ],\n \"council_id\": null,\n \"council_outcome\": \"not_run\",\n \"councils\": []\n}\n```\n\nRules:\n\n- `schema_version` is `2`. A reader also accepts a version `1` record: it has no\n `non_child_owners_sha256`, no owner-run owners, and no confirmation rounds, so it describes\n an input with no `non_child_owners`.\n- `verdict` is one of `pass`, `accepted_with_gaps`, `blocked`, `not_checked`.\n- `pass` requires **zero unresolved blocking findings**. A `pass` with `independent: false` is\n allowed but flagged prominently in both files.\n- An `accept` override accepts a known gap. A `bypass` override skips a review that could not\n run. Keep the two distinct.\n- `kind` on a finding is one of `coverage`, `handoff`, `fit`, `e2e_proof`, `input`.\n `severity` is `blocking` or `advisory`. `confidence` is `certain` or `uncertain`. `source`\n is `reviewer` or `council`.\n- Digests may be `null` **only** when unreadable input makes computing them impossible. Then\n add an explicit `input` finding and set the verdict to `not_checked`.\n- The top-level digests equal the last round's digests. The only record allowed to differ is\n an attended one with `amended_after_final_round: true`, a `bypass` override with a typed\n reason, and verdict `not_checked` (see \"Drafting mode\").\n- `rounds[].confirmation` is `true` only for a confirmation pass. `risk_tier` is `low` or\n `high`, `risk_reasons` lists why, and `round_limit` is the ordinary-run limit that applied\n (`2` or `3`; report mode runs once).\n- Each coverage owner carries `owner_kind`, which is `child` or `owner_run`. A child owner\n carries `child`, `obligation`, `child_ac`, and `source`. An owner-run owner carries\n `child: null`, `owner` (its `non_child_owners` id), `who`, `step_ref`, `records_result_in`,\n `obligation`, and `source: declared`.\n- `owner_run_acs` lists the id of every epic AC with at least one owner-run owner. It is empty\n when there are none. Owner-run coverage is always visible, never silently passed.\n- `council_id` is `null` when no council ran. `council_outcome` is one of `not_run`,\n `concluded`, `failed`, `timed_out`, or `still_running`. These two fields describe the first\n council. When a second council runs, `councils` lists **every** council in order, each with\n `council_id`, `trigger` (`uncertain`, `disputed`, or `high_risk`), and `outcome`. An override\n that accepts an unfinished council carries `council_id` in place of `finding_id`.\n- Unknown fields, such as a historical `council_note`, are outside this schema. Readers ignore\n them. They never authorize clearance.\n- A `not_checked` record must **never** carry a coverage map that looks complete. Leave the map\n empty, or mark every entry as not assessed.\n- Keep this schema in this file. Do not copy it into the ticket-authoring posture block.\n\n## The record: epic-coherence.md\n\nWrite `epic-coherence.md` into the same directory as a short human summary. Use **no tables**.\nIn this order:\n\n1. The **verdict**, as the very first line of the file (after the title heading). Nothing else comes\n before it.\n2. **Independent: yes** or **Independent: no**, prominently, on the line directly after the\n verdict, then the **next action**.\n3. The round count, the risk tier, and the round limit. Say which round, if any, was a\n confirmation pass.\n4. Directly after the round count, one line: \"Owner-run coverage: N of M epic ACs depend on\n steps a person runs outside the conductor.\"\n5. One **bullet per epic AC**: its id, the judgment basis (`verification` or `text only`), the\n status, the owning child or the absence of one, the obligation, and the cited child AC\n evidence. Mark derived ownership as derived. For an owner-run owner, say \"owner-run\" in\n words, with the person or role, the step reference, and where the result is recorded, for\n example: AC-4: covered, owner-run (Release owner, checklist step 5; result recorded in an\n epic comment).\n6. **Blocking findings**, each labelled `blocking` with its `certain` or `uncertain` label.\n Write each hand-off gap as a sentence naming the shared thing, the affected consumer, the\n missing lifecycle end, and the smallest amendment.\n7. **Advisory and input findings.**\n8. **Council state.**\n9. **Overrides**, each with its typed reason.\n\nState every meaning in words, never by color alone.\n\nIn both files:\n\n- Label a report-mode `blocked` or `not_checked` result as **diagnostic and not a clearance**.\n- In report mode, state that the result gates no drafting surface: each drafting surface runs\n its own drafting-mode check before creation.\n- Put `independent: false` at the top, directly after the verdict line, and offer an attended\n fresh-context rerun.\n\n## Writing the records safely\n\n- Render both files to temporary files first. Replace the real files from the temporary files\n where the host supports it. Both files must carry the same run identity (`checked_at` and\n all three final digests), and both describe the same final round.\n- Report a write failure explicitly. A write failure is an **incomplete review**.\n- When a newer attempt fails or is incomplete, **invalidate or remove** any older successful\n artifact in the output directory. Never leave an older `pass` beside a newer failed outcome.\n An incomplete newer attempt must not leave an older clearing record in place.\n\n## Return\n\nReport to the caller:\n\n- the verdict and whether the run was independent;\n- the next action;\n- the paths of `epic-coherence.json` and `epic-coherence.md`;\n- for drafting mode, the halt signal (`do not call create_ticket`) when one applies, and the\n amendments the caller must make before the next round.\n\nDo not describe a `blocked` or `not_checked` report-mode result as a clearance.\n"
|
|
7
8
|
};
|