Breakpoints tools (Pro)
Feedback captured on a screen of the running product and bound to requirements. This group has 12 tools, all of them available only with spec-editor Pro.
| Tool | Edition | Summary |
|---|---|---|
breakpoint_bind_candidates |
Pro | Ranked fallback candidates for binding a breakpoint’s about relationship: route/title/text/entity signals, noisy-OR combined, threshold 0.5 for ‘suggested’. |
breakpoint_binding_stats |
Pro | Coverage metric over every breakpoint’s about binding: exact/confirmed/pending/declared_missing counts, share_exact, and a per-screen breakdown — shows which… |
breakpoint_change_state |
Pro | Change one breakpoint’s lifecycle_state — active|obsolete — the reversible ‘Mark obsolete’ / ‘Restore’ pair. |
breakpoint_chat |
Pro | Converse with the Formulator (requirement mode) about one breakpoint. |
breakpoint_confirm_binding |
Pro | Confirm or reject binding candidate(s) as a breakpoint’s about target(s). |
breakpoint_formulate |
Pro | Finalise the latest chat draft for one breakpoint into its own content/attributes (dialogue_status=‘formulated’) and leave it draft for the analysis team to… |
breakpoint_get |
Pro | Get one breakpoint’s full detail: attributes, capture history, lifecycle, its parsed data snapshot, a screenshot URL (/assets/<sha>), bound elements (about),… |
breakpoint_remove |
Pro | Remove one breakpoint from the pipeline board — the only operation that takes a breakpoint off it. |
breakpoint_replay |
Pro | Build (read-only, not persisted) a Playwright replay bundle for one breakpoint: a check spec navigating to its captured screen/element, a demo… |
breakpoint_set_lifecycle |
Pro | Move a breakpoint’s lifecycle to active (restore), obsolete (mark obsolete — stays on record, leaves the inbox) or removed (detach from the board — the record… |
breakpoint_transcript |
Pro | The parsed dialogue transcript (‘## Dialogue’ turns) for one breakpoint. |
breakpoints_list |
Pro | List breakpoint breakpoints (owner-captured UI feedback), newest first. |
breakpoint_bind_candidates
Pro tool. Available with the spec-editor Pro plugin.
Ranked fallback candidates for binding a breakpoint’s about relationship: route/title/text/entity signals, noisy-OR combined, threshold 0.5 for ‘suggested’. Also reports declared-but-missing spec-ids (the product marked up an id the spec doesn’t have yet).
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | yes | Breakpoint id. |
project_path |
string | yes | Path to spec-editor project (directory with methodology.yaml) |
breakpoint_binding_stats
Pro tool. Available with the spec-editor Pro plugin.
Coverage metric over every breakpoint’s about binding: exact/confirmed/pending/declared_missing counts, share_exact, and a per-screen breakdown — shows which screens still need data-spec-id markup.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
project_path |
string | yes | Path to spec-editor project (directory with methodology.yaml) |
breakpoint_change_state
Pro tool. Available with the spec-editor Pro plugin.
Change one breakpoint’s lifecycle_state — active|obsolete — the reversible ‘Mark obsolete’ / ‘Restore’ pair. A state change and nothing else: the captured context, screenshot, dialogue transcript, binding candidates and occurrence history are all left intact, and the id keeps resolving afterwards. Cannot remove a breakpoint (that is breakpoint_remove). WRITE tool, human-only (agents/policies are rejected, like breakpoint_confirm_binding).
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
by |
string | no | Decider identity, e.g. ‘human:web’ (default ‘human:mcp’) |
id |
string | yes | Breakpoint id. |
lifecycle_state |
string, one of active, obsolete |
yes | Target state (active|obsolete); active is the state every breakpoint is captured with. |
project_path |
string | yes | Path to spec-editor project (directory with methodology.yaml) |
breakpoint_chat
Pro tool. Available with the spec-editor Pro plugin.
Converse with the Formulator (requirement mode) about one breakpoint. WRITE tool – appends to the breakpoint’s dialogue transcript. Never writes new requirement/change elements itself; call breakpoint_formulate (human-only) to commit a draft.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
by |
string | no | Speaker identity, e.g. ‘human:vscode’ (default ‘human:mcp’). |
id |
string | yes | Breakpoint id. |
message |
string | yes | The owner’s message. |
project_path |
string | yes | Path to spec-editor project (directory with methodology.yaml) |
breakpoint_confirm_binding
Pro tool. Available with the spec-editor Pro plugin.
Confirm or reject binding candidate(s) as a breakpoint’s about target(s). WRITE tool, human-only (agents/policies are rejected with an error, exactly like gate_decide).
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
by |
string | no | Decider identity, e.g. ‘human:vscode’ (default ‘human:mcp’) |
decision |
string | no | ‘confirm’ (default) or ‘reject’. |
element_ids |
array of string | yes | Target element id(s) to confirm/reject. |
id |
string | yes | Breakpoint id. |
project_path |
string | yes | Path to spec-editor project (directory with methodology.yaml) |
breakpoint_formulate
Pro tool. Available with the spec-editor Pro plugin.
Finalise the latest chat draft for one breakpoint into its own content/attributes (dialogue_status=‘formulated’) and leave it draft for the analysis team to pick up – no IMP/requirement/TC elements are created and no gate is requested. WRITE tool, human-only (agents are rejected with an error).
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
by |
string | no | Approver identity, MUST start with ‘human:’ (default ‘human:mcp’). |
id |
string | yes | Breakpoint id. |
project_path |
string | yes | Path to spec-editor project (directory with methodology.yaml) |
breakpoint_get
Pro tool. Available with the spec-editor Pro plugin.
Get one breakpoint’s full detail: attributes, capture history, lifecycle, its parsed data snapshot, a screenshot URL (/assets/<sha>), bound elements (about), and content.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | yes | Breakpoint id. |
project_path |
string | yes | Path to spec-editor project (directory with methodology.yaml) |
breakpoint_remove
Pro tool. Available with the spec-editor Pro plugin.
Remove one breakpoint from the pipeline board — the only operation that takes a breakpoint off it. A detach, never a delete: the record is retained with its captured context, screenshot, dialogue transcript, binding candidates and occurrence history, and the id still resolves through breakpoint_get afterwards. WRITE tool, human-only (agents/policies are rejected, like breakpoint_confirm_binding).
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
by |
string | no | Decider identity, e.g. ‘human:web’ (default ‘human:mcp’) |
id |
string | yes | Breakpoint id. |
project_path |
string | yes | Path to spec-editor project (directory with methodology.yaml) |
breakpoint_replay
Pro tool. Available with the spec-editor Pro plugin.
Build (read-only, not persisted) a Playwright replay bundle for one breakpoint: a check spec navigating to its captured screen/element, a demo (‘Before/After’) spec, and a fixture. Web-only – returns {‘error’: ‘no screen route’} for a title-only capture. Use spec-editor breakpoint replay (CLI) to write the bundle to disk.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
base_url |
string | no | Base URL of the running product (overrides local.yaml: breakpoints.replay_base_url). |
id |
string | yes | Breakpoint id. |
project_path |
string | yes | Path to spec-editor project (directory with methodology.yaml) |
breakpoint_set_lifecycle
Pro tool. Available with the spec-editor Pro plugin.
Move a breakpoint’s lifecycle to active (restore), obsolete (mark obsolete — stays on record, leaves the inbox) or removed (detach from the board — the record is retained, it is never deleted). No state ever drops captures, the screenshot, the dialogue transcript or binding decisions. WRITE tool, human-only (agents/policies are rejected with an error, exactly like breakpoint_confirm_binding).
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
by |
string | no | Decider identity, e.g. ‘human:web’ (default ‘human:mcp’) |
id |
string | yes | Breakpoint id. |
lifecycle |
string, one of active, obsolete, removed |
yes | Target lifecycle state (active|obsolete|removed); active is the default state of every breakpoint. |
project_path |
string | yes | Path to spec-editor project (directory with methodology.yaml) |
breakpoint_transcript
Pro tool. Available with the spec-editor Pro plugin.
The parsed dialogue transcript (‘## Dialogue’ turns) for one breakpoint. Read-only.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | yes | Breakpoint id. |
project_path |
string | yes | Path to spec-editor project (directory with methodology.yaml) |
breakpoints_list
Pro tool. Available with the spec-editor Pro plugin.
List breakpoint breakpoints (owner-captured UI feedback), newest first. Filter by dialogue_status (captured|described|formulated|closed), lifecycle (active|obsolete) or session_id (one SDK browsing session). Removed breakpoints are never listed — they are retained in storage and reachable by id via breakpoint_get.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
lifecycle |
string, one of active, obsolete |
no | Filter by lifecycle: active | obsolete (omitted = both). Removed breakpoints are never listed. |
limit |
integer | no | Max results (default 100). |
project_path |
string | yes | Path to spec-editor project (directory with methodology.yaml) |
session_id |
string | no | Filter to one SDK session_id. |
status |
string | no | Filter by dialogue_status: captured | described | formulated | closed. |