dsh-plugin-dev-kb 1.6.0 → 1.8.1

package/kb/site/en/reference/subsystems/session-reference.md

@@ -1,228 +1,231 @@
----
-editSource: "docs/subsystems/session-reference.md"
-rawMarkdownPath: "en/reference/subsystems/session-reference.md"
-outline: [2,3]
----
-
-# Session References
-
-Host-backed file discovery plus structured cross-session reference requests and prepared message contexts. The [file-reference contract](https://github.com/deepseek-ai/deepseek-harness/tree/master/packages/context/file-reference) owns path-only completion records and grammar; the [session-reference contract](https://github.com/deepseek-ai/deepseek-harness/tree/master/packages/context/session-reference) defines canonical URIs, current-surface projection, tag-safe JSON and byte retention, stable errors, and the untrusted model prompt. Host adapters use these types instead of passing their UI mention syntax into the agent core.
-
-Sources: [`packages/context/file-reference/src/types.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/context/file-reference/src/types.ts) · [`packages/context/session-reference/src/types.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/context/session-reference/src/types.ts)
-
-## File candidates
-
-`FileReferenceCandidate` is the path-only discovery result. The addressed agent supplies the working-directory scope; providers decide ranking and namespace access without reading file contents.
-
-```ts type-equiv
-/** One path-only completion candidate inside the target session cwd. */
-interface FileReferenceCandidate {
-  /** User-facing path accepted by normal prompts and filesystem tools. */
-  path: string
-  /** Directories keep completion open; files finish the mention. */
-  kind: 'file' | 'directory'
-}
-```
-
-## Inputs and candidates
-
-`SessionReferenceInput` is the host-independent selection. The id is authoritative; the label is display metadata carried into the snapshot.
-
-```ts type-equiv
-/** One source session selected by a host. */
-interface SessionReferenceInput {
-  /** Opaque source session identity. */
-  sessionId: SessionId
-  /** Optional user-facing mention label. */
-  label?: string
-}
-```
-
-`SessionReferenceCandidate` is host-facing discovery output. Its `label` uses the latest Session title when present, while its optional display text prefers a subagent's durable creation label; filtering searches both alongside Session id and cwd, never transcript text. The Remote candidate's canonical mention uses the display text when present.
-
-```ts type-equiv
-/** One host-facing candidate from exact session metadata. */
-interface SessionReferenceCandidate {
-  /** Opaque source session identity. */
-  sessionId: SessionId
-  /** Latest log-backed title, falling back to the opaque session id. */
-  label: string
-  /** Display and canonical-mention text, preferring a subagent's durable creation label over {@link label}. */
-  displayTitle?: string
-  /** Source session working directory, when recorded. */
-  cwd?: string
-  /**
-   * True when {@link SessionReferenceCandidate.cwd} is recorded and equals the
-   * requesting agent's. Hosts that only surface a distinguishing location
-   * read this instead of comparing paths they never received.
-   */
-  sameWorkspace: boolean
-  /** Source session creation time in Unix epoch milliseconds. */
-  createdAt: number
-}
-```
-
-The `sessionReferenceResolver/candidates` Remote method serves the same discovery to browser consumers and attaches each candidate's canonical prompt mention.
-
-```ts type-equiv
-/** One discovery candidate carrying its canonical prompt mention. */
-interface SessionReferenceMentionCandidate extends SessionReferenceCandidate {
-  /** Canonical `@[label](dsh-session:…)` mention serialized into the prompt draft. */
-  mention: string
-}
-```
-
-## Prepared messages
-
-Preparation preserves readable current-message content and returns at most one aggregated context. Its durable source records keep `capturedThroughSeq` as a coordinate in the referenced Session's original generation; they never reinterpret it as a seq in the containing Session. `capturedFormatVersion` records that generation, with absence meaning released format v0.
-
-```ts type-equiv
-/** Durable source session, cited event seqs, and snapshot facts for prepared cross-session context. */
-interface SessionReferenceSource {
-  kind: 'session-reference'
-  /** Material lifted out of another session's log (`recall` context form). */
-  form: 'recall'
-  version: 1
-  references: {
-    sessionId: string
-    label: string
-    /** Source Session format generation; absence identifies version 0. */
-    capturedFormatVersion?: number
-    capturedThroughSeq: OptionalSessionSeq
-    compacted: boolean
-    originalMessages: number
-    retainedMessages: number
-    omittedMessages: number
-    omittedBytes: number
-    truncated: boolean
-    inputIndex: number
-  }[]
-}
-```
-
-```ts type-equiv
-/** Direct message content and optional referenced-session context. */
-interface PreparedReferencedMessage {
-  /** Readable message content after host mention tokens are removed. */
-  content: ContentBlock[]
-  /** Aggregated untrusted snapshot, absent when the message has no references. */
-  additionalContext?: UserMessage
-}
-```
-
-## Errors
-
-`SessionReferenceError.code` separates invalid configuration or input, self-reference, count limits, source-read failure, budget failure, and cancellation. Host protocols map these codes to their own error envelopes without inspecting prompt bytes.
-
-```ts type-equiv
-/** Stable failure codes exposed to host adapters. */
-type SessionReferenceErrorCode =
-  | 'SESSION_REFERENCE_INVALID_CONFIG'
-  | 'SESSION_REFERENCE_INVALID_REFERENCE'
-  | 'SESSION_REFERENCE_SELF_REFERENCE'
-  | 'SESSION_REFERENCE_TOO_MANY'
-  | 'SESSION_REFERENCE_READ_FAILED'
-  | 'SESSION_REFERENCE_BUDGET_EXCEEDED'
-  | 'SESSION_REFERENCE_CANCELLED'
-```
-
-<!-- BEGIN GENERATED cordis-surface (gen-cordis-catalog.ts) — do not edit between markers -->
-
-<a id="cordis-surface"></a>
-
-## Cordis API
-
-Generated from source by `scripts/gen-cordis-catalog.ts` (verified fresh by `pnpm run verify-cordis-catalog` in doc-sync; regenerate with `pnpm run gen-cordis-catalog`) — the language sides differ only in locale-specific paired document paths. Signature blocks use a `ts cordis-catalog` fence and keep the original source JSDoc; dispatch modes are defined in the [primer](../cordis-primer.md#dispatch-modes), and the framework-inherited `ctx` API lives in [cordis-api/inherited.md](../cordis-api/inherited.md).
-
-<a id="ctxfilereferences--filereferenceservice-abstract-seam"></a>
-
-### `ctx.fileReferences` — `FileReferenceService` (abstract seam)
-
-Host capability for cancellable file-reference discovery.
-
-```ts cordis-catalog
-/**
- * List file and directory candidates for one agent's working directory.
- * @param agent - target agent whose session cwd bounds discovery.
- * @param query - path text following `@` or `@"`.
- * @param signal - caller cancellation.
- * @returns deterministic path-only candidates.
- */
-abstract list( agent: Agent, query: string, signal: AbortSignal, ): Promise<FileReferenceCandidate[]>
-```
-
-Types: [Agent](./core.md)
-
-Source: [`packages/context/file-reference/src/index.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/context/file-reference/src/index.ts)
-
-<a id="ctxsessionfilereferences--sessionfilereferences"></a>
-
-### `ctx.sessionFileReferences` — `SessionFileReferences`
-
-Host Remote adapter over the composed file-reference provider.
-
-```ts cordis-catalog
-/**
- * List file and directory candidates for one Agent's working directory.
- * @param agent - target Agent resolved from the Session identity on the wire.
- * @param query - path text following `@` or `@"`.
- * @param signal - caller cancellation.
- * @returns deterministic path-only candidates from the composed provider.
- */
-@Remote list( agent: Agent, query: string, signal: AbortSignal, ): Promise<FileReferenceCandidate[]>
-```
-
-Types: [Agent](./core.md)
-
-Source: [`packages/api/session-controller/src/file-references.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/api/session-controller/src/file-references.ts)
-
-<a id="ctxsessionreferenceresolver--sessionreferenceresolver"></a>
-
-### `ctx.sessionReferenceResolver` — `SessionReferenceResolver`
-
-Exact-read consumer that prepares immutable cross-session message context.
-
-```ts cordis-catalog
-/**
- * List reference candidates, ranked by working-directory affinity.
- *
- * Discovery runs at keystroke rate, so titles and subagent labels only ever
- * come from projection reads; sessions without either fall back to their id.
- * @param agent - target agent; self is excluded and its cwd drives ranking.
- * @param query - optional case-insensitive session-id/cwd/title/display-title substring.
- * @param limit - optional positive result cap.
- * @param signal - optional cancellation boundary for host autocomplete teardown.
- * @returns candidates with canonical mention labels and presentation titles.
- */
-async listCandidates( agent: Agent, query: string = '', limit: number = this.config.candidateLimit, signal?: AbortSignal, ): Promise<SessionReferenceCandidate[]>
-
-/**
- * Remote face of {@link listCandidates}: the configured candidate limit
- * applies, and every candidate carries the canonical mention a host inserts
- * into the prompt draft.
- * @param agent - target agent; self is excluded and its cwd drives ranking.
- * @param query - optional case-insensitive session-id/cwd/title substring.
- * @param signal - caller cancellation.
- * @returns mention-carrying candidates in rank order.
- */
-@Remote('candidates') async remoteExportCandidates( agent: Agent, query: string, signal: AbortSignal, ): Promise<SessionReferenceMentionCandidate[]>
-
-/**
- * Snapshot all references for one accepted direct message and return one aggregated durable context.
- * Automatic budgets use the last assembled route, or agent options before any assembly.
- * Missing model capacity or adapter uses 64 KiB; other metadata lookup failures and cancellation reject preparation.
- * Truncated previews include omission facts and a full-snapshot spill locator, or an explicit unavailable notice.
- * Cancellation prevents context publication, including when storage completes after cancellation.
- * @param agent - target agent; references to it are rejected.
- * @param content - already host-normalized readable message content.
- * @param references - structured source sessions in mention order.
- * @param signal - optional cancellation boundary for the active turn.
- * @returns detached content and optional referenced-session context.
- */
-async prepare( agent: Agent, content: ContentBlock[], references: SessionReferenceInput[], signal?: AbortSignal, ): Promise<PreparedReferencedMessage>
-```
-
-Types: [Agent](./core.md) · [ContentBlock](./llm-streaming.md)
-
-Source: [`packages/context/session-reference/src/index.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/context/session-reference/src/index.ts)
-<!-- END GENERATED cordis-surface -->
+---
+editSource: "docs/subsystems/session-reference.md"
+rawMarkdownPath: "en/reference/subsystems/session-reference.md"
+outline: [2,3]
+---
+
+# Session References
+
+Host-backed file discovery plus structured cross-session reference requests and prepared message contexts. The [file-reference contract](https://github.com/deepseek-ai/deepseek-harness/tree/master/packages/context/file-reference) owns path-only completion records and grammar; the [session-reference contract](https://github.com/deepseek-ai/deepseek-harness/tree/master/packages/context/session-reference) defines canonical URIs, current-surface projection, tag-safe JSON and byte retention, stable errors, and the untrusted model prompt. Host adapters use these types instead of passing their UI mention syntax into the agent core.
+
+Sources: [`packages/context/file-reference/src/types.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/context/file-reference/src/types.ts) · [`packages/context/session-reference/src/types.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/context/session-reference/src/types.ts)
+
+## File candidates
+
+`FileReferenceCandidate` is the path-only discovery result. The addressed agent supplies the working-directory scope; providers decide ranking and namespace access without reading file contents.
+
+```ts type-equiv
+/** One path-only completion candidate inside the target session cwd. */
+interface FileReferenceCandidate {
+  /** User-facing path accepted by normal prompts and filesystem tools. */
+  path: string
+  /** Directories keep completion open; files finish the mention. */
+  kind: 'file' | 'directory'
+}
+```
+
+## Inputs and candidates
+
+`SessionReferenceInput` is the host-independent selection. The id is authoritative; the label is display metadata carried into the snapshot.
+
+```ts type-equiv
+/** One source session selected by a host. */
+interface SessionReferenceInput {
+  /** Opaque source session identity. */
+  sessionId: SessionId
+  /** Optional user-facing mention label. */
+  label?: string
+}
+```
+
+`SessionReferenceCandidate` is host-facing discovery output. Its `label` uses the latest Session title when present, while its optional display text prefers a subagent's durable creation label; filtering searches both alongside Session id and cwd, never transcript text. The Remote candidate's canonical mention uses the display text when present.
+
+```ts type-equiv
+/** One host-facing candidate from exact session metadata. */
+interface SessionReferenceCandidate {
+  /** Opaque source session identity. */
+  sessionId: SessionId
+  /** Latest log-backed title, falling back to the opaque session id. */
+  label: string
+  /** Display and canonical-mention text, preferring a subagent's durable creation label over {@link label}. */
+  displayTitle?: string
+  /** Source session working directory, when recorded. */
+  cwd?: string
+  /**
+   * True when {@link SessionReferenceCandidate.cwd} is recorded and equals the
+   * requesting agent's. Hosts that only surface a distinguishing location
+   * read this instead of comparing paths they never received.
+   */
+  sameWorkspace: boolean
+  /** Source session creation time in Unix epoch milliseconds. */
+  createdAt: number
+}
+```
+
+The `sessionReferenceResolver/candidates` Remote method serves the same discovery to browser consumers and attaches each candidate's canonical prompt mention.
+
+```ts type-equiv
+/** One discovery candidate carrying its canonical prompt mention. */
+interface SessionReferenceMentionCandidate extends SessionReferenceCandidate {
+  /** Canonical `@[label](dsh-session:…)` mention serialized into the prompt draft. */
+  mention: string
+}
+```
+
+## Prepared messages
+
+Preparation preserves readable current-message content and returns at most one aggregated context. Its durable source records keep `capturedThroughSeq` as a coordinate in the referenced Session's original generation; they never reinterpret it as a seq in the containing Session. `capturedFormatVersion` records that generation, with absence meaning released format v0.
+
+```ts type-equiv
+/** Durable source session, cited event seqs, and snapshot facts for prepared cross-session context. */
+interface SessionReferenceSource {
+  kind: 'session-reference'
+  /** Material lifted out of another session's log (`recall` context form). */
+  form: 'recall'
+  version: 1
+  references: {
+    sessionId: string
+    label: string
+    /** Source Session format generation; absence identifies version 0. */
+    capturedFormatVersion?: number
+    capturedThroughSeq: OptionalSessionSeq
+    compacted: boolean
+    originalMessages: number
+    retainedMessages: number
+    omittedMessages: number
+    omittedBytes: number
+    truncated: boolean
+    inputIndex: number
+  }[]
+}
+```
+
+```ts type-equiv
+/** Direct message content and optional referenced-session context. */
+interface PreparedReferencedMessage {
+  /** Readable message content after host mention tokens are removed. */
+  content: ContentBlock[]
+  /** Aggregated untrusted snapshot, absent when the message has no references. */
+  additionalContext?: UserMessage
+}
+```
+
+## Errors
+
+`SessionReferenceError.code` separates invalid configuration or input, self-reference, count limits, source-read failure, budget failure, and cancellation. Host protocols map these codes to their own error envelopes without inspecting prompt bytes.
+
+```ts type-equiv
+/** Stable failure codes exposed to host adapters. */
+type SessionReferenceErrorCode =
+  | 'SESSION_REFERENCE_INVALID_CONFIG'
+  | 'SESSION_REFERENCE_INVALID_REFERENCE'
+  | 'SESSION_REFERENCE_SELF_REFERENCE'
+  | 'SESSION_REFERENCE_TOO_MANY'
+  | 'SESSION_REFERENCE_READ_FAILED'
+  | 'SESSION_REFERENCE_BUDGET_EXCEEDED'
+  | 'SESSION_REFERENCE_CANCELLED'
+```
+
+<!-- BEGIN GENERATED cordis-surface (gen-cordis-catalog.ts) — do not edit between markers -->
+
+<a id="cordis-surface"></a>
+
+## Cordis API
+
+Generated from source by `scripts/gen-cordis-catalog.ts` (verified fresh by `pnpm run verify-cordis-catalog` in doc-sync; regenerate with `pnpm run gen-cordis-catalog`) — the language sides differ only in locale-specific paired document paths. Signature blocks use a `ts cordis-catalog` fence and keep the original source JSDoc; dispatch modes are defined in the [primer](../cordis-primer.md#dispatch-modes), and the framework-inherited `ctx` API lives in [cordis-api/inherited.md](../cordis-api/inherited.md).
+
+<a id="ctxfilereferences--filereferenceservice-abstract-seam"></a>
+
+### `ctx.fileReferences` — `FileReferenceService` (abstract seam)
+
+Host capability for cancellable file-reference discovery.
+
+```ts cordis-catalog
+/**
+ * List file and directory candidates for one agent's working directory.
+ * @param agent - target agent whose session cwd bounds discovery.
+ * @param query - path text following `@` or `@"`.
+ * @param signal - caller cancellation.
+ * @returns deterministic path-only candidates.
+ */
+abstract list( agent: Agent, query: string, signal: AbortSignal, ): Promise<FileReferenceCandidate[]>
+```
+
+Types: [Agent](./core.md)
+
+Source: [`packages/context/file-reference/src/index.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/context/file-reference/src/index.ts)
+
+<a id="ctxsessionfilereferences--sessionfilereferences"></a>
+
+### `ctx.sessionFileReferences` — `SessionFileReferences`
+
+Host Remote adapter over the composed file-reference provider.
+
+```ts cordis-catalog
+/**
+ * List file and directory candidates for one Agent's working directory.
+ * @param agent - target Agent resolved from the Session identity on the wire.
+ * @param query - path text following `@` or `@"`.
+ * @param signal - caller cancellation.
+ * @returns deterministic path-only candidates from the composed provider.
+ */
+@Remote list( agent: Agent, query: string, signal: AbortSignal, ): Promise<FileReferenceCandidate[]>
+```
+
+Types: [Agent](./core.md)
+
+Source: [`packages/api/session-controller/src/file-references.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/api/session-controller/src/file-references.ts)
+
+<a id="ctxsessionreferenceresolver--sessionreferenceresolver"></a>
+
+### `ctx.sessionReferenceResolver` — `SessionReferenceResolver`
+
+Exact-read consumer that prepares immutable cross-session message context.
+
+```ts cordis-catalog
+/**
+ * List reference candidates, ranked by working-directory affinity.
+ *
+ * Discovery runs at keystroke rate, so titles and subagent labels only ever
+ * come from projection reads; sessions without either fall back to their id.
+ * @param agent - target agent; self is excluded and its cwd drives ranking.
+ * @param query - optional search text: label and display title match
+ * fuzzily, session id and working directory as substrings. Matches keep the
+ * working-directory affinity order; relevance breaks ties within it.
+ * @param limit - optional positive result cap.
+ * @param signal - optional cancellation boundary for host autocomplete teardown.
+ * @returns candidates with canonical mention labels and presentation titles.
+ */
+async listCandidates( agent: Agent, query: string = '', limit: number = this.config.candidateLimit, signal?: AbortSignal, ): Promise<SessionReferenceCandidate[]>
+
+/**
+ * Remote face of {@link listCandidates}: the configured candidate limit
+ * applies, and every candidate carries the canonical mention a host inserts
+ * into the prompt draft.
+ * @param agent - target agent; self is excluded and its cwd drives ranking.
+ * @param query - optional search text, matched as {@link listCandidates} matches it.
+ * @param signal - caller cancellation.
+ * @returns mention-carrying candidates in rank order.
+ */
+@Remote('candidates') async remoteExportCandidates( agent: Agent, query: string, signal: AbortSignal, ): Promise<SessionReferenceMentionCandidate[]>
+
+/**
+ * Snapshot all references for one accepted direct message and return one aggregated durable context.
+ * Automatic budgets use the context capacity of `route`.
+ * Missing model capacity or adapter uses 64 KiB; other metadata lookup failures and cancellation reject preparation.
+ * Truncated previews include omission facts and a full-snapshot spill locator, or an explicit unavailable notice.
+ * Cancellation prevents context publication, including when storage completes after cancellation.
+ * @param agent - target agent; references to it are rejected.
+ * @param content - already host-normalized readable message content.
+ * @param references - structured source sessions in mention order.
+ * @param route - provider and model whose context capacity sizes the previews.
+ * @param signal - optional cancellation boundary for the active turn.
+ * @returns detached content and optional referenced-session context.
+ */
+async prepare( agent: Agent, content: ContentBlock[], references: SessionReferenceInput[], route: Readonly<Pick<LlmCallConfig, 'provider' | 'model'>>, signal?: AbortSignal, ): Promise<PreparedReferencedMessage>
+```
+
+Types: [Agent](./core.md) · [ContentBlock](./llm-streaming.md) · [LlmCallConfig](./llm-streaming.md)
+
+Source: [`packages/context/session-reference/src/index.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/context/session-reference/src/index.ts)
+<!-- END GENERATED cordis-surface -->