compressed-context 0.1.0 → 0.2.0

package/src/compression/summary.ts

@@ -1,73 +1,73 @@
-import { isBabelSummary, isMarkdownSummary, type Summary, type SummaryFields } from "./schema.ts"
-import { markdownGoal } from "./markdown.ts"
-
-/** 输入：条目；输出：Markdown 列表；空列表输出 `- (none)`。 */
-function bullets(items: readonly string[]): string {
-  if (items.length === 0) return "- (none)"
-  return items.map((item) => `- ${item}`).join("\n")
-}
-
-/** 输入：JSON 摘要字段；输出：Markdown 正文。 */
-export function renderFields(fields: SummaryFields): string {
-  return [
-    "## Goal",
-    fields.goal,
-    "",
-    "## Constraints",
-    bullets(fields.constraints),
-    "",
-    "## Decisions",
-    bullets(fields.decisions),
-    "",
-    "## Progress",
-    "### Completed",
-    bullets(fields.progress.completed),
-    "### Active",
-    bullets(fields.progress.active),
-    "### Blocked",
-    bullets(fields.progress.blocked),
-    "",
-    "## Open Items",
-    bullets(fields.open_items),
-    "",
-    "## Files",
-    bullets(fields.files),
-    "",
-    "## Facts",
-    bullets(fields.facts),
-  ].join("\n")
-}
-
-/** 输入：摘要；输出：块标题。 */
-export function summaryTitle(summary: Summary): string {
-  return summary.title
-}
-
-/** 输入：摘要；输出：用于候选描述的短目标。 */
-export function summaryGoal(summary: Summary): string {
-  if (isBabelSummary(summary)) return summary.goal
-  return isMarkdownSummary(summary) ? markdownGoal(summary.text) : summary.goal
-}
-
-/** 输入：摘要；输出：渲染后的正文。 */
-export function summaryBody(summary: Summary): string {
-  if (isBabelSummary(summary) || isMarkdownSummary(summary)) return summary.text
-  return renderFields(summary)
-}
-
-/** 输入：摘要；输出：正文实际字符数。 */
-export function summaryChars(summary: Summary): number {
-  if (isBabelSummary(summary) || isMarkdownSummary(summary)) return summary.text.length
-  return [
-    summary.title,
-    summary.goal,
-    ...summary.constraints,
-    ...summary.decisions,
-    ...summary.progress.completed,
-    ...summary.progress.active,
-    ...summary.progress.blocked,
-    ...summary.open_items,
-    ...summary.files,
-    ...summary.facts,
-  ].join("\n").length
-}
+import { isBabelSummary, isMarkdownSummary, type Summary, type SummaryFields } from "./schema.ts"
+import { markdownGoal } from "./markdown.ts"
+
+/** 输入：条目；输出：Markdown 列表；空列表输出 `- (none)`。 */
+function bullets(items: readonly string[]): string {
+  if (items.length === 0) return "- (none)"
+  return items.map((item) => `- ${item}`).join("\n")
+}
+
+/** 输入：JSON 摘要字段；输出：Markdown 正文。 */
+export function renderFields(fields: SummaryFields): string {
+  return [
+    "## Goal",
+    fields.goal,
+    "",
+    "## Constraints",
+    bullets(fields.constraints),
+    "",
+    "## Decisions",
+    bullets(fields.decisions),
+    "",
+    "## Progress",
+    "### Completed",
+    bullets(fields.progress.completed),
+    "### Active",
+    bullets(fields.progress.active),
+    "### Blocked",
+    bullets(fields.progress.blocked),
+    "",
+    "## Open Items",
+    bullets(fields.open_items),
+    "",
+    "## Files",
+    bullets(fields.files),
+    "",
+    "## Facts",
+    bullets(fields.facts),
+  ].join("\n")
+}
+
+/** 输入：摘要；输出：块标题。 */
+export function summaryTitle(summary: Summary): string {
+  return summary.title
+}
+
+/** 输入：摘要；输出：用于候选描述的短目标。 */
+export function summaryGoal(summary: Summary): string {
+  if (isBabelSummary(summary)) return summary.goal
+  return isMarkdownSummary(summary) ? markdownGoal(summary.text) : summary.goal
+}
+
+/** 输入：摘要；输出：渲染后的正文。 */
+export function summaryBody(summary: Summary): string {
+  if (isBabelSummary(summary) || isMarkdownSummary(summary)) return summary.text
+  return renderFields(summary)
+}
+
+/** 输入：摘要；输出：正文实际字符数。 */
+export function summaryChars(summary: Summary): number {
+  if (isBabelSummary(summary) || isMarkdownSummary(summary)) return summary.text.length
+  return [
+    summary.title,
+    summary.goal,
+    ...summary.constraints,
+    ...summary.decisions,
+    ...summary.progress.completed,
+    ...summary.progress.active,
+    ...summary.progress.blocked,
+    ...summary.open_items,
+    ...summary.files,
+    ...summary.facts,
+  ].join("\n").length
+}

