@kurrent/kcap 1.1.1 → 1.3.0-beta.1

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/bin/refresh.js CHANGED
@@ -78,6 +78,7 @@ const PLUGIN_MCP_SERVERS = {
78
78
  "kcap-memory": "memory",
79
79
  "kcap-workitems": "workitems",
80
80
  "kcap-plans": "plans",
81
+ "kcap-artefacts": "artefacts",
81
82
  "kcap-analytics": "analytics",
82
83
  };
83
84
 
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "kcap",
3
- "version": "1.1.1",
3
+ "version": "1.3.0-beta.1",
4
4
  "description": "Records and visualizes Claude Code sessions via kcap CLI hooks"
5
5
  }
@@ -10,7 +10,8 @@
10
10
  },
11
11
  "kcap-flows": {
12
12
  "command": "kcap",
13
- "args": ["mcp", "flows"]
13
+ "args": ["mcp", "flows"],
14
+ "tool_timeout_sec": 600
14
15
  },
15
16
  "kcap-memory": {
16
17
  "command": "kcap",
@@ -27,6 +28,10 @@
27
28
  "kcap-plans": {
28
29
  "command": "kcap",
29
30
  "args": ["mcp", "plans"]
31
+ },
32
+ "kcap-artefacts": {
33
+ "command": "kcap",
34
+ "args": ["mcp", "artefacts"]
30
35
  }
31
36
  }
32
37
  }
package/kcap/.mcp.json CHANGED
@@ -35,6 +35,12 @@
35
35
  "cwd": "${CLAUDE_PROJECT_DIR}",
36
36
  "description": "Plan ledger — declare the plan, spec or design document this session works from (declare_plan_document), declare its task list (set_plan_tasks), record each task's status change (update_plan_task) and read the plan back after compaction (get_plan)."
37
37
  },
