| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608 |
- /**
- * Tool registry, model presentation modes, and pre/guard/around/post/result
- * execution pipeline.
- * @module @deepseek-ai/dsh-tools
- */
- import { Context, Service } from 'cordis'
- import z from 'schemastery'
- import { AnonymousEntries, NamedEntries, ScopedLayers, scopeOf, scopeTarget } from '@deepseek-ai/dsh-scope'
- import type { ScopeKey, ScopeLayer, Scoped } from '@deepseek-ai/dsh-scope'
- import type { CallId, ContentBlock, ToolSchema } from '@deepseek-ai/dsh-llm'
- import { assertNever, deepFreeze, HarnessError } from '@deepseek-ai/dsh-llm'
- import type { Agent } from '@deepseek-ai/dsh-agent'
- import { snapshotJsonValue } from '@deepseek-ai/dsh-session'
- import type { JsonValue, UserMessage } from '@deepseek-ai/dsh-session'
- import type { ToolProviderResult } from '@deepseek-ai/dsh-system-prompt'
- import type { CodeRuntime } from '@deepseek-ai/dsh-code-runtime'
- // Type-only: makes `ctx.get('approval')` resolve to the ApprovalService
- // augmentation. The seam stays optional at runtime — see `serviceAsk`.
- import type {} from '@deepseek-ai/dsh-user-approval'
- import type { ToolCallView, ToolResultView } from './presentation.ts'
- import { assertSupportedJsonSchema, validateJsonSchemaValue } from './json-schema.ts'
- import type { JsonSchemaNode } from './json-schema.ts'
- import { createRunCodeTool, RUN_CODE_NAME, SDK_SECTION_ORDER } from './code-mode.ts'
- import { renderToolsSdk } from './ts-types.ts'
- import type { ToolSdkSchema } from './ts-types.ts'
- export {
- defineTool,
- valueSchemaSpecToJsonSchema,
- parameterSchemaSpecToJsonSchema,
- validateArgs,
- ToolArgsError,
- type ValueSchemaAnnotations,
- type StringValueSchemaSpec,
- type NumberValueSchemaSpec,
- type IntegerValueSchemaSpec,
- type BooleanValueSchemaSpec,
- type NullValueSchemaSpec,
- type ArrayValueSchemaSpec,
- type ObjectValueSchemaSpec,
- type JsonValueSchemaSpec,
- type OneOfValueSchemaSpec,
- type ValueSchemaSpec,
- type ParameterPropertySpec,
- type ParameterSchemaSpec,
- type ParameterJsonSchema,
- type InferValue,
- type InferArgs,
- type DefineToolOptions,
- } from './schema.ts'
- export {
- assertSupportedJsonSchema,
- assertObjectJsonSchema,
- validateJsonSchemaValue,
- JsonSchemaError,
- type JsonSchemaNode,
- type ObjectJsonSchema,
- type JsonSchemaType,
- type JsonSchemaScalar,
- } from './json-schema.ts'
- export type { JsonValue } from '@deepseek-ai/dsh-session'
- export { CodeRunFailedError, RUN_CODE_NAME } from './code-mode.ts'
- export { jsonSchemaToTs, renderToolsSdk } from './ts-types.ts'
- export { defineContentToolFixture, type ContentToolFixtureOptions } from './testing.ts'
- // The render-intent vocabulary a tool declares via `presentCall`/`presentResult`
- // lives in its own UI-facing module; re-export it so `@deepseek-ai/dsh-tools`
- // stays the single public surface for tool producers and UI adapters.
- export type {
- ToolCallKind,
- FileLocation,
- FileDiff,
- ReadFileLine,
- ToolCallView,
- GenericCallView,
- TerminalCallView,
- DiffCallView,
- ToolResultView,
- GenericResultView,
- TerminalResultView,
- DiffResultView,
- SearchResultView,
- SearchMatchesResultView,
- SearchPathsResultView,
- SearchFileMatches,
- SearchLineMatch,
- ReadResultView,
- WebResultView,
- WebSearchResultView,
- WebFetchResultView,
- WebSource,
- } from './presentation.ts'
- declare module 'cordis' {
- interface Context {
- tools: ToolRegistry
- }
- interface Events {
- /**
- * Allow, deny, or ask before dispatch. `next()` delegates to allow; missing
- * approval support turns `ask` into denial. Async gates must observe
- * `exec.signal`; the registry rechecks cancellation after they settle but
- * never abandons their promise.
- * Scope-filtered dispatch (`@deepseek-ai/dsh-scope`): agent-scoped listeners receive only that agent's calls.
- * @param exec - the pending call (name, parsed arguments, caller agent).
- * @mode waterfall
- */
- 'tools/pre-execute'(this: Scoped<ToolRegistry>, exec: ToolExecution, next: () => Promise<PreToolDecision>): Promise<PreToolDecision>
- /**
- * Around-dispatch waterfall for timeout, retry, or metrics. `next()` returns
- * a normalized result; wrappers may change only `exec.signal`, while call
- * identity remains immutable. The registry re-fuses the original caller
- * signal before the body, so replacement cannot detach caller cancellation;
- * wrappers must still restore their signal and reach quiescence.
- * Scope-filtered dispatch (`@deepseek-ai/dsh-scope`): agent-scoped listeners receive only that agent's calls.
- * @param exec - the allowed call about to dispatch (name, parsed arguments, caller agent, signal).
- * @mode waterfall
- */
- 'tools/execute'(this: Scoped<ToolRegistry>, exec: ToolDispatchExecution, next: () => Promise<ToolExecutionResult>): Promise<ToolExecutionResult>
- /**
- * Accept, replace, enrich, or block a normalized dispatch result. `next()`
- * accepts it unchanged; thrown tools still reach this seam as errors. Async
- * listeners must observe `exec.signal`; after they settle, caller
- * cancellation replaces only a successful accepted outcome with the code
- * selected by whether the tool body was invoked.
- * Scope-filtered dispatch (`@deepseek-ai/dsh-scope`): agent-scoped listeners receive only that agent's calls.
- * @param exec - the call that just ran (name, parsed arguments, caller agent).
- * @param result - the dispatch outcome a listener may accept, replace, or block.
- * @mode waterfall
- */
- 'tools/post-execute'(this: Scoped<ToolRegistry>, exec: ToolExecution, result: Readonly<ToolExecutionResult>, next: () => Promise<PostToolDecision>): Promise<PostToolDecision>
- /**
- * Shape the DURABLE LOG COPY of one `run_code` sub-dispatch outcome before
- * the bridge appends its `tool/code-dispatch` event. `next()` keeps the
- * content unchanged; a listener may return replacement blocks (e.g. the
- * spill policy's preview + locator for an oversized text result). Only the
- * logged copy is affected — the program already received the complete
- * value, and the model sees neither. A throwing listener is contained:
- * the bridge falls back to logging the unshaped content.
- * Scope-filtered dispatch (`@deepseek-ai/dsh-scope`): agent-scoped listeners receive only that agent's dispatches.
- * @param dispatch - the parent execution, sub-call identity, and the settled content to log.
- * @mode waterfall
- */
- 'tools/code-dispatch-log'(this: Scoped<ToolRegistry>, dispatch: CodeDispatchLog, next: () => Promise<ContentBlock[]>): Promise<ContentBlock[]>
- /**
- * Observe the frozen, lossless-JSON final outcome. Listener failures are contained.
- * Scope-filtered dispatch (`@deepseek-ai/dsh-scope`): keyed by `exec.agent`.
- * @param exec - the execution object that traversed the pipeline.
- * @param result - a deep-frozen snapshot of the final returned result.
- * @mode emit
- */
- 'tools/result'(this: Scoped<ToolRegistry>, exec: Readonly<ToolExecution>, result: Readonly<ToolExecutionResult>): undefined
- /**
- * A tool was registered or unregistered, or a scoped restriction changed
- * (the available tool set changed — possibly for one scope only). An
- * UNFILTERED registry-subject notification, deliberately not scope-filtered
- * dispatch: a global change concerns every agent's next assembly, so a
- * scoped listener subscribing here sees every change, not just its own
- * scope's.
- * @mode emit
- */
- 'tools/change'(): void
- }
- }
- /** Tool-owned canonical output contract used after the body returns a JSON value. */
- export interface ToolOutputDefinition {
- /** Raw supported JSON Schema enforced against every successful canonical value. */
- readonly schema: JsonSchemaNode
- /** Pure projection from validated arguments and value to Native/model content. */
- render(args: unknown, value: JsonValue): ContentBlock[]
- /** Pure replayable presentation projection, computed only for surface calls. */
- presentationMeta?(args: unknown, value: JsonValue): JsonValue
- }
- /** A registered tool: its schema plus the execution function. */
- export interface ToolDefinition extends ToolSchema {
- /** Mandatory canonical output declaration. */
- readonly output: ToolOutputDefinition
- /**
- * Run one accepted call and return only its canonical lossless-JSON value.
- * Async work must observe or forward `exec.signal` and settle only after its
- * owned work reaches quiescence. The registry preserves caller cancellation
- * through around-dispatch signal replacement and does not abandon this
- * promise, but it cannot hard-kill same-process code.
- * @param args - losslessly snapshotted, frozen model arguments.
- * @param exec - execution identity, cancellation signal, and context deferral.
- * @returns the canonical value declared by `output.schema`.
- */
- execute(args: unknown, exec: ToolRunContext): Promise<unknown>
- /**
- * Synchronous last-mile transform for model-facing content. The registry
- * snapshots this callback when execution starts and invokes it exactly once
- * for every normalized outcome, including pipeline failures that bypass
- * `tools/post-execute`, immediately before lossless materialization.
- * Returning `undefined` preserves the content; every other result field
- * remains registry-owned. The callback must be total and must not throw.
- * @param exec - immutable execution identity and arguments.
- * @param result - complete normalized outcome before materialization.
- * @returns replacement content, or `undefined` to preserve it.
- */
- finalizeContent?(exec: Readonly<ToolExecution>, result: Readonly<ToolExecutionResult>): ContentBlock[] | undefined
- /**
- * Cooperative tool-call timeout budget in milliseconds. Omit for no deadline.
- * Enforced by `@deepseek-ai/dsh-timeout-policy` (a `tools/execute` wrapper); it
- * is NEVER sent to the model — `schemas()` whitelists only name/description/
- * parameters. Declaring it asserts this tool forwards `exec.signal` to a
- * cooperative implementation that can reach quiescence when the signal aborts.
- */
- timeoutMs?: number
- /**
- * Pure synchronous classifier for overlap with sibling tool calls. Only
- * `true` opts in; omission, exceptions, non-`true` returns, and invalid
- * `defineTool` arguments are exclusive. This metadata is never model-visible.
- *
- * Opted-in executions must not mutate parent-owned state. Shared state must
- * tolerate concurrent dispatch; recorder races are permitted only when they
- * commute or fail closed. See the
- * [parallel-tool-call Agent Note](../../../../.agents/notes/implemented/feature/2026-07-10-parallel-tool-call-execution.md)
- * for the full contract.
- * @param args - parsed arguments; `defineTool` validates before calling.
- * @returns Whether this call may join a parallel group.
- */
- isConcurrencySafe?(args: unknown): boolean
- /**
- * Optional: how to present the PENDING state of one call in a UI, derived from
- * the call's `args` (parsed arguments, `unknown` — the tool validates/narrows
- * its own input). Returns a {@link ToolCallView} (a `card`-tagged render intent),
- * or `undefined` (or omit the method) to fall back to a generic presentation
- * (title = tool name, raw args as input). Pure and side-effect-free: a UI may
- * call it during live streaming AND a session-log replay, so it must depend
- * only on `args`.
- */
- presentCall?(args: unknown): ToolCallView | undefined
- /**
- * Optional: how to present the COMPLETED state, given the same `args` and the
- * durable result projection (`content`, failure state, and optional `meta`). Returns a
- * {@link ToolResultView}, or `undefined` (or omit the method) to keep the
- * pending title and render the raw result content. Pure and side-effect-free
- * for the same replay reason.
- */
- presentResult?(args: unknown, result: ToolResult): ToolResultView | undefined
- }
- /** The completed outcome handed to {@link ToolDefinition.presentResult}. */
- export interface ToolResult {
- /** The final model-facing content (or the rendered error text on failure). */
- content: ContentBlock[]
- /** Whether the call failed. */
- isError: boolean
- /**
- * The tool-private presentation payload projected by its output declaration
- * and threaded verbatim from the `tool/result` event. Absent when the tool
- * declared no projector or the call was nested under a composite transport.
- */
- meta?: JsonValue
- }
- declare const toolExecutionTokenBrand: unique symbol
- /** Opaque call identity that permits correlation without exposing mutable execution state. */
- export type ToolExecutionToken = symbol & { readonly [toolExecutionTokenBrand]: true }
- /**
- * Caller-supplied description of one tool call. {@link ToolRegistry.execute}
- * adds the registry-owned token to form a pipeline {@link ToolExecution};
- * callers do not choose that token.
- */
- export interface ToolExecutionInput {
- readonly callId: CallId
- readonly name: string
- /** Losslessly JSON-serializable parsed arguments (tools validate their own schema). */
- readonly arguments: unknown
- /** The agent on whose behalf the call runs (set by the agent loop). */
- readonly agent?: Agent
- /**
- * Opaque token of the enclosing transport execution, when one exists. Code
- * Mode sets this on SDK sub-dispatches so commit-style observers can wait for
- * the outer `run_code` outcome without receiving its live mutable execution.
- */
- readonly parent?: ToolExecutionToken
- /** Required caller-owned cancellation for this invocation. */
- readonly signal: AbortSignal
- }
- /**
- * Scheduling mode for one pending call. `parallel` may overlap with siblings;
- * `exclusive` runs alone and forms an ordering barrier.
- */
- export type ToolExecutionMode =
- | { kind: 'parallel' }
- | { kind: 'exclusive' }
- /**
- * One settled `run_code` sub-dispatch about to be logged, as seen by the
- * `tools/code-dispatch-log` waterfall: the parent execution (session owner,
- * outer call identity), the sub-call identity, and the outcome whose durable
- * copy a listener may reshape. `content` is the RENDERED result projection
- * (what a native `tool/result` would carry) — the program itself received
- * the structured `value` (or just the error message on failure); only the
- * `tool/code-dispatch` event's copy changes.
- */
- export interface CodeDispatchLog {
- /** The outer `run_code` execution. */
- readonly exec: ToolExecution
- /** The calling agent (the scope routing key and the spill owner), when the outer call has one. */
- readonly agent?: Agent
- /** Deterministic sub-call id (`<parent>:code:<n>`). */
- readonly subCallId: CallId
- /** The dispatched sub-tool name. */
- readonly name: string
- /** Whether the sub-call settled as an error. */
- readonly isError: boolean
- /** The sub-call's complete model-facing content (the settle event's default payload). */
- readonly content: ContentBlock[]
- }
- /**
- * One pending tool call inside the registry pipeline. Parsed arguments cross
- * one lossless-JSON materialization boundary before policy and are deep-frozen;
- * call identity, the caller signal, and the registry-assigned {@link token} are
- * readonly. The registry freezes the complete object before `tools/result`
- * observers run.
- */
- export interface ToolExecution extends ToolExecutionInput {
- /** Registry-assigned identity shared with nested calls only as their opaque `parent` token. */
- readonly token: ToolExecutionToken
- }
- /**
- * Around-dispatch view of a {@link ToolExecution}. A `tools/execute` wrapper
- * may replace the signal for its delegated lifetime, but it cannot remove it.
- * The registry fuses every replacement with the captured caller signal.
- */
- export interface ToolDispatchExecution extends Omit<ToolExecution, 'signal'> {
- /** Cancellation signal visible to the next wrapper or tool body. */
- signal: AbortSignal
- }
- /**
- * Runtime context handed to a tool implementation after the registry has
- * accepted a {@link ToolExecution}. {@link deferContext} attaches context to
- * this execution's own result — a composite tool ferries nested-dispatch
- * context back to the outer result, and a leaf tool may mint a fresh
- * plugin-sourced instruction; the loop appends it only after the
- * `tool/result`.
- */
- export interface ToolRunContext extends ToolExecution {
- /**
- * Defer one context — typically a nested-dispatch context ferried by a
- * composite tool, or a fresh plugin-sourced instruction — until this tool's
- * final result reaches the agent loop. Contexts retain their individual
- * source and metadata and are emitted in call order.
- */
- deferContext(context: UserMessage): void
- /**
- * Mark a successful final result as terminal for the current agent turn.
- * The marker rides this execution's own result (`concludesTurn` exists only
- * on {@link ToolExecutionSuccess}); a composite that dispatches nested
- * calls forwards it from the nested result, exactly like
- * `additionalContexts`, so only an authoritative nested success can
- * conclude the enclosing run.
- */
- concludeTurn(): void
- }
- /** Registry-owned live execution object; public pipeline views stay readonly. */
- type MutableToolRunContext = Omit<ToolRunContext, 'signal'> & { signal: AbortSignal }
- /**
- * Scheduler-only result after ordered pre-execute and guards. A `post-result`
- * still receives post-execute; a `final-result` bypasses it.
- * @internal
- */
- export type ScheduledToolPreparation =
- | { kind: 'dispatch'; exec: ToolRunContext }
- | { kind: 'post-result'; exec: ToolRunContext; result: ToolExecutionResult }
- | { kind: 'final-result'; exec: ToolRunContext; result: ToolExecutionResult }
- /**
- * Scheduler-only dispatch result. A `post-result` still receives post-execute;
- * a `final-result` already matches {@link ToolRegistry.execute} failure semantics.
- * @internal
- */
- export type ScheduledToolDispatch =
- | { kind: 'post-result'; result: ToolExecutionResult }
- | { kind: 'final-result'; result: ToolExecutionResult }
- /**
- * Symbol-keyed scheduler view that keeps pre/post policy ordered while
- * overlapping dispatch. Ordinary callers use {@link ToolRegistry.execute};
- * this is not a plugin seam.
- * @internal
- */
- export interface ToolRegistryScheduler {
- /** Materialize input, run the ordered pre-execute/guard gate, and decide what stage follows. */
- prepare(exec: ToolExecutionInput): Promise<ScheduledToolPreparation>
- /** Run only the around-dispatch/body stage. */
- dispatch(exec: ToolRunContext): Promise<ScheduledToolDispatch>
- /** Run post-execute and definition-owned content finalization, then materialize and notify. */
- finalize(exec: ToolRunContext, result: ToolExecutionResult): Promise<ToolExecutionResult>
- /** Run definition-owned content finalization, then materialize and notify without post-execute. */
- finish(exec: ToolRunContext, result: ToolExecutionResult): ToolExecutionResult
- }
- /**
- * Scheduler entry point omitted from the generated named service API.
- * @internal
- */
- export const TOOL_REGISTRY_SCHEDULER: unique symbol = Symbol('@deepseek-ai/dsh-tools.scheduler')
- /** Canonical error code for cancellation after a tool body was invoked. */
- export const TOOL_ABORTED = 'ABORTED'
- /** Canonical error code for cancellation before a tool body was invoked. */
- export const TOOL_ABORTED_BEFORE_DISPATCH = 'ABORTED_BEFORE_DISPATCH'
- /** Structured error metadata for a failed tool call (alongside the model-facing text). */
- export interface ToolErrorInfo {
- name: string
- code: string
- }
- /** Canonical failure detail; internal routing information remains optional. */
- export interface ToolFailure {
- /** Human-readable failure message without the Native `Error: ` envelope. */
- message: string
- /** Internal error class/code used by policy and durable diagnostics. */
- info?: ToolErrorInfo
- }
- /**
- * Thrown (internally) when the model requests a tool that isn't registered.
- * Extends {@link HarnessError} (`code: 'UNKNOWN_TOOL'`) so an unknown-tool
- * failure is as routable as a tool-thrown one — retry/sandbox/replay code can
- * distinguish it from a tool body's own error.
- */
- export class ToolNotFoundError extends HarnessError {
- constructor(toolName: string) {
- super(`unknown tool "${toolName}"`, 'UNKNOWN_TOOL')
- this.name = 'ToolNotFoundError'
- }
- }
- /** Thrown when a tool body or post-policy value violates its declared output. */
- export class ToolOutputError extends HarnessError {
- /** Schema/value violations in validation order. */
- readonly violations: string[]
- constructor(toolName: string, violations: string[]) {
- super(`tool "${toolName}" returned invalid output: ${violations.join('; ')}`, 'INVALID_TOOL_OUTPUT')
- this.name = 'ToolOutputError'
- this.violations = violations
- }
- }
- /** Convert one projector exception into the canonical invalid-output failure. */
- function projectionError(toolName: string, projector: 'render' | 'presentationMeta', error: unknown): ToolOutputError {
- return new ToolOutputError(toolName, [`output.${projector} failed: ${errorMessage(error)}`])
- }
- /** Snapshot one projector result before later durable-result materialization. */
- function snapshotProjection<T>(toolName: string, projector: 'render' | 'presentationMeta', candidate: T): T {
- try {
- const detached = snapshotJsonValue(candidate)
- if (detached === undefined) {
- throw new ToolOutputError(toolName, [`output.${projector} returned non-lossless JSON`])
- }
- return detached
- } catch (error: unknown) {
- if (error instanceof ToolOutputError) throw error
- throw projectionError(toolName, projector, error)
- }
- }
- /** Snapshot one body or policy value into the canonical invalid-output failure class. */
- function snapshotToolValue(toolName: string, candidate: unknown): JsonValue {
- try {
- const detached = snapshotJsonValue(candidate)
- if (detached === undefined) throw new ToolOutputError(toolName, ['value is not lossless JSON'])
- return detached as JsonValue
- } catch (error: unknown) {
- if (error instanceof ToolOutputError) throw error
- throw new ToolOutputError(toolName, [`value snapshot failed: ${errorMessage(error)}`])
- }
- }
- /** Successful canonical tool execution, including its Native/model projection. */
- export interface ToolExecutionSuccess {
- readonly isError: false
- /** Execution-local canonical value; deliberately omitted from durable events. */
- readonly value: JsonValue
- readonly content: ContentBlock[]
- readonly error?: never
- readonly meta?: JsonValue
- readonly additionalContexts?: UserMessage[]
- /** The agent loop stops after committing this successful result batch. */
- readonly concludesTurn?: true
- }
- /** Failed canonical tool execution; failures never carry a successful value. */
- export interface ToolExecutionFailure {
- readonly isError: true
- readonly error: ToolFailure
- readonly value?: never
- readonly content: ContentBlock[]
- readonly meta?: JsonValue
- readonly additionalContexts?: UserMessage[]
- readonly concludesTurn?: never
- }
- /** The discriminated, execution-local outcome of one tool call. */
- export type ToolExecutionResult = ToolExecutionSuccess | ToolExecutionFailure
- /**
- * Pre-dispatch decision. `allow` runs the call; `deny` materializes an error;
- * `ask` runs only after an approval service returns `allowed-once` and otherwise
- * denies. Input rewriting is excluded because arguments are already logged and
- * presented.
- */
- export type PreToolDecision =
- | { kind: 'allow' }
- | { kind: 'deny'; reason: string }
- | { kind: 'ask'; reason?: string }
- /**
- * Post-dispatch decision: accept, replace one projection, attach context for the
- * next request, or block by turning corrective feedback into an error result.
- */
- export type PostToolDecision =
- | { kind: 'accept'; content?: ContentBlock[]; value?: never; additionalContexts?: UserMessage[] }
- | { kind: 'accept'; value: JsonValue; content?: never; additionalContexts?: UserMessage[] }
- | { kind: 'block'; feedback: ContentBlock[]; additionalContexts?: UserMessage[] }
- /**
- * Best-effort human-readable message from an arbitrary thrown value: Error
- * instances use `.message`; non-Error objects with a string `message`
- * property (e.g. `throw { message: 'denied' }`) use it too; everything else
- * is stringified.
- */
- function errorMessage(error: unknown): string {
- try {
- if (error instanceof Error) return error.message
- if (typeof error === 'object' && error !== null
- && 'message' in error && typeof error.message === 'string') {
- return error.message
- }
- return String(error)
- } catch {
- // A hostile thrown value can trap `instanceof`, property access, or string
- // coercion. Error normalization is the outermost safety boundary, so its
- // fallback must itself be total.
- return '<unprintable thrown value>'
- }
- }
- /** Derive one failure message from policy feedback without changing its rendered blocks. */
- function failureMessageFromContent(content: ContentBlock[]): string {
- const text = content
- .map(block => block.type === 'text' ? block.text : `[${block.type} content]`)
- .join('\n')
- return text.length > 0 ? text : 'tool result blocked by post-execute policy'
- }
- /** Snapshot and freeze one durable tool-result projection or reject lossy data. */
- function materializePresentation<T>(candidate: T): T {
- const detached = snapshotJsonValue(candidate)
- if (detached === undefined) {
- throw new TypeError('tool result must be losslessly JSON-serializable')
- }
- return deepFreeze(detached)
- }
- /** Structured `{ name, code }` for a thrown HarnessError, else undefined. */
- function errorInfo(error: unknown): ToolErrorInfo | undefined {
- try {
- return error instanceof HarnessError ? { name: error.name, code: error.code } : undefined
- } catch {
- return undefined
- }
- }
- /** How the registry presents its tools to the model (see {@link Config.mode}). */
- export type ToolPresentationMode = 'native' | 'code' | 'both'
- /** Plugin config: how the registered tools are presented to the model. */
- export interface Config {
- /**
- * Model presentation. `native` (default) sends every visible schema; `code`
- * sends only `run_code` plus a generated SDK prompt; `both` sends both forms.
- * Code modes require a TypeScript runtime and fail prompt assembly when it is
- * absent or mismatched. Under `code`, native names in `toolOrder` are invalid.
- */
- mode?: ToolPresentationMode
- /**
- * Concurrency cap for a `run_code` program's overlapping sub-calls
- * (default 10, the loop scheduler's own default). Sub-calls follow the
- * native scheduling contract — only calls whose tools classify
- * concurrency-safe overlap; exclusive calls form barriers — so `1`
- * restores strictly serial dispatch. Must be a positive integer.
- */
- maxParallelSubCalls?: number
- }
- /**
- * Per-scope filter over global tools. Restrictions intersect and do not affect
- * scoped registrations or the reserved Code Mode transport.
- */
- export interface ToolRestriction {
- /** Global tool names that stay visible; everything else is removed. */
- readonly allow?: readonly string[]
- /** Global tool names removed from visibility. */
- readonly deny?: readonly string[]
- }
- /** One restriction compiled at registration for repeated live-global lookup. */
- interface CompiledToolRestriction {
- readonly allow?: ReadonlySet<string>
- readonly deny?: ReadonlySet<string>
- }
- /** One scope's complete registry view, derived in a single layer traversal. */
- interface ToolView {
- /** Visible definitions after restrictions, scoped shadowing, and transport insertion. */
- readonly visible: ReadonlyMap<string, ToolDefinition>
- /** Pre-restriction capability names used by prompt-order validation. */
- readonly knownNames: ReadonlySet<string>
- /** Current global names that a scoped restriction may name. */
- readonly restrictableNames: ReadonlySet<string>
- }
- /**
- * A monotonic execution guard evaluated after every `tools/pre-execute`
- * listener and before the tool body. Returning a reason denies the call;
- * returning `undefined` leaves it unchanged. Because guards have no allow
- * result, listener ordering cannot turn a denial back into permission.
- * @param execution - the identity-protected call after extensible pre-execute policy completed.
- * @returns a final denial reason, or `undefined` to leave the call allowed.
- */
- export type ToolGuard = (execution: Readonly<ToolExecution>) => string | undefined
- /** One scope's complete tool-registry contribution. */
- class ToolLayer implements ScopeLayer {
- readonly tools: NamedEntries<ToolDefinition>
- readonly restrictions = new AnonymousEntries<CompiledToolRestriction>()
- readonly guards = new AnonymousEntries<ToolGuard>()
- constructor(scope: ScopeKey | undefined) {
- this.tools = new NamedEntries(name => new Error(scope === undefined
- ? `tool "${name}" is already registered (for a per-agent variant, register through that agent's \`agent.ctx\` instead)`
- : `tool "${name}" is already registered in this scope`))
- }
- /** Whether every contribution table in this aggregate layer is empty. */
- isEmpty(): boolean {
- return this.tools.isEmpty() && this.restrictions.isEmpty() && this.guards.isEmpty()
- }
- /** Whether every compiled restriction in this layer admits a global tool name. */
- admits(name: string): boolean {
- for (const filter of this.restrictions.values()) {
- if ((filter.allow !== undefined && !filter.allow.has(name))
- || (filter.deny !== undefined && filter.deny.has(name))) return false
- }
- return true
- }
- /** First monotonic denial from this layer's live guard registrations. */
- guardReason(exec: ToolExecution): string | undefined {
- for (const guard of this.guards.values()) {
- const reason = guard(exec)
- if (reason !== undefined) return reason
- }
- return undefined
- }
- }
- /** Approval decision plus whether the approval channel reported cancellation. */
- interface ToolAskResolution {
- readonly decision: Extract<PreToolDecision, { kind: 'allow' | 'deny' }>
- readonly approvalCancelled: boolean
- }
- /** Caller cancellation and dispatch state kept outside the around-wrapper view. */
- interface ToolCancellationState {
- readonly callerSignal: AbortSignal
- bodyInvoked: boolean
- }
- /** One dispatch-scoped fused signal plus listener cleanup after the body settles. */
- interface FusedToolSignal {
- readonly signal: AbortSignal
- dispose(): void
- }
- /** Resolve the run_code overlap cap at the owning config boundary (direct construction bypasses the Loader schema). */
- function resolveMaxParallelSubCalls(value: number | undefined): number {
- const maxParallelSubCalls = value ?? 10
- if (!Number.isInteger(maxParallelSubCalls) || maxParallelSubCalls < 1) {
- throw new Error('maxParallelSubCalls must be a positive integer')
- }
- return maxParallelSubCalls
- }
- /**
- * Tool registry and execution pipeline. Scoped registrations shadow globals;
- * one visibility resolver feeds presentation, lookup, and dispatch.
- */
- export class ToolRegistry extends Service {
- static inject = ['systemPrompt']
- static Config: z<Config> = z.object({
- mode: z.union(['native', 'code', 'both'] as const).default('native'),
- maxParallelSubCalls: z.natural().min(1).default(10),
- })
- /** Internal staged view consumed by `dsh-agent-loop`'s parallel scheduler. */
- readonly [TOOL_REGISTRY_SCHEDULER]: ToolRegistryScheduler = {
- prepare: exec => this.prepareScheduledExecution(exec),
- dispatch: exec => this.dispatchScheduledExecution(exec),
- finalize: (exec, result) => this.finalizeScheduledExecution(exec, result),
- finish: (exec, result) => this.finishScheduledExecution(exec, result),
- }
- /** Context deferred by a running tool body, keyed by its scheduler-owned execution. */
- private deferredContexts = new WeakMap<ToolRunContext, UserMessage[]>()
- /** Executions whose tool body declared the current turn complete. */
- private concludingExecutions = new WeakSet<ToolExecution>()
- /** Original caller cancellation, kept outside the wrapper-mutable execution object. */
- private cancellationStates = new WeakMap<ToolRunContext, ToolCancellationState>()
- /** Definition-owned final content transform snapshotted before policy begins. */
- private contentFinalizers = new WeakMap<ToolRunContext, ToolDefinition['finalizeContent']>()
- private readonly layers = new ScopedLayers(
- scope => new ToolLayer(scope),
- () => { this.ctx.emit('tools/change') },
- )
- private readonly mode: ToolPresentationMode
- /** Reserved presentation transport, kept outside the filterable registration layers. */
- private readonly codeTransport: ToolDefinition | undefined
- constructor(ctx: Context, config: Config = {}) {
- super(ctx, 'tools')
- // The schema already defaulted an omitted mode; the ?? narrows the
- // optional-input type for direct (non-Loader) construction in tests.
- this.mode = config.mode ?? 'native'
- // `run_code` is presentation infrastructure, not an end capability. It
- // therefore does not enter the global layer: per-agent restrictions must
- // not remove it, and a scoped registration must not shadow it. The
- // visibility resolver appends this reserved definition after resolving
- // the filterable global/scoped capability layers.
- this.codeTransport = this.mode === 'native'
- ? undefined
- : createRunCodeTool(this, {
- requireRuntime: () => this.requireCodeRuntime(),
- maxParallel: resolveMaxParallelSubCalls(config.maxParallelSubCalls),
- shapeDispatchLog: dispatch => this.shapeDispatchLog(dispatch),
- })
- ctx.systemPrompt.tools(context => this.wireSchemas(context.scope))
- if (this.mode !== 'native') {
- ctx.systemPrompt.section({
- name: 'tools:sdk',
- order: SDK_SECTION_ORDER,
- // Regenerate from the calling scope's visible tools in stable order.
- text: (context) => {
- this.requireCodeRuntime()
- return renderToolsSdk(this.sdkSchemas(context.scope))
- },
- })
- }
- }
- /**
- * Build one scope's wire schemas and names for prompt-order validation.
- * Restrictions do not make known tools invalid, but a mode collapse does.
- */
- private wireSchemas(scope?: ScopeKey): ToolProviderResult {
- const view = this.view(scope)
- const schemas = [...view.visible.values()].map(definition => this.schemaOf(definition, false))
- if (this.mode === 'native') {
- return { schemas, knownNames: [...view.knownNames] }
- }
- this.requireCodeRuntime()
- if (this.mode === 'code') {
- return {
- schemas: schemas.filter(schema => schema.name === RUN_CODE_NAME),
- knownNames: [RUN_CODE_NAME],
- }
- }
- return { schemas, knownNames: [...view.knownNames, RUN_CODE_NAME] }
- }
- /**
- * Resolve the code runtime or throw the actionable misconfiguration error.
- * Read at use time (assembly / run_code execution), NOT via static
- * `inject`: an inject entry would hold `ctx.tools` — and every tool plugin
- * behind it — hostage to a code runtime existing even under `mode:
- * 'native'` (the loop's optional-backend idiom, same as
- * `sessionPersistence`).
- */
- private requireCodeRuntime(): CodeRuntime {
- const runtime = this.ctx.get('codeRuntime')
- if (!runtime) {
- throw new Error(`dsh-tools: mode "${this.mode}" requires a code runtime — load a ctx.codeRuntime implementation (e.g. @deepseek-ai/dsh-code-runtime-worker) or set tools mode to "native"`)
- }
- if (runtime.language !== 'typescript') {
- throw new Error(`dsh-tools: mode "${this.mode}" generates a TypeScript SDK, but the loaded code runtime's language is "${runtime.language}"`)
- }
- return runtime
- }
- /**
- * Register globally or in the calling agent scope. Scoped tools shadow
- * globals; duplicates within one layer and the reserved `run_code` name fail.
- * @param definition - tool schema, execution, and optional finalization/presentation callbacks.
- * @returns the exact disposer that unregisters the tool.
- */
- register(definition: ToolDefinition): () => void {
- const name = definition.name
- const output = (definition as Partial<ToolDefinition>).output
- if (output === undefined || typeof output !== 'object'
- || typeof output.render !== 'function'
- || (output.presentationMeta !== undefined && typeof output.presentationMeta !== 'function')) {
- throw new TypeError(`tool "${name}" must declare output { schema, render, presentationMeta? }`)
- }
- assertSupportedJsonSchema(output.schema)
- const timeoutMs = definition.timeoutMs
- if (timeoutMs !== undefined
- && (!Number.isFinite(timeoutMs) || timeoutMs <= 0)) {
- throw new TypeError(`tool "${name}" timeoutMs must be a positive finite number`)
- }
- if (this.codeTransport !== undefined && name === RUN_CODE_NAME) {
- throw new Error(`tool name "${RUN_CODE_NAME}" is reserved for the Code Mode presentation transport and cannot be registered or shadowed`)
- }
- return this.layers.effect(
- this.ctx,
- layer => layer.tools.insert(name, definition),
- { label: 'tools.register()' },
- )
- }
- /**
- * Restrict global tools for the calling agent scope. Empty filters, unknown
- * names, scope-local names, and reserved transport names fail. Restrictions
- * intersect; scoped registrations remain visible.
- * @param filter - global-surface mask: `allow` (keep only) and/or `deny` (remove).
- * @returns the exact disposer that lifts this restriction.
- */
- restrict(filter: ToolRestriction): () => void {
- const scope = scopeOf(this.ctx)
- if (scope === undefined) {
- throw new Error('tools.restrict() requires a scoped context (agent.ctx): a context-global restriction would mask every agent — deny the tool for the intended agent instead')
- }
- const allow = filter.allow
- const deny = filter.deny
- if (allow === undefined && deny === undefined) {
- throw new Error('tools.restrict({}) is a no-op: pass `allow` and/or `deny` (an empty filter is almost always a materialized-empty-config bug)')
- }
- const compiled: CompiledToolRestriction = {
- ...allow !== undefined ? { allow: new Set(allow) } : {},
- ...deny !== undefined ? { deny: new Set(deny) } : {},
- }
- if (this.codeTransport !== undefined
- && [...allow ?? [], ...deny ?? []].includes(RUN_CODE_NAME)) {
- throw new Error(`tools.restrict() cannot name reserved Code Mode presentation transport "${RUN_CODE_NAME}"; restrict end-capability tools instead`)
- }
- const known = this.view(scope).restrictableNames
- const unknown = [...allow ?? [], ...deny ?? []].filter(name => !known.has(name))
- if (unknown.length > 0) {
- throw new Error(`tools.restrict() names unknown global tool${unknown.length > 1 ? 's' : ''} ${unknown.map(n => `"${n}"`).join(', ')}; known global tools: ${[...known].sort().join(', ') || '(none)'}`)
- }
- return this.layers.effect(
- this.ctx,
- layer => layer.restrictions.append(compiled),
- { label: 'tools.restrict()' },
- )
- }
- /**
- * Register a monotonic guard after the extensible `tools/pre-execute`
- * waterfall. A plain-context guard applies globally; one registered through
- * `agent.ctx` applies only to that agent. Any matching guard may deny by
- * returning a reason, while no guard can force-allow a call another guard
- * denied. The exact effect disposer is returned for ordered ownership and
- * HMR cleanup.
- * @param guard - synchronous check; a returned string denies the execution.
- * @returns the exact disposer that unregisters the guard.
- */
- guard(guard: ToolGuard): () => void {
- return this.layers.effect(
- this.ctx,
- layer => layer.guards.append(guard),
- { label: 'tools.guard()', notify: false },
- )
- }
- /** First monotonic denial from the global then matching scoped guard layers. */
- private guardReason(exec: ToolExecution): string | undefined {
- const globalReason = this.layers.global.guardReason(exec)
- if (globalReason !== undefined) return globalReason
- return exec.agent === undefined ? undefined : this.layers.peek(exec.agent)?.guardReason(exec)
- }
- /**
- * Resolve every registry fact one scope needs in one layer traversal. The
- * visible map applies global restrictions, scoped shadowing, and the reserved
- * presentation transport; the other sets retain the pre-restriction facts
- * needed by restriction and prompt-order validation.
- * @param scope - the viewing scope (the agent), or undefined for the global view.
- * @returns the complete derived view for that scope.
- */
- private view(scope?: ScopeKey): ToolView {
- const layer = this.layers.peek(scope)
- const visible = new Map<string, ToolDefinition>()
- const knownNames = new Set<string>()
- const restrictableNames = new Set<string>()
- for (const [name, definition] of this.layers.global.tools.entries()) {
- knownNames.add(name)
- restrictableNames.add(name)
- if (layer?.admits(name) ?? true) visible.set(name, definition)
- }
- // Scoped layer second: same-name entries REPLACE (shadow) the global ones,
- // and scope-local registrations are never part of the global filter above.
- for (const [name, definition] of layer?.tools.entries() ?? []) {
- knownNames.add(name)
- visible.set(name, definition)
- }
- // Presentation infrastructure is resolved last and outside capability
- // filtering. Registration rejects this reserved name, so the insertion is
- // an invariant assertion as well as protection against future layer changes.
- if (this.codeTransport !== undefined) {
- visible.set(RUN_CODE_NAME, this.codeTransport)
- }
- return { visible, knownNames, restrictableNames }
- }
- /**
- * Look up a tool as one scope sees it (scoped
- * shadows global; a restricted-away global reads as absent). Presenters pass
- * the calling agent so the rendered card matches the definition that
- * actually executed.
- * @param name - the tool name as registered.
- * @param scope - the viewing scope (the agent); omitted = the global view.
- * @returns the definition the scope resolves, or undefined when none is visible.
- */
- get(name: string, scope?: ScopeKey): ToolDefinition | undefined {
- return this.view(scope).visible.get(name)
- }
- /**
- * Project visible definitions onto the allowlisted model-facing schema fields,
- * excluding execution and presentation callbacks.
- * @param scope - the viewing scope (the agent); omitted = the global view.
- * @returns one deep-cloned schema per visible tool.
- */
- schemas(scope?: ScopeKey): ToolSchema[] {
- return [...this.view(scope).visible.values()].map(definition => this.schemaOf(definition, true))
- }
- /** Project visible callable tools onto the generated Code Mode SDK contract. */
- private sdkSchemas(scope?: ScopeKey): ToolSdkSchema[] {
- return [...this.view(scope).visible.values()]
- .filter(definition => definition.name !== RUN_CODE_NAME)
- .map((definition): ToolSdkSchema => {
- const output = snapshotJsonValue(definition.output.schema)
- /* v8 ignore next -- registration already validated and retained this schema as lossless JSON. */
- if (output === undefined) {
- throw new Error(`tool "${definition.name}" output schema must be lossless JSON before SDK projection`)
- }
- return {
- ...this.schemaOf(definition, true),
- output,
- }
- })
- }
- /** Project one definition onto the model-facing schema fields. */
- private schemaOf(definition: ToolDefinition, detachParameters: boolean): ToolSchema {
- const { name, description, parameters } = definition
- const detached = detachParameters ? snapshotJsonValue(parameters) : parameters
- if (detached === undefined) {
- throw new Error(`tool "${name}" parameters must be lossless JSON before schema projection`)
- }
- return {
- name,
- description,
- parameters: detached,
- }
- }
- /**
- * Classify a pending call through the caller's visible tool definition. Only
- * an exact `true` is parallel; unknown, hidden, undeclared, invalid, or
- * throwing classifiers are exclusive.
- * @param exec - call name, parsed arguments, and optional agent scope.
- * @returns the fail-closed scheduling mode.
- */
- executionMode(exec: ToolExecutionInput): ToolExecutionMode {
- const tool = this.get(exec.name, exec.agent)
- if (!tool?.isConcurrencySafe) return { kind: 'exclusive' }
- try {
- const concurrencySafe: unknown = tool.isConcurrencySafe(exec.arguments)
- return concurrencySafe === true ? { kind: 'parallel' } : { kind: 'exclusive' }
- } catch {
- return { kind: 'exclusive' }
- }
- }
- /**
- * Run the `tools/code-dispatch-log` waterfall over one settled sub-dispatch
- * and return the content the bridge should log on `tool/code-dispatch`.
- * Contained: a throwing listener falls back to the unshaped content — log
- * shaping must never fail the dispatch or lose the settle event. Private:
- * the ONE consumer is the `run_code` bridge this registry constructs, which
- * receives it as a capability parameter (the `requireRuntime` idiom) — the
- * waterfall, not this invoker, is the public extension seam.
- */
- private async shapeDispatchLog(dispatch: CodeDispatchLog): Promise<ContentBlock[]> {
- try {
- return await this.ctx.waterfall(
- scopeTarget(this, dispatch.agent), 'tools/code-dispatch-log', dispatch,
- () => Promise.resolve(dispatch.content),
- )
- } catch (error: unknown) {
- this.ctx.logger.warn(`tools: code-dispatch-log listener failed for ${dispatch.name}: ${errorMessage(error)}; logging the unshaped content`)
- return dispatch.content
- }
- }
- /**
- * Execute through pre-policy, guards, around-dispatch, post-policy,
- * definition-owned content finalization, and final notification. Tool and
- * listener failures resolve as materialized error results; an invisible tool
- * reports `UNKNOWN_TOOL`. The returned outcome is the same lossless, frozen
- * snapshot final observers receive. Cancellation
- * arriving after entry and before final result materialization skips a
- * not-yet-started body with `ABORTED_BEFORE_DISPATCH` or replaces a
- * successful started outcome with `ABORTED`; already-started work is still
- * drained and may retain a tool-owned structured error.
- * @param exec - the typed same-process call input. The registry assigns its
- * correlation token before policy begins.
- * @returns the materialized final result.
- */
- async execute(exec: ToolExecutionInput): Promise<ToolExecutionResult> {
- return this.prepareExecution(exec, prepared => this.completeScheduledExecution(prepared))
- }
- private async completeScheduledExecution(prepared: ScheduledToolPreparation): Promise<ToolExecutionResult> {
- switch (prepared.kind) {
- case 'dispatch': {
- const dispatched = await this.dispatchScheduledExecution(prepared.exec)
- return dispatched.kind === 'post-result'
- ? await this.finalizeScheduledExecution(prepared.exec, dispatched.result)
- : this.finishScheduledExecution(prepared.exec, dispatched.result)
- }
- case 'post-result':
- return await this.finalizeScheduledExecution(prepared.exec, prepared.result)
- case 'final-result':
- return this.finishScheduledExecution(prepared.exec, prepared.result)
- /* v8 ignore next -- closed-union exhaustiveness guard */
- default:
- return assertNever(prepared, 'scheduled tool preparation')
- }
- }
- private createExecution(exec: ToolExecutionInput): ScheduledToolPreparation | { kind: 'ready'; exec: MutableToolRunContext } {
- const deferredContexts: UserMessage[] = []
- const token = createExecutionToken()
- const callId = exec.callId
- const name = exec.name
- const agent = exec.agent
- const parent = exec.parent
- const signal = exec.signal
- const definition = this.get(name, agent)
- const finalizeContent = definition?.finalizeContent?.bind(definition)
- const concludingExecutions = this.concludingExecutions
- const base = {
- token,
- callId,
- name,
- signal,
- ...agent !== undefined ? { agent } : {},
- ...parent !== undefined ? { parent } : {},
- deferContext(context: UserMessage): void {
- deferredContexts.push(context)
- },
- concludeTurn(): void {
- concludingExecutions.add(this as unknown as ToolExecution)
- },
- }
- try {
- const detached = snapshotJsonValue(exec.arguments)
- if (detached === undefined) {
- throw new TypeError('tool execution arguments must be losslessly JSON-serializable')
- }
- const execution: MutableToolRunContext = { ...base, arguments: deepFreeze(detached) }
- this.deferredContexts.set(execution, deferredContexts)
- this.contentFinalizers.set(execution, finalizeContent)
- this.cancellationStates.set(execution, {
- callerSignal: signal,
- bodyInvoked: false,
- })
- return { kind: 'ready', exec: execution }
- } catch (error: unknown) {
- const execution: MutableToolRunContext = { ...base, arguments: undefined }
- this.contentFinalizers.set(execution, finalizeContent)
- return { kind: 'final-result', exec: execution, result: toolErrorResult(error) }
- }
- }
- /**
- * Run the ordered pre-execute and monotonic guard stages for the scheduler.
- * @param input - the caller-supplied execution input.
- * @returns the prepared execution plus the next scheduler stage.
- * @internal
- */
- private async prepareScheduledExecution(input: ToolExecutionInput): Promise<ScheduledToolPreparation> {
- return this.prepareExecution(input, prepared => prepared)
- }
- private async prepareExecution<T>(
- input: ToolExecutionInput,
- next: (prepared: ScheduledToolPreparation) => T | PromiseLike<T>,
- ): Promise<T> {
- const created = this.createExecution(input)
- if (created.kind !== 'ready') return next(created)
- const exec = created.exec
- if (this.callerCancelled(exec)) {
- return next({ kind: 'final-result', exec, result: toolAbortedBeforeDispatchResult() })
- }
- try {
- const carrier = scopeTarget(this, exec.agent)
- const gate = await this.ctx.waterfall(
- carrier, 'tools/pre-execute', exec,
- () => Promise.resolve<PreToolDecision>({ kind: 'allow' }),
- )
- const askResolution: ToolAskResolution = gate.kind === 'ask'
- ? await this.serviceAsk(exec, gate)
- : { decision: gate, approvalCancelled: false }
- const { decision } = askResolution
- if (this.callerCancelled(exec) && askResolution.approvalCancelled) {
- return await next({ kind: 'post-result', exec, result: toolAbortedBeforeDispatchResult() })
- }
- const denialReason = decision.kind === 'allow'
- ? this.guardReason(exec)
- : decision.reason
- if (denialReason !== undefined) {
- return await next({
- kind: 'post-result',
- exec,
- result: this.materializeFinalResult({
- content: [{ type: 'text', text: `Error: ${denialReason}` }],
- isError: true,
- error: { message: denialReason },
- }),
- })
- }
- if (this.callerCancelled(exec)) {
- return await next({ kind: 'post-result', exec, result: toolAbortedBeforeDispatchResult() })
- }
- return await next({ kind: 'dispatch', exec })
- } catch (error: unknown) {
- return next({ kind: 'final-result', exec, result: toolErrorResult(error) })
- }
- }
- /** Whether the original caller signal is currently aborted. */
- private callerCancelled(exec: ToolRunContext): boolean {
- const state = this.cancellationStates.get(exec)
- /* v8 ignore next -- only registry-minted executions reach the staged scheduler methods */
- if (state === undefined) throw new Error('tool registry scheduler invariant violated: missing cancellation state')
- return state.callerSignal.aborted
- }
- /** Canonical cancellation outcome selected by whether the tool body started. */
- private cancellationResult(exec: ToolRunContext, prior?: ToolExecutionResult): ToolExecutionResult {
- const state = this.cancellationStates.get(exec)
- /* v8 ignore next -- only registry-minted executions reach the staged scheduler methods */
- if (state === undefined) throw new Error('tool registry scheduler invariant violated: missing cancellation state')
- return state.bodyInvoked
- ? toolAbortedResult(prior)
- : toolAbortedBeforeDispatchResult(prior)
- }
- /**
- * Dispatch the registered body with the original caller signal fused back
- * into any around-wrapper replacement. Cancellation never abandons the body:
- * a started promise reaches quiescence before its outcome becomes `ABORTED`.
- */
- private async dispatchToolBody(exec: MutableToolRunContext): Promise<ToolExecutionResult> {
- const state = this.cancellationStates.get(exec)
- /* v8 ignore next -- only registry-minted executions reach the staged scheduler methods */
- if (state === undefined) throw new Error('tool registry scheduler invariant violated: missing cancellation state')
- const wrapperSignal = exec.signal
- const fused = fuseToolSignals(state.callerSignal, wrapperSignal)
- const signal = fused.signal
- if (isAborted(signal)) {
- fused.dispose()
- return toolAbortedBeforeDispatchResult()
- }
- exec.signal = signal
- try {
- const tool = this.get(exec.name, exec.agent)
- if (!tool) throw new ToolNotFoundError(exec.name)
- state.bodyInvoked = true
- const returned = await tool.execute(exec.arguments, exec)
- const result = this.createSuccessResult(exec, tool, returned)
- return isAborted(signal)
- ? toolAbortedResult(result)
- : result
- } catch (error: unknown) {
- return toolErrorResult(error)
- } finally {
- fused.dispose()
- exec.signal = wrapperSignal
- }
- }
- /**
- * Run around-dispatch and the tool body. Tool and unknown-tool failures still
- * receive post-execute; pipeline failures are already final.
- * @param exec - the prepared execution.
- * @returns whether the result still needs post-execute.
- * @internal
- */
- private async dispatchScheduledExecution(exec: ToolRunContext): Promise<ScheduledToolDispatch> {
- try {
- const mutableExec = exec as MutableToolRunContext
- const carrier = scopeTarget(this, exec.agent)
- const result = await this.ctx.waterfall(
- carrier, 'tools/execute', mutableExec,
- () => this.dispatchToolBody(mutableExec),
- )
- const normalized = this.normalizeDispatchResult(exec, result)
- const deferredContexts = this.deferredContexts.get(exec)
- /* v8 ignore next -- dispatch only receives executions minted by this registry's prepare stage */
- if (deferredContexts === undefined) throw new Error('tool registry scheduler invariant violated: unprepared execution')
- const resultWithDeferredContexts: ToolExecutionResult = deferredContexts.length === 0
- ? normalized
- : this.markCanonical(exec, {
- ...normalized,
- additionalContexts: [
- ...deferredContexts,
- ...normalized.additionalContexts ?? [],
- ],
- })
- return {
- kind: 'post-result',
- result: this.callerCancelled(exec) && !resultWithDeferredContexts.isError
- ? this.cancellationResult(exec, resultWithDeferredContexts)
- : resultWithDeferredContexts,
- }
- } catch (error: unknown) {
- return { kind: 'final-result', result: toolErrorResult(error) }
- }
- }
- /**
- * Run ordered post-execute, then apply definition-owned content finalization,
- * materialize, and notify the final outcome.
- * @param exec - the prepared execution.
- * @param result - dispatch/pre result that still needs post-execute.
- * @returns the materialized final result.
- * @internal
- */
- private async finalizeScheduledExecution(exec: ToolRunContext, result: ToolExecutionResult): Promise<ToolExecutionResult> {
- try {
- const postResult = await this.postExecute(exec, result)
- return this.finishScheduledExecution(
- exec,
- this.callerCancelled(exec) && !postResult.isError
- ? this.cancellationResult(exec, postResult)
- : postResult,
- )
- } catch (error: unknown) {
- return this.finishScheduledExecution(exec, toolErrorResult(error))
- }
- }
- /**
- * Materialize the candidate, apply definition-owned content finalization,
- * then materialize and notify the authoritative result.
- * @param exec - the prepared execution.
- * @param result - final result.
- * @returns the materialized final result.
- * @internal
- */
- private finishScheduledExecution(exec: ToolRunContext, result: ToolExecutionResult): ToolExecutionResult {
- let materializedResult: ToolExecutionResult
- try {
- materializedResult = this.materializeFinalResult(result)
- } catch (error: unknown) {
- materializedResult = this.materializeFinalResult(toolErrorResult(error))
- }
- let finalResult: ToolExecutionResult
- try {
- finalResult = this.materializeFinalResult(this.applyFinalContent(exec, materializedResult))
- } catch (error: unknown) {
- finalResult = this.materializeFinalResult(toolErrorResult(error))
- }
- this.notifyResult(exec, finalResult)
- return finalResult
- }
- /** Apply the snapshotted tool-owned content transform without exposing other result fields. */
- private applyFinalContent(exec: ToolRunContext, result: ToolExecutionResult): ToolExecutionResult {
- const finalizeContent = this.contentFinalizers.get(exec)
- if (finalizeContent === undefined) return result
- const content = finalizeContent(exec, result)
- return content === undefined ? result : { ...result, content }
- }
- /** Notify observers without exposing a mutation or error channel into the outcome. */
- private notifyResult(exec: ToolExecution, result: ToolExecutionResult): void {
- // Freeze the registry's live object before observers receive its readonly
- // WeakMap-keyable view.
- Object.freeze(exec)
- const { name: toolName, callId } = exec
- const reportFailure = (error: unknown): void => {
- this.ctx.logger.warn(`tool "${toolName}" (${callId}): tools/result observer failed: ${errorMessage(error)}`)
- }
- const callbacks = this.ctx.events.dispatch('emit', [
- scopeTarget(this, exec.agent), 'tools/result', exec, result,
- ])
- for (const callback of callbacks) {
- try {
- const returned: unknown = callback(exec, result)
- void Promise.resolve(returned).catch(reportFailure)
- } catch (error: unknown) {
- reportFailure(error)
- }
- }
- }
- /**
- * Resolve an `ask` decision to allow/deny through the approval seam. The
- * seam is consumed opportunistically with `ctx.get('approval')` — a
- * deployment that composes no ApprovalService keeps the historical degrade
- * to deny, and an unmount mid-session degrades the same way on the next ask.
- * An agent-less execution also degrades: without an agent there is no
- * session to audit to and no UI to route to. Otherwise the outcome maps
- * one-to-one — `allowed-once` proceeds; the three non-grants deny with
- * distinct reasons so the model can tell a human "no" from an absent
- * approval channel.
- */
- private async serviceAsk(
- exec: ToolExecution,
- ask: Extract<PreToolDecision, { kind: 'ask' }>,
- ): Promise<ToolAskResolution> {
- const approval = this.ctx.get('approval')
- if (approval === undefined) {
- return {
- decision: { kind: 'deny', reason: ask.reason ?? `tool "${exec.name}" requires approval (not yet supported)` },
- approvalCancelled: false,
- }
- }
- if (exec.agent === undefined) {
- return {
- decision: { kind: 'deny', reason: `tool "${exec.name}" requires approval, but the call has no agent to route it through` },
- approvalCancelled: false,
- }
- }
- const outcome = await approval.request({
- agent: exec.agent,
- toolName: exec.name,
- callId: exec.callId,
- ...ask.reason !== undefined ? { reason: ask.reason } : {},
- signal: exec.signal,
- })
- switch (outcome) {
- case 'allowed-once': return { decision: { kind: 'allow' }, approvalCancelled: false }
- case 'rejected': return {
- decision: { kind: 'deny', reason: `the user rejected tool "${exec.name}"` },
- approvalCancelled: false,
- }
- case 'cancelled': return {
- decision: { kind: 'deny', reason: `approval for tool "${exec.name}" was cancelled` },
- approvalCancelled: true,
- }
- case 'unavailable': return {
- decision: { kind: 'deny', reason: `tool "${exec.name}" requires approval, but no approval channel is available` },
- approvalCancelled: false,
- }
- default: return assertNever(outcome, 'ApprovalOutcome')
- }
- }
- /**
- * Run the `tools/post-execute` waterfall over a dispatched `result` and apply
- * its {@link PostToolDecision}: `accept` keeps the call successful (replacing
- * `content` when given), `block` turns it into an `isError` whose content is
- * the corrective `feedback`. Either decision may attach `additionalContexts`,
- * which are ferried on the returned result for the loop's active-batch FIFO.
- * Context deferred by the tool body survives an accepted result but is
- * discarded when the outer call is blocked; a block exposes only context the
- * blocking decision explicitly supplied.
- * Runs inside `execute`'s outer try/catch (a throwing listener → isError).
- */
- private async postExecute(exec: ToolExecution, result: ToolExecutionResult): Promise<ToolExecutionResult> {
- const decision = await this.ctx.waterfall(
- scopeTarget(this, exec.agent), 'tools/post-execute', exec, result,
- () => Promise.resolve<PostToolDecision>({ kind: 'accept' }),
- )
- const decisionContexts = decision.additionalContexts ?? []
- if (decision.kind === 'block') {
- const message = failureMessageFromContent(decision.feedback)
- return this.markCanonical(exec, {
- content: decision.feedback,
- isError: true,
- error: { message },
- ...decisionContexts.length > 0 ? { additionalContexts: decisionContexts } : {},
- })
- }
- if (Object.hasOwn(decision, 'content') && Object.hasOwn(decision, 'value')) {
- throw new TypeError('tools/post-execute accept decision cannot replace both value and content')
- }
- const additionalContexts = [
- ...result.additionalContexts ?? [],
- ...decisionContexts,
- ]
- if (Object.hasOwn(decision, 'value')) {
- if (result.isError) {
- throw new TypeError('tools/post-execute cannot replace the value of a failed result')
- }
- const tool = this.get(exec.name, exec.agent)
- if (tool === undefined) throw new ToolNotFoundError(exec.name)
- const replaced = this.createSuccessResult(exec, tool, decision.value)
- return this.markCanonical(exec, {
- ...replaced,
- ...additionalContexts.length > 0 ? { additionalContexts } : {},
- })
- }
- return this.markCanonical(exec, {
- ...result,
- ...decision.content !== undefined ? { content: decision.content } : {},
- ...additionalContexts.length > 0 ? { additionalContexts } : {},
- })
- }
- /** Registry-normalized results and the exact dispatch that validated each value. */
- private readonly canonicalResults = new WeakMap<object, ToolExecutionToken>()
- /** Mark one registry-normalized result as canonical only for its owning dispatch. */
- private markCanonical<T extends ToolExecutionResult>(exec: ToolExecution, result: T): T {
- this.canonicalResults.set(result, exec.token)
- return result
- }
- /** Snapshot, validate, render, and optionally project one successful body value. */
- private createSuccessResult(exec: ToolExecution, tool: ToolDefinition, candidate: unknown): ToolExecutionSuccess {
- const detached = snapshotToolValue(tool.name, candidate)
- const violations = validateJsonSchemaValue(tool.output.schema, detached, 'value')
- if (violations.length > 0) throw new ToolOutputError(tool.name, violations)
- const value = deepFreeze(detached)
- let rendered: ContentBlock[]
- try {
- rendered = tool.output.render(exec.arguments, value)
- } catch (error: unknown) {
- throw projectionError(tool.name, 'render', error)
- }
- const content = snapshotProjection(tool.name, 'render', rendered)
- let meta: JsonValue | undefined
- if (exec.parent === undefined && tool.output.presentationMeta !== undefined) {
- let projected: JsonValue
- try {
- projected = tool.output.presentationMeta(exec.arguments, value)
- } catch (error: unknown) {
- throw projectionError(tool.name, 'presentationMeta', error)
- }
- meta = snapshotProjection(tool.name, 'presentationMeta', projected)
- }
- const concludesTurn = this.concludingExecutions.has(exec)
- return this.markCanonical(exec, this.materializeFinalResult({
- isError: false,
- value,
- content,
- ...meta !== undefined ? { meta } : {},
- ...concludesTurn ? { concludesTurn: true as const } : {},
- }) as ToolExecutionSuccess)
- }
- /** Normalize an around-dispatch wrapper's authored result through the owning output contract. */
- private normalizeDispatchResult(exec: ToolExecution, result: ToolExecutionResult): ToolExecutionResult {
- if (this.canonicalResults.get(result) === exec.token) return result
- if (result.isError) {
- return this.markCanonical(exec, {
- isError: true,
- error: result.error,
- content: result.content,
- ...result.meta !== undefined ? { meta: result.meta } : {},
- ...result.additionalContexts !== undefined ? { additionalContexts: result.additionalContexts } : {},
- })
- }
- const tool = this.get(exec.name, exec.agent)
- if (tool === undefined) throw new ToolNotFoundError(exec.name)
- const normalized = this.createSuccessResult(exec, tool, result.value)
- return this.markCanonical(exec, {
- ...normalized,
- ...result.additionalContexts !== undefined ? { additionalContexts: result.additionalContexts } : {},
- })
- }
- /** Materialize the authoritative commit outcome once, immediately before `tools/result`. */
- private materializeFinalResult(result: ToolExecutionResult): ToolExecutionResult {
- const presentation = {
- content: result.content,
- ...result.meta !== undefined ? { meta: result.meta } : {},
- ...result.additionalContexts !== undefined ? { additionalContexts: result.additionalContexts } : {},
- }
- if (result.isError) {
- return materializePresentation({ isError: true as const, error: result.error, ...presentation })
- }
- const detached = materializePresentation({
- isError: false as const,
- ...presentation,
- ...result.concludesTurn === true ? { concludesTurn: true as const } : {},
- })
- return deepFreeze({ ...detached, value: result.value })
- }
- }
- /** Mint a same-process correlation token whose identity is its value. */
- function createExecutionToken(): ToolExecutionToken {
- return Symbol('dsh.tool.execution') as ToolExecutionToken
- }
- function toolErrorResult(error: unknown): ToolExecutionResult {
- const info = errorInfo(error)
- const message = errorMessage(error)
- return {
- content: [{ type: 'text', text: `Error: ${message}` }],
- isError: true,
- error: { message, ...info ? { info } : {} },
- }
- }
- /** Read live abort state across an await without treating it as synchronously immutable. */
- function isAborted(signal: AbortSignal): boolean {
- return signal.aborted
- }
- /**
- * Fuse caller and wrapper cancellation without nesting `AbortSignal.any`.
- * Keeping the relay dispatch-scoped also removes listeners when work settles.
- */
- function fuseToolSignals(caller: AbortSignal, wrapper: AbortSignal): FusedToolSignal {
- if (caller === wrapper) return { signal: caller, dispose() {} }
- const controller = new AbortController()
- let listening = false
- const dispose = (): void => {
- if (!listening) return
- listening = false
- caller.removeEventListener('abort', abortFromCaller)
- wrapper.removeEventListener('abort', abortFromWrapper)
- }
- const abortFrom = (source: AbortSignal): void => {
- const reason: unknown = source.reason
- controller.abort(reason)
- dispose()
- }
- const abortFromCaller = (): void => { abortFrom(caller) }
- const abortFromWrapper = (): void => { abortFrom(wrapper) }
- if (wrapper.aborted) abortFromWrapper()
- else if (caller.aborted) abortFromCaller()
- else {
- listening = true
- caller.addEventListener('abort', abortFromCaller, { once: true })
- wrapper.addEventListener('abort', abortFromWrapper, { once: true })
- }
- return { signal: controller.signal, dispose }
- }
- /** Canonical result when cancellation supersedes success after body invocation. */
- function toolAbortedResult(prior?: ToolExecutionResult): ToolExecutionResult {
- const additionalContexts = prior?.additionalContexts ?? []
- return {
- content: [{ type: 'text', text: 'Error: tool call aborted' }],
- isError: true,
- error: {
- message: 'tool call aborted',
- info: { name: 'AbortError', code: TOOL_ABORTED },
- },
- ...additionalContexts.length > 0 ? { additionalContexts } : {},
- }
- }
- /** Canonical result when cancellation prevents tool body invocation. */
- function toolAbortedBeforeDispatchResult(prior?: ToolExecutionResult): ToolExecutionResult {
- const additionalContexts = prior?.additionalContexts ?? []
- return {
- content: [{ type: 'text', text: 'Error: tool call aborted before dispatch' }],
- isError: true,
- error: {
- message: 'tool call aborted before dispatch',
- info: { name: 'AbortError', code: TOOL_ABORTED_BEFORE_DISPATCH },
- },
- ...additionalContexts.length > 0 ? { additionalContexts } : {},
- }
- }
- export default ToolRegistry
|