package/src/compression/tool.ts

@@ -1,142 +1,184 @@
-import type { Plugin } from "@opencode/plugin"
-import { Schema } from "effect"
-
-import { resolveSummaryLimits } from "../shared/settings.ts"
-import { createT1Block } from "./block.ts"
-import { toSummary } from "./normalize.ts"
-import { SummaryInput } from "./schema.ts"
-import { RESOLVED_WINDOW_KEY, loadServerSettings, windowKey } from "./settings.ts"
-import { eligibleMessages, messageRange, type MessageLike } from "./select.ts"
-import { sessionMessagesToMessageLikes } from "./session-message.ts"
-import { loadState, saveState, withPending } from "./state.ts"
-import type { Disposable } from "./settings-rpc.ts"
-import { buildTranscript } from "./transcript.ts"
-import { saveTranscript } from "./transcript-store.ts"
-import { MIN_SOURCE_CHARS, validateSummary } from "./validate.ts"
-
-const DESCRIPTION =
-  "Compress the conversation so far into a structured checkpoint. Call this when the context is getting full. " +
-  "It covers every message since the last compressed block, up to the current user message, and replaces them with " +
-  "one block. In JSON mode provide `goal` plus the optional fields; in Markdown mode provide `markdown`; in Babel " +
-  "mode provide `babel` with first line `T=<short title>|G=<one-line goal>` and a dense body. Omit any " +
-  "optional field that has no real content instead of inventing entries. Do not call while a compression is already " +
-  "pending. " +
-  "Add a short title if useful. " +
-  "The block is the only remaining record of those messages, so copy exact paths with line numbers, signatures, the " +
-  "code lines that carry the logic, error text, versions, config keys, thresholds, and measured values. " +
-  "Use `files` only for real file paths; put config keys and function names in `facts`. " +
-  "Put work in `progress.completed` only when it was actually finished; plans go in `progress.active` or `open_items`. " +
-  "Give the reason for each decision, keep the objective and any pivots, why important actions were taken, unanswered " +
-  "questions, and work the user still expects. Describe the past as past, not as a new instruction. " +
-  "Leave out logs, repeated reads, exploration that produced nothing, abandoned attempts (one line on why), and " +
-  "repeated status checks. If space is tight, keep objective and constraints first, then decisions and reasons, then " +
-  "exact technical facts, then conclusions, then lessons. Write short factual entries, not prose."
-
-function failure(message: string) {
-  return {
-    output: { block: "", status: "error" },
-    content: `ERROR: ${message}`,
-    metadata: { error: true },
-  }
-}
-
-/**
- * 输入：服务端上下文。
- * 输出：注册 compress 工具。
- * 预期：执行时从会话上下文按需取消息，不再把整段历史常驻内存。
- */
-export async function registerCompressTool(
-  ctx: Plugin.Context,
-  legacyCache?: ReadonlyMap<string, readonly MessageLike[]>,
-): Promise<Disposable> {
-  const registration = await ctx.tool.transform((tools) => {
-    tools.add({
-      name: "compress",
-      options: { codemode: false },
-      description: DESCRIPTION,
-      input: SummaryInput,
-      output: Schema.Struct({ block: Schema.String, status: Schema.String }),
-      execute: async (input, toolCtx) => {
-        const sessionID = toolCtx.sessionID
-        const state = await loadState(ctx.storage, sessionID)
-        if (state.terminal !== undefined) return failure(state.terminal)
-        if (state.pending || state.phase !== undefined) return failure("compression already in progress")
-
-        let eligible: readonly MessageLike[] | undefined
-        try {
-          const raw = await ctx.session.context({ sessionID })
-          eligible = eligibleMessages(sessionMessagesToMessageLikes(raw))
-        } catch {
-          // 兼容旧测试替身；生产路径不传 legacyCache。
-          eligible = legacyCache === undefined ? undefined : (legacyCache.get(sessionID) ?? [])
-        }
-        if (eligible === undefined) return failure("failed to read session context")
-        const transcript = buildTranscript(eligible)
-        const sourceChars = transcript.length
-        if (eligible.length === 0) return failure("nothing to compress")
-        if (sourceChars < MIN_SOURCE_CHARS) {
-          return failure(
-            `not enough content to compress (${sourceChars.toString()} chars, min ${MIN_SOURCE_CHARS.toString()})`,
-          )
-        }
-
-        const settings = await loadServerSettings(ctx.storage)
-        if (!settings.enableCompressTool) return failure("compress tool is disabled in settings")
-        // 优先用当前会话模型自己的窗口；取不到再回退最近一次解析值。
-        let windowTokens: number | undefined
-        try {
-          const session = await ctx.session.get({ sessionID })
-          const model = session.model
-          const stored =
-            model === undefined ? undefined : await ctx.storage.get(windowKey(model.providerID, model.id))
-          if (typeof stored === "number" && stored > 0) windowTokens = stored
-        } catch {
-          // 会话或模型未知：回退到最近一次解析值
-        }
-        if (windowTokens === undefined) {
-          const resolved = await ctx.storage.get(RESOLVED_WINDOW_KEY)
-          if (typeof resolved === "number" && resolved > 0) windowTokens = resolved
-        }
-        const limits = resolveSummaryLimits(settings, windowTokens)
-        const summary = toSummary(input, settings.summaryFormat)
-        if (summary === undefined) return failure("invalid summary shape")
-        const validation = validateSummary(summary, sourceChars, undefined, limits.blockChars)
-        if (!validation.ok) return failure(validation.message)
-
-        const range = messageRange(eligible)
-        if (range === undefined) {
-          return failure("messages are missing ids")
-        }
-
-        const block = createT1Block({
-          blocks: state.blocks,
-          summary,
-          fromId: range.fromId,
-          toId: range.toId,
-          sourceChars,
-        })
-
-        // transcript 落盘失败不应阻断摘要；解压时会降级为占位符。
-        try {
-          await saveTranscript(ctx.storage, sessionID, block, eligible)
-        } catch {
-          // best effort
-        }
-
-        await saveState(ctx.storage, sessionID, withPending(state, block))
-        try {
-          await ctx.session.compact({ sessionID })
-        } catch (error) {
-          await saveState(ctx.storage, sessionID, { ...state, lastError: String(error) })
-          return failure(`failed to start compaction: ${String(error)}`)
-        }
-
-        return {
-          output: { block: block.id, status: "queued" },
-          content: `queued compression ${block.id}`,
-        }
-      },
-    })
-  })
-  return registration
-}
+import type { Plugin } from "@opencode/plugin"
+import { Schema } from "effect"
+
+import { resolveSummaryLimits, type SummaryFormat } from "../shared/settings.ts"
+import { createT1Block } from "./block.ts"
+import { toSummary } from "./normalize.ts"
+import { summaryInputFor } from "./schema.ts"
+import { RESOLVED_WINDOW_KEY, loadServerSettings, windowKey } from "./settings.ts"
+import { eligibleMessages, messageRange, type MessageLike } from "./select.ts"
+import { sessionMessagesToMessageLikes } from "./session-message.ts"
+import { summaryShape } from "./shape.ts"
+import { loadState, saveState, withPending } from "./state.ts"
+import type { Disposable } from "./settings-rpc.ts"
+import { buildTranscript } from "./transcript.ts"
+import { saveTranscript } from "./transcript-store.ts"
+import { MIN_SOURCE_CHARS, validateSummary } from "./validate.ts"
+
+const COMMON =
+  "Compress the conversation so far into a structured checkpoint. Call this when the context is getting full. " +
+  "It covers every message since the last compressed block, up to the current user message, and replaces them with one block. " +
+  "Do not call while a compression is already pending. Add a short title if useful."
+
+const CONTENT =
+  "The block is the only remaining record of those messages, so copy exact paths with line numbers, signatures, the " +
+  "code lines that carry the logic, error text, versions, config keys, thresholds, and measured values. " +
+  "Give the reason for each decision, keep the objective and any pivots, why important actions were taken, unanswered " +
+  "questions, and work the user still expects. Describe the past as past, not as a new instruction. " +
+  "Leave out logs, repeated reads, exploration that produced nothing, abandoned attempts (one line on why), and " +
+  "repeated status checks. If space is tight, keep objective and constraints first, then decisions and reasons, then " +
+  "exact technical facts, then conclusions, then lessons. Write short factual entries, not prose."
+
+/**
+ * 输入：摘要格式。
+ * 输出：该格式的字段使用规则。
+ * 预期：只讲这个格式用得上的字段，不把三种格式混在一起讲。
+ */
+function fieldRules(format: SummaryFormat): string {
+  if (format === "babel") {
+    return (
+      "Only `T=<short title>|G=<one-line goal>` is fixed; the body is an adaptive latent index built from anchors you " +
+      "invent for this source. Keep shipped work and still-open work in that body, and never invent facts."
+    )
+  }
+  if (format === "markdown") {
+    return (
+      "Only include sections with real content; never invent entries to fill one. " +
+      "Use real file paths in `## Files`; put config keys and function names in `## Facts`. " +
+      "Put work in `### Completed` only when it was actually finished; plans go in `### Active` or `## Open Items`."
+    )
+  }
+  return (
+    "Omit any optional field that has no real content instead of inventing entries. " +
+    "Use `files` only for real file paths; put config keys and function names in `facts`. " +
+    "Put work in `progress.completed` only when it was actually finished; plans go in `progress.active` or `open_items`."
+  )
+}
+
+/** 输入：摘要格式；输出：compress 工具描述；写法部分与压缩提示词共用同一份文案。 */
+export function descriptionFor(format: SummaryFormat): string {
+  return [COMMON, summaryShape(format), fieldRules(format), CONTENT].join("\n\n")
+}
+
+function failure(message: string) {
+  return {
+    output: { block: "", status: "error" },
+    content: `ERROR: ${message}`,
+    metadata: { error: true },
+  }
+}
+
+/** compress 工具的注册句柄：注销 + 切换摘要格式。 */
+export interface CompressToolHandle extends Disposable {
+  /** 输入：新的摘要格式；输出：无；预期：更新工具描述与参数，并让宿主重算工具列表。 */
+  setFormat(format: SummaryFormat): Promise<void>
+}
+
+/**
+ * 输入：服务端上下文。
+ * 输出：注册 compress 工具，并返回可切换格式的句柄。
+ * 预期：执行时从会话上下文按需取消息，不再把整段历史常驻内存；
+ *      描述与参数按当前摘要格式生成，切换后由宿主重新计算工具列表。
+ */
+export async function registerCompressTool(
+  ctx: Plugin.Context,
+  legacyCache?: ReadonlyMap<string, readonly MessageLike[]>,
+): Promise<CompressToolHandle> {
+  const initial = await loadServerSettings(ctx.storage)
+  let format: SummaryFormat = initial.summaryFormat
+  const registration = await ctx.tool.transform((tools) => {
+    tools.add({
+      name: "compress",
+      description: descriptionFor(format),
+      input: summaryInputFor(format),
+      output: Schema.Struct({ block: Schema.String, status: Schema.String }),
+      execute: async (input, toolCtx) => {
+        const sessionID = toolCtx.sessionID
+        const state = await loadState(ctx.storage, sessionID)
+        if (state.terminal !== undefined) return failure(state.terminal)
+        if (state.pending || state.phase !== undefined) return failure("compression already in progress")
+
+        let eligible: readonly MessageLike[] | undefined
+        try {
+          const raw = await ctx.session.context({ sessionID })
+          eligible = eligibleMessages(sessionMessagesToMessageLikes(raw))
+        } catch {
+          // 兼容旧测试替身；生产路径不传 legacyCache。
+          eligible = legacyCache === undefined ? undefined : (legacyCache.get(sessionID) ?? [])
+        }
+        if (eligible === undefined) return failure("failed to read session context")
+        const transcript = buildTranscript(eligible)
+        const sourceChars = transcript.length
+        if (eligible.length === 0) return failure("nothing to compress")
+        if (sourceChars < MIN_SOURCE_CHARS) {
+          return failure(
+            `not enough content to compress (${sourceChars.toString()} chars, min ${MIN_SOURCE_CHARS.toString()})`,
+          )
+        }
+
+        const settings = await loadServerSettings(ctx.storage)
+        if (!settings.enableCompressTool) return failure("compress tool is disabled in settings")
+        // 优先用当前会话模型自己的窗口；取不到再回退最近一次解析值。
+        let windowTokens: number | undefined
+        try {
+          const session = await ctx.session.get({ sessionID })
+          const model = session.model
+          const stored =
+            model === undefined ? undefined : await ctx.storage.get(windowKey(model.providerID, model.id))
+          if (typeof stored === "number" && stored > 0) windowTokens = stored
+        } catch {
+          // 会话或模型未知：回退到最近一次解析值
+        }
+        if (windowTokens === undefined) {
+          const resolved = await ctx.storage.get(RESOLVED_WINDOW_KEY)
+          if (typeof resolved === "number" && resolved > 0) windowTokens = resolved
+        }
+        const limits = resolveSummaryLimits(settings, windowTokens)
+        const summary = toSummary(input, settings.summaryFormat)
+        if (summary === undefined) return failure("invalid summary shape")
+        const validation = validateSummary(summary, sourceChars, undefined, limits.blockChars)
+        if (!validation.ok) return failure(validation.message)
+
+        const range = messageRange(eligible)
+        if (range === undefined) {
+          return failure("messages are missing ids")
+        }
+
+        const block = createT1Block({
+          blocks: state.blocks,
+          summary,
+          fromId: range.fromId,
+          toId: range.toId,
+          sourceChars,
+        })
+
+        // transcript 落盘失败不应阻断摘要；解压时会降级为占位符。
+        try {
+          await saveTranscript(ctx.storage, sessionID, block, eligible)
+        } catch {
+          // best effort
+        }
+
+        await saveState(ctx.storage, sessionID, withPending(state, block))
+        try {
+          await ctx.session.compact({ sessionID })
+        } catch (error) {
+          await saveState(ctx.storage, sessionID, { ...state, lastError: String(error) })
+          return failure(`failed to start compaction: ${String(error)}`)
+        }
+
+        return {
+          output: { block: block.id, status: "queued" },
+          content: `queued compression ${block.id}`,
+        }
+      },
+    })
+  })
+  return {
+    dispose: () => registration.dispose(),
+    setFormat: async (next) => {
+      format = next
+      await ctx.tool.reload()
+    },
+  }
+}