38
+ "kcap-artefacts": {
39
+ "command": "kcap",
40
+ "args": ["mcp", "artefacts"],
41
+ "cwd": "${CLAUDE_PROJECT_DIR}",
42
+ "description": "Publish a self-contained HTML page — a plan, a report, a comparison — and get back a link to share. The page is sandboxed with no network access, so inline everything as data URIs. Private until you set visibility."
43
+ },
38
44
  "kcap-analytics": {
39
45
  "command": "kcap",
40
46
  "args": ["mcp", "analytics"],
package/kcap/README.md CHANGED
@@ -12,9 +12,14 @@ Search and recall past Kurrent Capacitor sessions from inside the agent.
12
12
 
13
13
  | Tool | Description |
14
14
  |------|-------------|
15
- | `search_sessions` | Free-text + author search over past sessions (and subagent transcripts), defaulted to the cwd's repo |
16
- | `get_session_summary` | Concise `summary_text` + `plan` for a session |
15
+ | `search_sessions` | Keyword (one to three terms or identifiers) + author search over past sessions (and subagent transcripts), defaulted to the cwd's repo |
16
+ | `list_repo_sessions` | List a repository's sessions you can see, running ones first |
17
+ | `get_session_summary` | Concise `summary_text` + `plan` + `declared_plans` for a session |
18
+ | `list_turns` | Per-turn prose outline for a session |
19
+ | `get_turn` | One turn's full transcript, by session id and turn index |
17
20
  | `get_session_transcript` | Speaker-tagged transcript window, with `around_event` drill-in for search hits |
21
+ | `list_repo_plans` | List a repository's declared plans you can see, most recently touched first |
22
+ | `get_declared_plans` | A plan's documents and full task list, by `plan_id` or `session_id` |
18
23
 
19
24
  Repo-aware: it resolves the cwd to a repo hash at startup, so `search_sessions` defaults to *this* repo.
20
25
 
@@ -57,6 +62,23 @@ Governed read-only SQL over the org's curated coding-agent analytics views (sess
57
62
 
58
63
  Repo-aware: defaults to the cwd's repo; pass `scope: "global"` for org-wide questions. Requires `kcap login` and a kcap-server new enough to expose the `/api/analytics` endpoints.
59
64
 
65
+ ### `kcap-artefacts`
66
+
67
+ Publish a self-contained HTML page — a plan, a report, a comparison — and get back a link to share. The page is served under a sandbox with no network access, so every style, script and image has to be inlined as a data URI; an external URL renders as nothing.
68
+
69
+ | Tool | Description |
70
+ |------|-------------|
71
+ | `publish_artefact` | Publish a page (`title`, and either `html` or a local `path`); optional `description`, `visibility`, `grants`, `session_ids`, `response_schema` to make it answerable, and `update_id` to revise an existing artefact without changing its URL |
72
+ | `await_artefact_responses` | Block until people have answered — the human checkpoint. Returns on a respondent count, on a close, or on a timeout (which is not an error) |
73
+ | `get_artefact_results` | Tallies and each person's current answer, without waiting |
74
+ | `close_artefact_responses` | Freeze a version's answers; `closed: false` reopens and clears any deadline |
75
+ | `list_my_artefacts` | The artefacts you can see — id, title, audience, latest version, URL |
76
+ | `set_artefact_visibility` | Replace an artefact's audience (`none` / `org` / `scoped` + grants) |
77
+
78
+ An artefact is private to its owner until visibility says otherwise. The current session is cited automatically from `KCAP_SESSION_ID`, so a publish is attributed to the work that produced it.
79
+
80
+ Declaring a `response_schema` turns the page into a form the server validates and tallies: fields of type `choice`, `multi`, `score` or `text`, plus a `results_mode` deciding what other viewers see — `owner` (default, only you), `aggregate` (tallies, no names or free text) or `named` (who said what). Who answered is always the authenticated viewer; there is no field for it to forge. Reading, version history and takedown stay in the web UI.
81
+
60
82
  `kcap mcp judge` is intentionally not auto-registered. Add it with `claude mcp add kcap-judge -- kcap mcp judge` if you want it.
61
83
 
62
84
  **Hooks** — Automatically captures session activity and forwards it to the Kurrent Capacitor server:
@@ -22,7 +22,9 @@ Use the `kcap mcp flows` MCP tools (`start_flow`, `send_to_participant`, `get_fl
22
22
 
23
23
  ## Long rounds are normal
24
24
 
25
- `round_timeout` is an **inactivity** bound, not a wall-clock cap: a round only fails for taking too long if the participant goes genuinely quiet for that whole stretch — an actively-working participant can legitimately run a round for a long time. If a status check (or `start_flow`/`send_to_participant`) returns the benign "Flow still running" text, that is an expected outcome on a long round, not a problem — re-enter the wait with `get_flow_status(flow_run_id, wait: true)`, which blocks (via bounded, internally-retried checks — never a raw long-poll) until the round finishes or roughly 8 minutes pass, then call it again if it's still running. A round result of **`unclear` now genuinely means the participant went dead or silent** (no activity for the whole inactivity bound, or it crashed/was stopped) — it is no longer a symptom of a merely slow participant; see the `participant_unreachable` and `participant_died`/`participant_stopped` guardrail entries below.
25
+ `round_timeout` is an **inactivity** bound, not a wall-clock cap: a round only fails for taking too long if the participant goes genuinely quiet for that whole stretch — an actively-working participant can legitimately run a round for a long time. If a status check (or `start_flow`/`send_to_participant`) returns the benign "Flow still running" text, that is an expected outcome on a long round, not a problem — re-enter the wait with `get_flow_status(flow_run_id, wait: true)`, which blocks (via bounded, internally-retried checks — never a raw long-poll) until the round finishes or roughly 3.5 minutes pass, then call it again if it's still running. A round result of **`unclear` now genuinely means the participant went dead or silent** (no activity for the whole inactivity bound, or it crashed/was stopped) — it is no longer a symptom of a merely slow participant; see the `participant_unreachable` and `participant_died`/`participant_stopped` guardrail entries below.
26
+
27
+ **A harness tool timeout is not a flow failure.** `start_flow` and `send_to_participant` block for minutes while the participant works. If your harness aborts the call with its own tool timeout (on Codex the error reads `timed out awaiting tools/call`), the flow is still running server-side. Do not start a new flow and do not investigate — call `get_flow_status(wait: true)`. Without a `flow_run_id` it reads the newest open flow this session started (pass `session_id` for another session's), so it works even when the aborted start never handed you the id or context compaction dropped it; with several open flows it lists them for you to pick from. On a harness that gives the flows server no session identity, it reads the flows started from this workspace on this machine instead.
26
28
 
27
29
  ## Role-surface safety gate
28
30
 
@@ -137,7 +139,7 @@ After applying the role-surface safety gate, if `start_flow` / `send_to_particip
137
139
 
138
140
  ## Core rules
139
141
 
140
- 1. **Start exactly one flow per user task.** Call `start_flow` once and hold the returned `flow_run_id`. Do NOT start a new flow for follow-up rounds — reuse the same ID.
142
+ 1. **Start exactly one flow per user task.** Call `start_flow` once and hold the returned `flow_run_id`. Do NOT start a new flow for follow-up rounds — reuse the same ID. If the id is gone (a harness timeout aborted the start, or compaction dropped it), get it back with `get_flow_status(wait: true)` — never by starting another flow.
141
143
  2. **After receiving a non-clean result**, address it, then call `send_to_participant` with the same `flow_run_id` and the updated message.
142
144
  3. **Do NOT finish the user task while the flow has unresolved results.** Keep iterating until the definition's clean/complete signal.
143
145
  4. **Only call `close_flow` after the clean signal.** The run stays open until you explicitly close it — don't rely on it closing itself. Then report completion to the user.
@@ -216,7 +218,7 @@ report completion to user
216
218
  |---|---|---|---|
217
219
  | `start_flow` | Exactly one of `definition_id` (catalog id, e.g. `spec-review`, `code-review`, or a custom catalog id) or `definition_yaml` (inline dynamic definition — see "Composing a dynamic flow"); plus `target_kind` (what is being worked on: `spec`, `code`, `pr`, `branch`, `file`, etc.), `target_ref` (a path, branch name, or PR URL/number that identifies the target), `target_title` (short human-readable title), `context` (background context: what to focus on, constraints, definition of done) | `vendor` (reserved aliases only — explicit reviewer vendor; omit to use the definition's authored vendor, or your saved `flows.reviewer_vendor` preference if it declares none), `model` (reserved aliases only — explicit reviewer model override; REQUIRES `vendor`, rejected on dynamic/multi-participant starts), `instructions`, `mode` (`context-only` — optional; by default the participant's worktree is mirrored from THIS SESSION's project directory, not from the directory you are working in. Pass `context-only` to opt out and treat the submitted context as authoritative) | Once, at the start of a flow task. |
218
220
  | `send_to_participant` | `flow_run_id`, `participant` (role name declared in the flow definition's `participants` map; single-participant definitions use `reviewer` — an unknown role is rejected, naming the valid ones), `message` | `instructions`, `async` (defaults to `true`) | After addressing a non-clean result for that role, or to launch a role for the first time. Pass the same `flow_run_id`, the role's name, and the updated message. |
219
- | `get_flow_status` | `flow_run_id` | `wait` (`true`/`false`, defaults to `false`) — when `true`, blocks until the round is terminal or roughly 8 minutes pass, instead of returning the current snapshot immediately | Poll or check the current status of a flow run (running, waiting, completed, failed). Use `wait: true` to ride out a long round instead of polling repeatedly yourself. |
221
+ | `get_flow_status` | — | `flow_run_id` (omit to read the newest open flow this session started, or on a harness without a session identity the newest one started from this workspace; several open flows are listed instead), `session_id` (look up another session's flows; defaults to this session), `wait` (`true`/`false`, defaults to `false`) — when `true`, blocks until the round is terminal or roughly 3.5 minutes pass, instead of returning the current snapshot immediately | Poll or check the current status of a flow run (running, waiting, completed, failed). Use `wait: true` to ride out a long round instead of polling repeatedly yourself, and omit `flow_run_id` to recover a flow whose id you never received or lost. |
220
222
  | `close_flow` | `flow_run_id` | — | Only after the definition's clean signal — or when abandoning the task early; the run otherwise stays open until closed. |
221
223
 
222
224
  ## Example (custom definition)
@@ -0,0 +1,190 @@
1
+ ---
2
+ name: eval-watch
3
+ description: >-
4
+ Follow a kcap import that setup just started and the evals landing on it —
5
+ "Follow my kcap import" (the prompt `kcap setup` hands to your agent), "watch my
6
+ import", "how is my import going", "are my evals done yet". Reads the handoff file
7
+ setup wrote, polls Capacitor analytics for exactly the sessions that import
8
+ created, summarizes the first three completed evals, links to the results and
9
+ offers the guided tour. Not for browsing evals in general — that is the analytics
10
+ or guided-tour skill.
11
+ ---
12
+
13
+ # Eval watch
14
+
15
+ You follow ONE import: the sessions listed in a handoff file `kcap setup` wrote. Every query you
16
+ issue names only those sessions — never a repo-wide or tenant-wide read, and never a query without
17
+ an `IN (...)` or `session_id = '...'` bound to this cohort. If a response ever includes a row for a
18
+ session id outside the cohort, discard that row: never count it, link it, or mention it.
19
+
20
+ ## The safety rule — read this first
21
+
22
+ Three grammars gate everything below:
23
+ - **Run id** (a `(run: <id>)` token, and the file's own `run_id`): `^[0-9a-f]{32}$`.
24
+ - **Session id** (`session_ids`, `foreground_succeeded_ids`, and any id you place in a query):
25
+ `^[A-Za-z0-9_-]{1,128}$`.
26
+ - **Repo hash** (the `repo_hash` field an analytics response returns, used only in the repo-scoped
27
+ link form): `^[0-9a-f]{16}$`. A `repo_hash` that fails this never reaches a link — fall back to
28
+ the no-repo-hash link form (section 7).
29
+
30
+ The `kcap-analytics` MCP takes raw SQL text with no parameter binding, so the session-id grammar is
31
+ the SQL-safety boundary, not just a format check. The class excludes quote, backslash, whitespace
32
+ and `;`, so a value that matches it can never close a string literal or open a new statement — a
33
+ matching id is emitted as a single-quoted literal (`'<id>'`) with **no escaping**, because none is
34
+ needed and none should be attempted. A run of hyphens such as `--` matches the grammar and is safe
35
+ to emit this way: inside a quoted literal it is data, not a SQL comment. An id that fails either
36
+ grammar is **never** placed in SQL, a path, or a link — reject it and move on (section 2 below says
37
+ what each layer's rejection does); never sanitize or escape an id into something that would pass.
38
+
39
+ ## 1. Find the run
40
+
41
+ - If the prompt carries a line `(run: <id>)`, `<id>` must match `^[0-9a-f]{32}$` before you use it
42
+ as a filename component. If it does not match, treat the prompt as carrying no run id at all. If
43
+ it does match, the run is bound: read ONLY `<config>/import-handoff-<id>.json`, where `<config>`
44
+ is `$KCAP_CONFIG_DIR` when set, else `~/.config/kcap`, and check it against every Layer A rule in
45
+ section 2, plus one more: its `run_id` field must equal `<id>` exactly. Missing, unreadable, or
46
+ failing any of those checks → say so and CLOSE (section 7) with no query. **Never fall through to
47
+ another run's file** — a different run's cohort does not belong to the run the user asked for.
48
+ - Otherwise list `<config>/import-handoff-*.json`, keep the locator-valid ones (section 2) that are
49
+ watchable (`handoff_offered` true, or `handoff_suppressed` is `skill_not_installed` or
50
+ `no_agent_detected`), pick the newest `written_at`, and say which others you passed over.
51
+ - Nothing qualifies → say you found no import to follow and CLOSE with no query.
52
+
53
+ ## 2. Validate the file — three layers
54
+
55
+ A failure at a lower layer never re-opens the file for a higher one.
56
+
57
+ **Layer A** (may this file be selected at all): JSON parses; `schema_version` is 1; `run_id` matches
58
+ `^[0-9a-f]{32}$`; `written_at` parses as ISO-8601 and is within the last 24 hours; `handoff_offered`
59
+ is a boolean. Fail → not selectable; try the next candidate file, or close with no query if none
60
+ remain.
61
+
62
+ **Layer B** (may its ids drive data): `cohort` ∈ {exact, partial_exact, unknown}; `background` ∈
63
+ {not_needed, running, exited_zero, failed}; `foreground_certainty` ∈ {complete, incomplete};
64
+ `handoff_suppressed` is null or one of import_failed, no_new_sessions, nothing_landed,
65
+ analytics_not_in_plan, skill_not_installed, no_agent_detected; every entry of `session_ids` and
66
+ `foreground_succeeded_ids` matches `^[A-Za-z0-9_-]{1,128}$`; `unattributed_on_disk` is a
67
+ non-negative integer. Fail → **no data**: the file stays selected, but say the record is unreadable
68
+ and CLOSE with links only (section 7), no query.
69
+
70
+ **Layer C** (may it supply links): `server_url` starts with `http://` or `https://`. Fail → no
71
+ file-sourced links (fall back to `kcap whoami` per section 7) and no query — an unverifiable
72
+ `server_url` also means the server-binding check in section 4 cannot run. `background_log` and
73
+ `profile` are shown as plain text — never as a link or a command to run — only when they contain no
74
+ control characters and are under 512 characters; otherwise omit them.
75
+
76
+ Never splice an unvalidated value into SQL, a path, or a link.
77
+
78
+ ## 3. No-handoff files
79
+
80
+ If `handoff_offered` is false, branch on `handoff_suppressed` and CLOSE:
81
+ - `no_new_sessions` → "nothing to watch — that import found no new sessions".
82
+ - `nothing_landed` → "the sessions that import selected were skipped at import time"; point at
83
+ `kcap import --all` for per-session reasons; no retry.
84
+ - `analytics_not_in_plan` → the plan sentence (section 6); the import ran; no retry.
85
+ - `import_failed` → "that import did not get running"; name `kcap import --all --yes` and the
86
+ `background_log` when displayable.
87
+ - `skill_not_installed` / `no_agent_detected` → the import ran and you evidently have the skill
88
+ now: continue as if offered, watching the file's cohort as usual (sections 4–5).
89
+
90
+ ## 4. Bind to the server — fail closed
91
+
92
+ If the selected file's `cohort` is `unknown`, skip this check and go straight to section 5 — there
93
+ is no cohort to query either way, and the mismatch remediation below would be misleading when
94
+ watching was never possible.
95
+
96
+ Otherwise, run `kcap whoami` and compare its server URL to `server_url`: lowercase scheme and host,
97
+ drop a default port (80 for http, 443 for https only), trim a trailing slash, compare the path
98
+ as-is. Match → continue to section 5. Mismatch or `whoami` failure → issue **NO** analytics query.
99
+ CLOSE with the file's links and this remediation: start your agent from a shell where `kcap whoami`
100
+ reports `<server_url>` — set `KCAP_PROFILE=<profile>`, unset `KCAP_URL`, and set `KCAP_CONFIG_DIR`
101
+ if kcap uses a custom config directory — then prompt again.
102
+
103
+ ## 5. Watch the cohort
104
+
105
+ Cohort = `session_ids` (`cohort: unknown` or empty → CLOSE with links, no query). Open with:
106
+ "Watching N sessions from this import (K landed before the handoff)" — K is
107
+ `foreground_succeeded_ids.length`; for `partial_exact` add "the 500 most recent; older ones may
108
+ land and evaluate unobserved"; if `unattributed_on_disk` > 0 add the sentence from section 7.
109
+
110
+ Every query uses `query_analytics` with `scope: 'global'` (the MCP defaults to the caller's cwd
111
+ repo and will not widen on its own), **ONE call at a time — never two in flight** — and names only
112
+ cohort ids, each already validated against the grammar above, as single-quoted literals in an
113
+ `IN (...)` list or `session_id = '...'`. If a response ever includes a row whose `session_id` is
114
+ not in `session_ids`, drop that row before using the response for anything.
115
+
116
+ **Request budget:** at most 20 cohort queries per poll. `floor = ceil(N / 20)`. The FIRST poll uses
117
+ batch size `floor` exactly — no probing at a smaller size first. Every batch passes `max_rows`
118
+ equal to its own size:
119
+
120
+ SELECT s.session_id, s.repo_hash, e.eval_run_id, e.evaluated_at, e.overall_score, e.judge_model
121
+ FROM v_an_sessions s LEFT JOIN v_an_eval_summaries e ON e.session_id = s.session_id
122
+ WHERE s.session_id IN ('<id>', '<id>', ...)
123
+
124
+ A row = arrived; a non-null `eval_run_id` = completed. Each response body carries `max_rows`, the
125
+ server's effective cap. After the first poll: if any body reported `max_rows < floor`, fail closed
126
+ at once — say the server's row cap is below what watching this many sessions needs, and CLOSE,
127
+ having spent no more than the 20-query budget. Otherwise raise the batch to `min(100, max_rows)`
128
+ for later polls. Any batch that comes back `truncated: true`, in the first poll or any later one,
129
+ fails that poll — the cap decides, not the truncation flag alone.
130
+
131
+ One poll = every batch it needs, each non-truncated. A failed or truncated batch discards the whole
132
+ poll — nothing from it commits — and counts as one failure toward the two-failure stop rule.
133
+
134
+ A 429 fails the poll. If its text matches `retry after (\d+)s`, wait that many seconds before the
135
+ next poll; otherwise wait 60 seconds. Never poll sooner than the 30-second cadence either way. HTTP
136
+ 403 with `analytics_not_in_plan` → CLOSE immediately with the plan sentence (section 6); no
137
+ polling, no retry, no wait.
138
+
139
+ Progress = cohort ids that arrived / cohort size, computed from the batch rows only — never a
140
+ separate count, never repo- or tenant-wide. Cadence: first snapshot immediately, then every 30
141
+ seconds.
142
+
143
+ **Stop**, evaluated in this order after each poll whose results have already committed:
144
+ 1. Three distinct cohort sessions have a completed eval → summarize the first three, ordered by
145
+ `evaluated_at` then `session_id` (the same tie-break applies to rows already present at the very
146
+ first snapshot, so more than three arriving at once always picks the same three).
147
+ 2. `cohort: exact`, non-empty, and every id in `session_ids` has a completed eval → summarize what
148
+ completed. Never fires for `partial_exact` or an empty cohort.
149
+ 3. Two consecutive failed polls → stop, reporting the failures.
150
+ 4. 10 minutes since the first snapshot → stop. No new poll starts after the deadline, but a poll
151
+ already dispatched before it finishes normally, and its outcome is still checked against rules
152
+ 1–3 first: a third distinct completion in that final poll wins over the deadline summary, and if
153
+ that final poll is itself the second consecutive failure, report it as the deadline stop while
154
+ still naming the failures.
155
+
156
+ No idle early-stop — quiet polls are normal and are not a reason to stop early.
157
+
158
+ **Per-session detail** (one session per query, at most 6 queries across the whole run — enough for
159
+ the three sessions rule 1 summarizes):
160
+
161
+ SELECT category, AVG(score) AS mean FROM v_an_eval_scores WHERE session_id = '<id>' GROUP BY category
162
+ SELECT question_id, score FROM v_an_eval_scores WHERE session_id = '<id>' ORDER BY score ASC, question_id ASC LIMIT 2
163
+
164
+ Strongest = highest mean, weakest = lowest, ties alphabetical by category. A truncated or failed
165
+ detail query, or a session with no score rows, → summarize that session by `overall_score` alone
166
+ and say so; this never affects poll success or the stop rules above. When the `kcap-sessions` MCP is
167
+ available, use it to enrich a session's title; otherwise the session id is enough.
168
+
169
+ ## 6. When little or nothing completes
170
+
171
+ Explain the real gates plainly: auto-eval may be off for a repository; the server needs an eval
172
+ agent configured; sessions under the minimum event count are skipped; already-evaluated sessions
173
+ are not re-run; a recovery sweep runs hourly. If the analytics MCP is absent entirely, close
174
+ immediately with the block below.
175
+
176
+ Plan sentence (used here and from sections 3 and 5): "Insights isn't in this workspace's plan, so
177
+ evals can't be followed from here; your import continues and evals appear in the Capacitor UI."
178
+
179
+ ## 7. CLOSE — always
180
+
181
+ 1. How to keep watching: prompt `Follow my kcap import` again (with the same `(run: <id>)` line
182
+ when you were bound to one).
183
+ 2. Links: with a `repo_hash` matching `^[0-9a-f]{16}$`, `<server_url>/repo/<repo_hash>/sessions/<session_id>?tab=evaluation`;
184
+ otherwise (no `repo_hash`, or one that fails the grammar) `<server_url>/sessions/<session_id>?tab=evaluation`;
185
+ all results `<server_url>/sessions`. No valid file → `server_url` from `kcap whoami`; if that
186
+ fails too, say the results live in the Capacitor server UI and that `kcap whoami` prints the URL
187
+ once logged in.
188
+ 3. When `unattributed_on_disk` > 0: "N sessions on disk had no repository match; any of them that
189
+ imported show without one — `kcap remap` places them."
190
+ 4. Offer the guided tour with the exact prompt `Start kcap guided tour`.
@@ -374,12 +374,16 @@ causation, and never a savings figure.
374
374
 
375
375
  **`What did I leave unfinished in my last session?`** — `search_sessions` with `author: <user>`
376
376
  for their most recent session, then `get_session_summary`: the answer lives in the summary's
377
- Unfinished/Risks section. Quote it with the session id; if the summary has no such section, say
378
- so plainly rather than inferring one from the transcript.
377
+ Unfinished section. Quote it with the session id. An older summary has a combined Unfinished/Risks
378
+ section instead, which mixes risks and status notes in with the work: report only the concrete
379
+ actions still to do from it and leave the rest out. If there is no such section, or it holds no
380
+ action still to do, say so plainly rather than inferring one from the transcript.
379
381
 
380
382
  **`Pick up where my last session left off`** — same lookup, then actually resume: load the
381
- summary's context and unfinished items, restate in two sentences where the work stopped, and ask
382
- which item to continue with. This one is an action, not a report — end by doing, not describing.
383
+ summary's context and its unfinished actions (found as above), restate in two sentences where the
384
+ work stopped, and ask which action to continue with. If there are none, say no unfinished action
385
+ was recorded and ask what they want to work on next. This one is an action, not a report — end by
386
+ doing, not describing.
383
387
 
384
388
  **Prompt suggestions you compose** — anywhere you offer a `Prompt ❯` line of your own (rule 5
385
389
  next steps, variations, follow-ups), two rules:
@@ -17,10 +17,13 @@ through the `kcap-plans` MCP tools; nothing infers it. Three rules:
17
17
 
18
18
  1. **When you write or are handed a plan, spec or design document, declare it.**
19
19
  Call `declare_plan_document` with its `kind` (`plan`, `spec` or `design`)
20
- and `path`. The file is read locally, hashed, and keyed against the
21
- repository root; declaring the same file again from a later session lands
22
- on the same plan. When a plan implements a spec, or a spec refines a design,
23
- pass the other file as `argues_from` so both attach to one plan.
20
+ and `path`. The file is read locally, hashed, and keyed against the repository root
21
+ **and the checkout it sits in**: declaring the same file again from the same
22
+ checkout lands on the same plan, but from a different worktree or clone it
23
+ starts a separate one. To continue a plan another session began, see
24
+ "Resuming a plan" below — do not re-declare its document. When a plan
25
+ implements a spec, or a spec refines a design, pass the other file as
26
+ `argues_from` so both attach to one plan.
24
27
  2. **When a plan has discrete steps, declare them and update each transition.**
25
28
  Call `set_plan_tasks` with the whole ordered list (`title`, optional
26
29
  `task_id`, `status`, `note`); re-send the whole list when the steps change,
@@ -28,10 +31,27 @@ through the `kcap-plans` MCP tools; nothing infers it. Three rules:
28
31
  task starts, finishes or is skipped, by `task_id` or 1-based `ordinal`, with
29
32
  `status` `pending`, `in_progress`, `completed` or `skipped` and a `note`
30
33
  when the reason matters. After compaction, `get_plan` returns the list.
34
+ While a plan's `is_complete` is `false`, never call `set_plan_tasks`
35
+ on it for any reason — the list would be rebuilt from a view that is
36
+ missing tasks.
31
37
  3. **Keep whatever ledger your own workflow asks for as well.** These tools
32
38
  replace the harness's task list, not your notes or any file another
33
39
  workflow tells you to maintain.
34
40
 
41
+ ## Resuming a plan
42
+
43
+ To continue a plan that an earlier session left unfinished — yours or a teammate's. Finding and reading use the `kcap-sessions` tools; the only writes are the reconciling snapshot in step 3, when one is needed, and the adoption in step 5, always last.
44
+
45
+ 1. **Find it.** `list_repo_plans` lists this repository's open plans. Read each row's `sessions` together: a session that is `active`, not `stale`, and whose `last_touched_at` is recent may still be executing the plan — **ask the user before adopting it**. An active session whose `last_touched_at` is old has most likely moved to other work; a session stays attached to every plan it ever touched, so that alone is no reason to hold back. The default `state: "open"` lists plans with a visible unfinished task; a plan whose visible tasks are done but whose withheld tasks are not is absent from it. When the plan you expect is missing, call `list_repo_plans(state: "all")` and look for rows with `is_complete: false`.
46
+ 2. **Read it.** `get_declared_plans(plan_id: …)` for the documents and the full task list.
47
+ 3. **Compare the document.** Read the plan file from *this* checkout at its repo-relative `path` and compare it with `content_hash` — the lowercase hex SHA-256 of the file's bytes, as `shasum -a 256` prints it. If it changed, the task list may be out of date. Reconciling it means sending a new snapshot with `set_plan_tasks(plan_id: …)`, and a snapshot **replaces** the list — a task it omits is deleted, a note it omits is cleared:
48
+ - **`is_complete` is `true`:** reconcile now, **before** step 5, carrying every existing task's `task_id`, `status` and `note` over from step 2. Sent after step 5, the snapshot would carry the resumed task's earlier `pending` status and put it straight back.
49
+ - **`is_complete` is `false`: never send a snapshot.** Your view is missing someone else's tasks or notes, and a list rebuilt from it would destroy them. Carry on with `update_plan_task`, which changes one task and nothing else, and tell the user the document changed and the list could not be reconciled from your view.
50
+ 4. **Verify before continuing.** The ledger records what the earlier session *claimed*. A task left `in_progress` may be half-written: check the working tree and the history since the document's `commit_sha`, when it is set, before picking it up.
51
+ 5. **Adopt it.** `update_plan_task(plan_id: …, task_id: …, status: "in_progress")` on the task you are resuming. That attaches this session to the plan and makes it the session's current plan, so later calls can omit `plan_id`. This is always the last write of the procedure.
52
+
53
+ **Do not call `declare_plan_document` for that plan's file while resuming from a different checkout** — a new worktree, another clone. It would start a second plan, point this session at it, and split the ledger: your progress would land on an empty plan while the original stops moving. Rule 1's "declare a document when you read it" does not apply here. From the same checkout path, declaring it again is harmless.
54
+
35
55
  ## Tool reference
36
56
 
37
57
  | Tool | Required args | Purpose |
@@ -41,6 +61,8 @@ through the `kcap-plans` MCP tools; nothing infers it. Three rules:
41
61
  | `update_plan_task` | `status` and one of `task_id` / `ordinal` (+ `note`, `plan_id`) | Record one transition; the result names the plan. |
42
62
  | `get_plan` | — (+ `plan_id`, `session_id`) | Documents, tasks with status and source, progress. |
43
63
 
64
+ To read a plan from *another* session, or to find unfinished plans in the repository, use `get_declared_plans` and `list_repo_plans` on the `kcap-sessions` server: they are read-only and do not prompt.
65
+
44
66
  Without `plan_id` every tool acts on the session's current plan — the one it
45
67
  most recently wrote to; a session on no plan gets one created by
46
68
  `set_plan_tasks` and an empty result from `get_plan`. If a tool cannot resolve
@@ -10,12 +10,15 @@ description: >-
10
10
  "recent changes", "recent sessions", or providing a session ID to review.
11
11
  Also covers search/recall asks: "find the session where we…", "which session
12
12
  discussed X", "did we ever debug Y", "look up the session about Z", "recall
13
- the session that…", "search past sessions for…". Provides instructions for
14
- retrieving and searching session history via the kcap CLI and the
15
- kcap-sessions MCP tools.
13
+ the session that…", "search past sessions for…".
14
+ Also covers declared plans: "continue the plan", "resume the plan", "what's
15
+ left on the plan", "is the plan finished", "unfinished plans", "what was the
16
+ last session working through".
17
+ Provides instructions for retrieving and searching session history via the
18
+ kcap CLI and the kcap-sessions MCP tools.
16
19
  ---
17
20
 
18
- > **For agents:** When the `kcap-sessions` MCP server is available, prefer its tools (`search_sessions`, `list_repo_sessions`, `get_session_summary`, `list_turns`, `get_turn`, `get_session_transcript`) for retrieving past sessions. This CLI-wrapped skill remains a fallback for shell use and when MCP isn't installed.
21
+ > **For agents:** When the `kcap-sessions` MCP server is available, prefer its tools (`search_sessions`, `list_repo_sessions`, `get_session_summary`, `list_turns`, `get_turn`, `get_session_transcript`, `list_repo_plans`, `get_declared_plans`) for retrieving past sessions and the plans they declared. This CLI-wrapped skill remains a fallback for shell use and when MCP isn't installed.
19
22
 
20
23
  # Session Recap
21
24
 
@@ -76,7 +79,8 @@ Returns AI-generated summaries from the most recent ended sessions in the curren
76
79
  2. **`## Summary`** — an AI-generated narrative covering:
77
80
  - **Context** — why the work was done
78
81
  - **Key decisions** — trade-offs and design choices that matter for future work
79
- - **Unfinished/Risks** — anything deferred or left incomplete
82
+ - **Unfinished** — work that remains, one action per bullet
83
+ - **Risks** — anything flagged as risky or uncertain (older summaries combine these two as **Unfinished/Risks**)
80
84
  3. **`## Turns`** — an outline with one line per turn:
81
85
  - If the turn has a prose summary, that summary (1-3 sentences).
82
86
  - Otherwise, a truncated user-prompt excerpt plus tool/file metadata (tool names, file count).
@@ -98,6 +102,30 @@ For a plain metadata index instead of the outline (turn #, prompt excerpt, tool
98
102
 
99
103
  **MCP agents:** call `list_turns` to get a session's full turn map (`turn_index`, `prose`, `user_prompt`, `tools`, `files`, token counts), then `get_turn(session_id, turn_index)` for one turn's full transcript. Use `get_session_summary` for the whole-session narrative instead of drilling into individual turns.
100
104
 
105
+ ## Plans
106
+
107
+ A session that works from a plan declares it to Capacitor: the documents, an ordered task list, and each task's status. That record outlives the session, so it is how you tell where earlier work stopped. It is reachable only through the `kcap-sessions` MCP tools — `kcap recap` does not print it, and the `## Plan` block above is the plan *text* a session captured, not its task list.
108
+
109
+ **Finding one.**
110
+ - `list_repo_plans` — the unfinished plans in this repository, most recently touched first. Start here when you have no session id: "what was left unfinished", "is there a plan to continue". The default `state: "open"` lists plans with a visible unfinished task; a plan whose visible tasks are done but whose withheld tasks are not is absent from it. When the plan you expect is missing, call `list_repo_plans(state: "all")` and look for rows with `is_complete: false`.
111
+ - `get_session_summary` — carries `declared_plans`, one pointer per plan that session or its continuation chain declared, when it declared any.
112
+ - `get_declared_plans` — the full task list, by `plan_id` (from either of the above) or by `session_id`.
113
+
114
+ **Judging whether a plan is done.** Read `progress` and two flags, in this order:
115
+
116
+ 1. `progress.finished` is `true` — the plan is done.
117
+ 2. `progress.completed` is less than `progress.total` — the plan is open. What remains is every entry of `tasks` whose status is neither `completed` nor `skipped`; a `list_repo_plans` row has no `tasks`, and gives the first of them as `next_task`.
118
+ 3. `is_complete` is `false` — nothing visible remains — possibly nothing visible was declared — but the view is partial; say so and do not call the plan complete.
119
+ 4. Otherwise `progress.total_known` is `false` — the session declared documents but never a task list, so completion is unknown. That is not withheld data; do not report it as a partial view. If instead `total_known` is `true`, the server itself reports the plan unfinished — treat it as open and do not infer completion from the totals.
120
+
121
+ **`is_complete` does not mean the work is done.** It means nothing was withheld from your view, and a half-finished plan usually has `is_complete: true`. `finished` is the field that answers "is it done". If `progress` has no `finished` field, the server predates it: the plan is finished only when `total_known` is true **and** `completed` equals `total` **and** `is_complete` is true.
122
+
123
+ *Worked example — starting from a session.* `get_declared_plans(session_id: "4f2a…")` returns one plan with `progress: {completed: 2, total: 7, total_known: true, finished: false}` and `is_complete: true`. Branch 2: open, five tasks remain — list them from `tasks`.
124
+
125
+ *Worked example — starting from a summary.* `get_session_summary` shows `declared_plans: [{plan_id: "9c1e…", completed: 7, total: 7, total_known: true, finished: false, is_complete: false, is_current: true}]`. Not branch 1, not branch 2 — branch 3: all seven visible tasks are done, but the view is partial. Report that; do not report the plan as finished. Drill down with `get_declared_plans(plan_id: "9c1e…")` to see which task and note are withheld.
126
+
127
+ To pick a plan up and continue it, follow "Resuming a plan" in the `plans` skill.
128
+
101
129
  ## Full Output (`--full`)
102
130
 
103
131
  The complete transcript with these section types:
@@ -19,7 +19,9 @@ These four tools are aliases of the generic flow tools (`start_flow`, `send_to_p
19
19
 
20
20
  ## Long rounds are normal
21
21
 
22
- `round_timeout` is an **inactivity** bound, not a wall-clock cap: a round only fails for taking too long if the reviewer goes genuinely quiet for that whole stretch — an actively-working reviewer can legitimately run a round for a long time. If a status check (or a `submit_review_round`/`start_review_flow` call) returns the benign "Flow still running" text, that is an expected outcome on a long round, not a problem — re-enter the wait with `get_review_flow_status(flow_run_id, wait: true)`, which blocks (via bounded, internally-retried checks — never a raw long-poll) until the round finishes or roughly 8 minutes pass, then call it again if it's still running. A round result of **`unclear` now genuinely means the reviewer went dead or silent** (no activity for the whole inactivity bound, or it crashed/was stopped) — it is no longer a symptom of a merely slow reviewer, so treat it as a liveness problem (see the `participant_unreachable` and `participant_died`/`participant_stopped` entries below), not as "the review is taking a while."
22
+ `round_timeout` is an **inactivity** bound, not a wall-clock cap: a round only fails for taking too long if the reviewer goes genuinely quiet for that whole stretch — an actively-working reviewer can legitimately run a round for a long time. If a status check (or a `submit_review_round`/`start_review_flow` call) returns the benign "Flow still running" text, that is an expected outcome on a long round, not a problem — re-enter the wait with `get_review_flow_status(flow_run_id, wait: true)`, which blocks (via bounded, internally-retried checks — never a raw long-poll) until the round finishes or roughly 3.5 minutes pass, then call it again if it's still running. A round result of **`unclear` now genuinely means the reviewer went dead or silent** (no activity for the whole inactivity bound, or it crashed/was stopped) — it is no longer a symptom of a merely slow reviewer, so treat it as a liveness problem (see the `participant_unreachable` and `participant_died`/`participant_stopped` entries below), not as "the review is taking a while."
23
+
24
+ **A harness tool timeout is not a flow failure.** `start_review_flow` and `submit_review_round` block for minutes while the reviewer works. If your harness aborts the call with its own tool timeout (on Codex the error reads `timed out awaiting tools/call`), the flow is still running server-side. Do not start a new flow and do not investigate — call `get_review_flow_status(wait: true)`. Without a `flow_run_id` it reads the newest open flow this session started (pass `session_id` for another session's), so it works even when the aborted start never handed you the id or context compaction dropped it; with several open flows it lists them for you to pick from. On a harness that gives the flows server no session identity, it reads the flows started from this workspace on this machine instead.
23
25
 
24
26
  ## Role-surface safety gate
25
27
 
@@ -130,7 +132,7 @@ After applying the role-surface safety gate, if `start_review_flow` / `submit_re
130
132
 
131
133
  ## Core rules
132
134
 
133
- 1. **Start exactly one flow per user task.** Call `start_review_flow` once and hold the returned `flow_run_id`. Do NOT start a new flow for follow-up rounds — reuse the same ID.
135
+ 1. **Start exactly one flow per user task.** Call `start_review_flow` once and hold the returned `flow_run_id`. Do NOT start a new flow for follow-up rounds — reuse the same ID. If the id is gone (a harness timeout aborted the start, or compaction dropped it), get it back with `get_review_flow_status(wait: true)` — never by starting another flow.
134
136
  2. **After receiving a `findings` result**, address every finding, then call `submit_review_round` with the updated context and the same `flow_run_id`.
135
137
  3. **Do NOT finish the user task while the flow has unresolved findings.** Keep iterating until the reviewer returns `clean`.
136
138
  4. **Only call `close_review_flow` after a `clean` result.** Then report completion to the user.
@@ -175,7 +177,7 @@ if findings:
175
177
  |---|---|---|---|
176
178
  | `start_review_flow` | `kind` (`spec-review`\|`code-review`), `target_kind` (what is being reviewed: `spec`, `code`, `pr`, `branch`, `file`, etc.), `target_ref` (a path, branch name, or PR URL/number that identifies the target), `target_title` (short human-readable title, e.g. spec name or PR title), `context` (background context: what to focus on, constraints, definition of done) | `vendor` (explicit reviewer vendor; omit to use the definition's authored vendor, or your saved `flows.reviewer_vendor` preference if it declares none), `model` (explicit reviewer model override — REQUIRES `vendor`; only pass it when the user named a model), `instructions`, `mode` (`context-only` — optional) | Once, at the start of a review task. |
177
179
  | `submit_review_round` | `flow_run_id`, `context` | `instructions` | After addressing findings. Pass the same `flow_run_id` and the updated context. |
178
- | `get_review_flow_status` | `flow_run_id` | `wait` (`true`/`false`, defaults to `false`) — when `true`, blocks until the round is terminal or roughly 8 minutes pass, instead of returning the current snapshot immediately | Poll or check the current status of a flow (running, waiting, completed, failed). Use `wait: true` to ride out a long round instead of polling repeatedly yourself. |
180
+ | `get_review_flow_status` | — | `flow_run_id` (omit to read the newest open flow this session started, or on a harness without a session identity the newest one started from this workspace; several open flows are listed instead), `session_id` (look up another session's flows; defaults to this session), `wait` (`true`/`false`, defaults to `false`) — when `true`, blocks until the round is terminal or roughly 3.5 minutes pass, instead of returning the current snapshot immediately | Poll or check the current status of a flow (running, waiting, completed, failed). Use `wait: true` to ride out a long round instead of polling repeatedly yourself, and omit `flow_run_id` to recover a flow whose id you never received or lost. |
179
181
  | `close_review_flow` | `flow_run_id` | — | Only after the reviewer returns `clean`. |
180
182
 
181
183
  ## Example (code review)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kurrent/kcap",
3
- "version": "1.1.1",
3
+ "version": "1.3.0-beta.1",
4
4
  "description": "CLI companion for Kurrent Capacitor — records and visualizes Claude Code sessions",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "repository": {
@@ -14,17 +14,17 @@
14
14
  "postinstall": "node bin/postinstall.js"
15
15
  },
16
16
  "optionalDependencies": {
17
- "@kurrent/kcap-darwin-arm64": "1.1.1",
18
- "@kurrent/kcap-linux-arm64": "1.1.1",
19
- "@kurrent/kcap-linux-musl-arm64": "1.1.1",
20
- "@kurrent/kcap-linux-musl-x64": "1.1.1",
21
- "@kurrent/kcap-linux-x64": "1.1.1",
22
- "@kurrent/kcap-win-x64": "1.1.1"
17
+ "@kurrent/kcap-darwin-arm64": "1.3.0-beta.1",
18
+ "@kurrent/kcap-linux-arm64": "1.3.0-beta.1",
19
+ "@kurrent/kcap-linux-musl-arm64": "1.3.0-beta.1",
20
+ "@kurrent/kcap-linux-musl-x64": "1.3.0-beta.1",
21
+ "@kurrent/kcap-linux-x64": "1.3.0-beta.1",
22
+ "@kurrent/kcap-win-x64": "1.3.0-beta.1"
23
23
  },
24
24
  "files": [
25
25
  "bin/",
26
26
  "kcap/"
27
27
  ],
28
- "kcapReleaseCommit": "c56b47d75d5015098627600e7c893711ba2059d8",
29
- "kcapReleaseTag": "v1.1.1"
28
+ "kcapReleaseCommit": "f95e44d81d47ce2bd10c95d45c269951480e9d62",
29
+ "kcapReleaseTag": "v1.3.0-beta.1"
30
30
  }