zidane 4.1.5 → 4.1.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/chat.d.ts +305 -0
- package/dist/chat.d.ts.map +1 -0
- package/dist/chat.js +2 -0
- package/dist/contexts.d.ts +1 -1
- package/dist/{index-BfSdALzk.d.ts → index-BB4kuRh3.d.ts} +1 -1
- package/dist/{index-BfSdALzk.d.ts.map → index-BB4kuRh3.d.ts.map} +1 -1
- package/dist/{index-28otmfLX.d.ts → index-DRoG_udt.d.ts} +42 -42
- package/dist/index-DRoG_udt.d.ts.map +1 -0
- package/dist/{index-DPsd0qwm.d.ts → index-Ds5YpvfZ.d.ts} +3 -3
- package/dist/{index-DPsd0qwm.d.ts.map → index-Ds5YpvfZ.d.ts.map} +1 -1
- package/dist/{agent-BoV5Twdl.d.ts → index-bgh-k8Mv.d.ts} +1989 -1963
- package/dist/index-bgh-k8Mv.d.ts.map +1 -0
- package/dist/index.d.ts +4 -4
- package/dist/index.js +3 -3
- package/dist/mcp.d.ts +1 -1
- package/dist/{presets-Cs7_CsMk.js → presets-BzkJDW1K.js} +3 -3
- package/dist/presets-BzkJDW1K.js.map +1 -0
- package/dist/presets.d.ts +1 -1
- package/dist/presets.js +1 -1
- package/dist/providers.d.ts +1 -1
- package/dist/session/sqlite.d.ts +1 -1
- package/dist/session.d.ts +1 -1
- package/dist/skills.d.ts +2 -2
- package/dist/{stats-DoKUtF5T.js → stats-BT9l57RS.js} +34 -2
- package/dist/stats-BT9l57RS.js.map +1 -0
- package/dist/theme-BlXO6yHe.d.ts +503 -0
- package/dist/theme-BlXO6yHe.d.ts.map +1 -0
- package/dist/theme-context-MungM3SY.js +1713 -0
- package/dist/theme-context-MungM3SY.js.map +1 -0
- package/dist/{tools-DpeWKzP1.js → tools-C8kDot0H.js} +73 -23
- package/dist/tools-C8kDot0H.js.map +1 -0
- package/dist/tools.d.ts +2 -2
- package/dist/tools.js +1 -1
- package/dist/tui.d.ts +51 -499
- package/dist/tui.d.ts.map +1 -1
- package/dist/tui.js +687 -931
- package/dist/tui.js.map +1 -1
- package/dist/types.d.ts +3 -3
- package/dist/types.js +1 -1
- package/package.json +6 -3
- package/dist/agent-BoV5Twdl.d.ts.map +0 -1
- package/dist/index-28otmfLX.d.ts.map +0 -1
- package/dist/presets-Cs7_CsMk.js.map +0 -1
- package/dist/stats-DoKUtF5T.js.map +0 -1
- package/dist/tools-DpeWKzP1.js.map +0 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { c as ExecutionContext, l as ExecutionHandle } from "./index-
|
|
1
|
+
import { c as ExecutionContext, l as ExecutionHandle } from "./index-BB4kuRh3.js";
|
|
2
2
|
import { Hookable } from "hookable";
|
|
3
3
|
import { Client } from "@modelcontextprotocol/sdk/client/index.js";
|
|
4
4
|
//#region src/errors.d.ts
|
|
@@ -117,2231 +117,2257 @@ declare function matchesContextExceeded(message: unknown): boolean;
|
|
|
117
117
|
*/
|
|
118
118
|
declare function toTypedError(classification: ClassifiedError, provider: string, cause: unknown): AgentContextExceededError | AgentProviderError | AgentAbortedError;
|
|
119
119
|
//#endregion
|
|
120
|
-
//#region src/
|
|
120
|
+
//#region src/mcp/index.d.ts
|
|
121
|
+
interface McpConnection {
|
|
122
|
+
tools: Record<string, ToolDef>;
|
|
123
|
+
close: () => Promise<void>;
|
|
124
|
+
}
|
|
121
125
|
/**
|
|
122
|
-
*
|
|
126
|
+
* Normalize MCP server configs from any common shape to `McpServerConfig[]`.
|
|
123
127
|
*
|
|
124
|
-
*
|
|
125
|
-
* - `
|
|
126
|
-
*
|
|
127
|
-
*
|
|
128
|
-
* -
|
|
129
|
-
*
|
|
130
|
-
*
|
|
128
|
+
* Accepts:
|
|
129
|
+
* - `McpServerConfig[]` — zidane native (pass-through).
|
|
130
|
+
* - `McpServerConfig` — a single config object (wrapped to a 1-element array).
|
|
131
|
+
* - `Record<string, RawShape>` — name-keyed map (common in host-SDK configs), where the key is the server name.
|
|
132
|
+
* - Mixed shapes with `type` vs `transport`, `httpUrl`/`sseUrl` vs `url`.
|
|
133
|
+
*
|
|
134
|
+
* Returns `[]` when `input` is nullish. Throws a descriptive error when the transport
|
|
135
|
+
* cannot be inferred from a given entry, or when the input shape is unsupported.
|
|
131
136
|
*/
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
137
|
+
declare function normalizeMcpServers(input: unknown): McpServerConfig[];
|
|
138
|
+
/**
|
|
139
|
+
* Lossy flattener — converts MCP `CallToolResult.content` blocks to a single
|
|
140
|
+
* string. Text blocks are extracted; non-text blocks are JSON-stringified.
|
|
141
|
+
*
|
|
142
|
+
* Use this only at UI / log boundaries that require a string. The agent
|
|
143
|
+
* loop itself routes through {@link normalizeMcpBlocks} so image blocks
|
|
144
|
+
* survive into provider-native tool_result content (Anthropic blocks,
|
|
145
|
+
* OpenAI companion-user-message).
|
|
146
|
+
*/
|
|
147
|
+
declare function resultToString(content: unknown[]): string;
|
|
148
|
+
/**
|
|
149
|
+
* Normalize MCP `CallToolResult.content` to zidane's {@link ToolResultContent[]} shape.
|
|
150
|
+
*
|
|
151
|
+
* Handles the four MCP content block types:
|
|
152
|
+
* - `text` → preserved as `{type:'text', text}`
|
|
153
|
+
* - `image` → preserved as `{type:'image', mediaType, data}` (MCP uses `mimeType`)
|
|
154
|
+
* - `resource` with embedded text → flattened to a text block
|
|
155
|
+
* - `resource` with embedded blob whose `mimeType` is `image/*` → flattened to an image block
|
|
156
|
+
* - Any unrecognized block → JSON-stringified fallback text block (lossy but safe)
|
|
157
|
+
*
|
|
158
|
+
* Returns `null` when the input is not an array — callers should fall back to an empty
|
|
159
|
+
* result in that case.
|
|
160
|
+
*/
|
|
161
|
+
declare function normalizeMcpBlocks(content: unknown): ToolResultContent[] | null;
|
|
162
|
+
/**
|
|
163
|
+
* Connect to MCP servers and discover their tools.
|
|
164
|
+
*
|
|
165
|
+
* Each tool is namespaced as `mcp_{serverName}_{toolName}` to avoid
|
|
166
|
+
* collisions with agent tools or tools from other servers.
|
|
167
|
+
*
|
|
168
|
+
* @param configs - Array of MCP server configurations
|
|
169
|
+
* @param _clientFactory - Internal: override client construction for testing
|
|
170
|
+
* @param hooks - Optional agent hooks for firing mcp:connect, mcp:error, mcp:close events
|
|
171
|
+
*/
|
|
172
|
+
declare function connectMcpServers(configs: McpServerConfig[], _clientFactory?: () => Client, hooks?: Hookable<AgentHooks>): Promise<McpConnection>;
|
|
173
|
+
//#endregion
|
|
174
|
+
//#region src/session/file-map.d.ts
|
|
175
|
+
/**
|
|
176
|
+
* Host-provided file-map adapter. Three methods exchanging `Record<string, string>`
|
|
177
|
+
* payloads — the whole persistence surface the wrapper needs.
|
|
178
|
+
*/
|
|
179
|
+
interface FileMapAdapter {
|
|
180
|
+
/** Load the current file map. Returns an empty `files` record when nothing is persisted. */
|
|
181
|
+
get: () => Promise<{
|
|
182
|
+
files: Record<string, string>;
|
|
183
|
+
}>;
|
|
184
|
+
/** Replace the persisted file map. Full-rewrite semantics. */
|
|
185
|
+
save: (files: Record<string, string>) => Promise<void>;
|
|
186
|
+
/** Delete all persisted state. */
|
|
187
|
+
delete: () => Promise<void>;
|
|
188
|
+
}
|
|
189
|
+
interface FileMapStoreOptions {
|
|
190
|
+
/** Filename for the JSONL turns log. Default: `turns.jsonl`. */
|
|
191
|
+
turnsFile?: string;
|
|
192
|
+
/** Filename for the metadata JSON. Default: `meta.json`. */
|
|
193
|
+
metaFile?: string;
|
|
194
|
+
}
|
|
195
|
+
/**
|
|
196
|
+
* Create a single-session `SessionStore` backed by a file-map adapter.
|
|
197
|
+
*
|
|
198
|
+
* @example
|
|
199
|
+
* ```ts
|
|
200
|
+
* const session = await createSession({
|
|
201
|
+
* store: createFileMapStore(hostSessionStore),
|
|
202
|
+
* })
|
|
203
|
+
* ```
|
|
204
|
+
*/
|
|
205
|
+
declare function createFileMapStore(adapter: FileMapAdapter, options?: FileMapStoreOptions): SessionStore;
|
|
206
|
+
//#endregion
|
|
207
|
+
//#region src/session/memory.d.ts
|
|
208
|
+
declare function createMemoryStore(): SessionStore;
|
|
209
|
+
//#endregion
|
|
210
|
+
//#region src/session/messages.d.ts
|
|
211
|
+
declare function fromAnthropic(msg: {
|
|
212
|
+
role: string;
|
|
213
|
+
content: unknown;
|
|
214
|
+
}): SessionMessage;
|
|
215
|
+
declare function fromOpenAI(msg: {
|
|
216
|
+
role: string;
|
|
217
|
+
content: unknown;
|
|
218
|
+
}): SessionMessage;
|
|
219
|
+
declare function toAnthropic(msg: SessionMessage): {
|
|
220
|
+
role: string;
|
|
221
|
+
content: unknown;
|
|
222
|
+
};
|
|
223
|
+
declare function toOpenAI(msg: SessionMessage): {
|
|
224
|
+
role: string;
|
|
225
|
+
content: unknown;
|
|
226
|
+
};
|
|
227
|
+
declare function autoDetectAndConvert(msg: {
|
|
228
|
+
role: string;
|
|
229
|
+
content: unknown;
|
|
230
|
+
}): SessionMessage;
|
|
231
|
+
//#endregion
|
|
232
|
+
//#region src/session/remote.d.ts
|
|
233
|
+
interface RemoteStoreOptions {
|
|
234
|
+
/** Base URL of the session API */
|
|
235
|
+
url: string;
|
|
236
|
+
/** Optional headers (e.g. for authentication) */
|
|
237
|
+
headers?: Record<string, string>;
|
|
238
|
+
}
|
|
239
|
+
declare function createRemoteStore(options: RemoteStoreOptions): SessionStore;
|
|
240
|
+
//#endregion
|
|
241
|
+
//#region src/session/index.d.ts
|
|
242
|
+
interface SessionRun {
|
|
243
|
+
id: string;
|
|
244
|
+
startedAt: number;
|
|
245
|
+
endedAt?: number;
|
|
246
|
+
prompt: string;
|
|
247
|
+
status: 'running' | 'completed' | 'aborted' | 'error';
|
|
248
|
+
turns?: number;
|
|
249
|
+
tokensIn?: number;
|
|
250
|
+
tokensOut?: number;
|
|
251
|
+
error?: string;
|
|
252
|
+
/** Per-turn usage breakdown */
|
|
253
|
+
turnUsage?: TurnUsage[];
|
|
254
|
+
/** Total usage across all turns */
|
|
255
|
+
totalUsage?: TurnUsage;
|
|
256
|
+
/** Estimated cost in USD */
|
|
257
|
+
cost?: number;
|
|
142
258
|
/**
|
|
143
|
-
*
|
|
144
|
-
*
|
|
145
|
-
*
|
|
146
|
-
* whitelist (`PATH`, `HOME`, `LANG`, `SHELL`, `USER` on POSIX; `APPDATA`,
|
|
147
|
-
* `PATH`, ... on Win32). Setting this to `{}` no longer strips `PATH` from
|
|
148
|
-
* the child process. Set {@link McpServerConfig.strictEnv} to `true` to
|
|
149
|
-
* pass `env` verbatim with no inherited defaults.
|
|
259
|
+
* The run that spawned this one, when the agent is a subagent sharing its
|
|
260
|
+
* parent's session. Undefined on top-level `agent.run()`. Consumers can walk
|
|
261
|
+
* `runs` by `parentRunId` to reconstruct the subagent tree.
|
|
150
262
|
*/
|
|
151
|
-
|
|
263
|
+
parentRunId?: string;
|
|
152
264
|
/**
|
|
153
|
-
*
|
|
154
|
-
*
|
|
155
|
-
* is NOT merged in. Most consumers should leave this off; the default merge
|
|
156
|
-
* prevents `spawn ENOENT` when a stdio server declares an `env` without
|
|
157
|
-
* restating `PATH`.
|
|
265
|
+
* Zero-based subagent depth. 0 = top-level run, 1 = direct child, …
|
|
266
|
+
* Recorded here so hosts can query/filter by level without walking the tree.
|
|
158
267
|
*/
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
268
|
+
depth?: number;
|
|
269
|
+
}
|
|
270
|
+
interface SessionData {
|
|
271
|
+
id: string;
|
|
272
|
+
agentId?: string;
|
|
273
|
+
turns: SessionTurn[];
|
|
274
|
+
runs: SessionRun[];
|
|
275
|
+
status: 'idle' | 'running' | 'completed' | 'error';
|
|
276
|
+
metadata: Record<string, unknown>;
|
|
277
|
+
createdAt: number;
|
|
278
|
+
updatedAt: number;
|
|
279
|
+
}
|
|
280
|
+
interface SessionStore {
|
|
281
|
+
/** Optional: generate a session ID server-side (e.g. Supabase UUID). */
|
|
282
|
+
generateSessionId?: () => string | Promise<string>;
|
|
283
|
+
/** Optional: generate a turn ID server-side. */
|
|
284
|
+
generateTurnId?: () => string | Promise<string>;
|
|
285
|
+
/** Load a session by ID. Returns null if not found. */
|
|
286
|
+
load: (sessionId: string) => Promise<SessionData | null>;
|
|
287
|
+
/** Save a session (create or update, full document). */
|
|
288
|
+
save: (session: SessionData) => Promise<void>;
|
|
289
|
+
/** Delete a session. */
|
|
290
|
+
delete: (sessionId: string) => Promise<void>;
|
|
291
|
+
/** List session IDs, optionally filtered. */
|
|
292
|
+
list: (filter?: {
|
|
293
|
+
agentId?: string;
|
|
294
|
+
limit?: number;
|
|
295
|
+
}) => Promise<string[]>;
|
|
296
|
+
/** Append new turns to a session (incremental, avoids full re-save). */
|
|
297
|
+
appendTurns: (sessionId: string, turns: SessionTurn[]) => Promise<void>;
|
|
298
|
+
/** Return a slice of turns for a session. */
|
|
299
|
+
getTurns: (sessionId: string, from?: number, limit?: number) => Promise<SessionTurn[]>;
|
|
300
|
+
/** Persist an updated run record (called after completeRun / abortRun / errorRun). */
|
|
301
|
+
updateRun: (sessionId: string, run: SessionRun) => Promise<void>;
|
|
302
|
+
/** Update the top-level status of a session. */
|
|
303
|
+
updateStatus: (sessionId: string, status: SessionData['status']) => Promise<void>;
|
|
304
|
+
}
|
|
305
|
+
interface Session {
|
|
306
|
+
/** Session ID */
|
|
307
|
+
readonly id: string;
|
|
308
|
+
/** Agent ID (optional label) */
|
|
309
|
+
readonly agentId?: string;
|
|
310
|
+
/** Current turn history */
|
|
311
|
+
readonly turns: SessionTurn[];
|
|
164
312
|
/**
|
|
165
|
-
*
|
|
166
|
-
*
|
|
167
|
-
* Zidane connects MCP servers lazily on the first `run()`. Without a
|
|
168
|
-
* bootstrap timeout, a slow or hung server can delay the first provider call
|
|
169
|
-
* for an arbitrarily long time even when that MCP server is never used.
|
|
313
|
+
* True when this session has no turns yet.
|
|
170
314
|
*
|
|
171
|
-
*
|
|
315
|
+
* Use this as a first-prompt signal when setting up a run — e.g. writing initial
|
|
316
|
+
* configuration only on fresh sessions. Equivalent to `turns.length === 0`.
|
|
172
317
|
*/
|
|
173
|
-
|
|
174
|
-
/**
|
|
175
|
-
|
|
318
|
+
readonly isEmpty: boolean;
|
|
319
|
+
/** Top-level session status */
|
|
320
|
+
readonly status: SessionData['status'];
|
|
321
|
+
/** All runs in this session */
|
|
322
|
+
readonly runs: SessionRun[];
|
|
323
|
+
/** Arbitrary metadata */
|
|
324
|
+
readonly metadata: Record<string, unknown>;
|
|
176
325
|
/**
|
|
177
|
-
*
|
|
178
|
-
*
|
|
179
|
-
*
|
|
180
|
-
* the wire cost of advertising them is avoided.
|
|
181
|
-
*
|
|
182
|
-
* Mutually exclusive with {@link McpServerConfig.disabledTools} — passing both
|
|
183
|
-
* throws at bootstrap time.
|
|
184
|
-
*
|
|
185
|
-
* Composes with {@link McpServerConfig.toolFilter}: allow-list applies first,
|
|
186
|
-
* then the predicate. Composes with the `mcp:tools:filter` hook: config-side
|
|
187
|
-
* filters apply first, then the hook can further narrow the list.
|
|
326
|
+
* Start tracking a new run. `extras.parentRunId` + `extras.depth` are
|
|
327
|
+
* populated by the spawn tool when a child agent shares its parent's
|
|
328
|
+
* session; regular top-level `agent.run()` calls omit them.
|
|
188
329
|
*/
|
|
189
|
-
|
|
330
|
+
startRun: (runId: string, prompt?: string, extras?: {
|
|
331
|
+
parentRunId?: string;
|
|
332
|
+
depth?: number;
|
|
333
|
+
}) => void;
|
|
334
|
+
/** Mark a run as completed */
|
|
335
|
+
completeRun: (runId: string, stats: {
|
|
336
|
+
turns: number;
|
|
337
|
+
tokensIn: number;
|
|
338
|
+
tokensOut: number;
|
|
339
|
+
turnUsage?: TurnUsage[];
|
|
340
|
+
cost?: number;
|
|
341
|
+
}) => void;
|
|
342
|
+
/** Mark a run as aborted */
|
|
343
|
+
abortRun: (runId: string) => void;
|
|
344
|
+
/** Mark a run as errored */
|
|
345
|
+
errorRun: (runId: string, error: string) => void;
|
|
346
|
+
/** Append turns to in-memory history AND persist via store.appendTurns (if store present) */
|
|
347
|
+
appendTurns: (turns: SessionTurn[]) => Promise<void>;
|
|
348
|
+
/** Replace all turns in-memory (does not persist — use save() for that) */
|
|
349
|
+
setTurns: (turns: SessionTurn[]) => void;
|
|
350
|
+
/** Update the session status in memory AND via store.updateStatus (if store present) */
|
|
351
|
+
updateStatus: (status: SessionData['status']) => Promise<void>;
|
|
352
|
+
/** Persist an updated run record via store.updateRun (if store present) */
|
|
353
|
+
updateRun: (run: SessionRun) => Promise<void>;
|
|
354
|
+
/** Generate a turn ID using store.generateTurnId if available, else crypto.randomUUID() */
|
|
355
|
+
generateTurnId: () => string | Promise<string>;
|
|
356
|
+
/** Set metadata key */
|
|
357
|
+
setMeta: (key: string, value: unknown) => void;
|
|
358
|
+
/** Persist the full session document to the store */
|
|
359
|
+
save: () => Promise<void>;
|
|
360
|
+
/** Serialize to SessionData */
|
|
361
|
+
toJSON: () => SessionData;
|
|
362
|
+
}
|
|
363
|
+
interface CreateSessionOptions {
|
|
364
|
+
/** Session ID. If omitted and store provides generateSessionId, that is used. */
|
|
365
|
+
id?: string;
|
|
366
|
+
/** Agent ID label */
|
|
367
|
+
agentId?: string;
|
|
368
|
+
/** Initial metadata */
|
|
369
|
+
metadata?: Record<string, unknown>;
|
|
370
|
+
/** Storage backend (optional, enables save/load) */
|
|
371
|
+
store?: SessionStore;
|
|
372
|
+
_data?: SessionData;
|
|
373
|
+
}
|
|
374
|
+
/**
|
|
375
|
+
* Create a new session.
|
|
376
|
+
* Async so stores that generate IDs server-side (e.g. Supabase) can be supported.
|
|
377
|
+
*/
|
|
378
|
+
declare function createSession(options?: CreateSessionOptions): Promise<Session>;
|
|
379
|
+
/**
|
|
380
|
+
* Load an existing session from a store.
|
|
381
|
+
*/
|
|
382
|
+
declare function loadSession(store: SessionStore, sessionId: string): Promise<Session | null>;
|
|
383
|
+
//#endregion
|
|
384
|
+
//#region src/skills/types.d.ts
|
|
385
|
+
/**
|
|
386
|
+
* Types for the Agent Skills system.
|
|
387
|
+
*
|
|
388
|
+
* Follows the Agent Skills open standard (agentskills.io/specification).
|
|
389
|
+
* Zidane-specific metadata conventionally uses the `zidane.` key prefix
|
|
390
|
+
* (e.g. `metadata['zidane.paths']`) to stay spec-compliant.
|
|
391
|
+
*/
|
|
392
|
+
interface SkillResource {
|
|
393
|
+
/** Relative path from skill directory */
|
|
394
|
+
path: string;
|
|
395
|
+
/** Resource type inferred from directory */
|
|
396
|
+
type: 'script' | 'reference' | 'asset' | 'other';
|
|
397
|
+
}
|
|
398
|
+
/**
|
|
399
|
+
* Where the skill came from. Used for collision precedence (project beats user)
|
|
400
|
+
* and for host SDKs to gate project-level skills on a trust check.
|
|
401
|
+
*/
|
|
402
|
+
type SkillSource = 'project' | 'user' | 'inline' | 'builtin';
|
|
403
|
+
/** Severity + code for lenient-load warnings surfaced to host UIs. */
|
|
404
|
+
interface SkillDiagnostic {
|
|
405
|
+
severity: 'warning' | 'error';
|
|
406
|
+
/** Stable machine-readable code (e.g. `name-mismatch-directory`). */
|
|
407
|
+
code: string;
|
|
408
|
+
/** Human-readable description. */
|
|
409
|
+
message: string;
|
|
410
|
+
/** Optional frontmatter field name the diagnostic relates to. */
|
|
411
|
+
field?: string;
|
|
412
|
+
}
|
|
413
|
+
interface SkillConfig {
|
|
414
|
+
/** Skill name: 1-64 chars, lowercase alphanumeric + hyphens */
|
|
415
|
+
name: string;
|
|
416
|
+
/** What the skill does and when to use it (1-1024 chars) */
|
|
417
|
+
description: string;
|
|
418
|
+
/** The SKILL.md body content (after YAML frontmatter) */
|
|
419
|
+
instructions: string;
|
|
190
420
|
/**
|
|
191
|
-
*
|
|
192
|
-
*
|
|
421
|
+
* Where this skill was loaded from. Drives collision precedence and the
|
|
422
|
+
* `trustProjectSkills` gate. Optional — `parseSkillFile` stamps it; raw
|
|
423
|
+
* fixtures that omit it are treated as `'project'` by downstream readers.
|
|
193
424
|
*/
|
|
194
|
-
|
|
425
|
+
source?: SkillSource;
|
|
426
|
+
/** Absolute path to SKILL.md (undefined for inline skills) */
|
|
427
|
+
location?: string;
|
|
428
|
+
/** Skill directory path for resolving relative references */
|
|
429
|
+
baseDir?: string;
|
|
430
|
+
/** License identifier or reference */
|
|
431
|
+
license?: string;
|
|
432
|
+
/** Environment requirements */
|
|
433
|
+
compatibility?: string;
|
|
195
434
|
/**
|
|
196
|
-
*
|
|
197
|
-
*
|
|
198
|
-
* description, schema shape, or other metadata that an allow/deny list can't
|
|
199
|
-
* express.
|
|
200
|
-
*
|
|
201
|
-
* Runs after the allow/deny filter but before the `mcp:tools:filter` hook.
|
|
435
|
+
* Flat key-value metadata bag per the spec. For Zidane-specific hints,
|
|
436
|
+
* use the `zidane.` key prefix (e.g. `metadata['zidane.paths']`).
|
|
202
437
|
*/
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
438
|
+
metadata?: Record<string, string>;
|
|
439
|
+
/** Pre-approved tool names (experimental per spec) */
|
|
440
|
+
allowedTools?: string[];
|
|
441
|
+
/** Bundled resource files discovered in the skill directory */
|
|
442
|
+
resources?: SkillResource[];
|
|
208
443
|
/**
|
|
209
|
-
*
|
|
210
|
-
*
|
|
211
|
-
* agent-wide default. Useful when one big MCP server (200+ tools) should
|
|
212
|
-
* stay lazy while smaller servers stay eager.
|
|
213
|
-
*
|
|
214
|
-
* Default: inherits from `behavior.toolDisclosure`.
|
|
444
|
+
* Lenient-load warnings recorded during parsing. Host SDKs can surface these
|
|
445
|
+
* as inline UI hints. Absent when no issues were found.
|
|
215
446
|
*/
|
|
216
|
-
|
|
447
|
+
diagnostics?: SkillDiagnostic[];
|
|
217
448
|
}
|
|
218
|
-
|
|
219
|
-
interface AgentBehavior {
|
|
220
|
-
/** Tool execution mode (default: 'sequential') */
|
|
221
|
-
toolExecution?: ToolExecutionMode;
|
|
449
|
+
interface SkillsConfig {
|
|
222
450
|
/**
|
|
223
|
-
*
|
|
224
|
-
*
|
|
225
|
-
*
|
|
226
|
-
*
|
|
227
|
-
* cap is hit. Set a finite value as a safety net for runaway loops.
|
|
451
|
+
* Control which skills are active.
|
|
452
|
+
* - `true` (default): all discovered skills are enabled
|
|
453
|
+
* - `false` or `[]`: fully disable the skills system (no resolution, no catalog, no hooks)
|
|
454
|
+
* - `string[]`: allowlist — only skills with matching names are enabled
|
|
228
455
|
*/
|
|
229
|
-
|
|
230
|
-
/**
|
|
231
|
-
|
|
232
|
-
/**
|
|
233
|
-
|
|
234
|
-
/**
|
|
235
|
-
|
|
456
|
+
enabled?: boolean | string[];
|
|
457
|
+
/** Directories to scan for SKILL.md files */
|
|
458
|
+
scan?: string[];
|
|
459
|
+
/** Dynamic skills written to disk at agent start, then loaded normally */
|
|
460
|
+
write?: SkillConfig[];
|
|
461
|
+
/** Skill names to exclude from the catalog */
|
|
462
|
+
exclude?: string[];
|
|
463
|
+
/** Skip default scan paths (~/.agents/skills, .zidane/skills, etc.) */
|
|
464
|
+
skipDefaultPaths?: boolean;
|
|
236
465
|
/**
|
|
237
|
-
*
|
|
238
|
-
*
|
|
239
|
-
* the
|
|
240
|
-
*
|
|
241
|
-
* - Anthropic: `cache_control: { type: 'ephemeral' }` on the last `system`
|
|
242
|
-
* content part, the last tool, and the last message content part.
|
|
243
|
-
* - OpenAI-compatible / OpenRouter: same shape — honored by Anthropic-backed
|
|
244
|
-
* OpenRouter routes and by Gemini; ignored (no-op) by providers that cache
|
|
245
|
-
* automatically (OpenAI, DeepSeek, Grok, Groq, Moonshot).
|
|
246
|
-
*
|
|
247
|
-
* Usage is surfaced via `TurnUsage.cacheRead` / `TurnUsage.cacheCreation`.
|
|
248
|
-
*
|
|
249
|
-
* Default: `true`.
|
|
466
|
+
* Auto-inject `skills_use` / `skills_read` / `skills_run_script` tools
|
|
467
|
+
* when the catalog is non-empty. Default `true`. Set `false` to opt out
|
|
468
|
+
* (the system prompt will then instruct the model to use its file-read
|
|
469
|
+
* tool instead).
|
|
250
470
|
*/
|
|
251
|
-
|
|
471
|
+
tool?: boolean;
|
|
252
472
|
/**
|
|
253
|
-
*
|
|
254
|
-
*
|
|
255
|
-
* synthetic user message instructing the model to summarize before calling
|
|
256
|
-
* more tools, and fires the `budget:exceeded` hook.
|
|
257
|
-
*
|
|
258
|
-
* Measured **post-`tool:transform`** so consumer truncation counts toward the
|
|
259
|
-
* budget. Off by default (undefined / `0` disables the check). A reasonable
|
|
260
|
-
* starting value for OSS-model integrations is `32768`.
|
|
473
|
+
* Cap on concurrently active skills per run. Default `undefined` (unlimited).
|
|
474
|
+
* Attempts to activate past the cap throw from `skills_use`.
|
|
261
475
|
*/
|
|
262
|
-
|
|
476
|
+
maxActive?: number;
|
|
477
|
+
/** Script timeout for `skills_run_script`, in milliseconds. Default `60000`. */
|
|
478
|
+
scriptTimeoutMs?: number;
|
|
263
479
|
/**
|
|
264
|
-
*
|
|
265
|
-
*
|
|
266
|
-
*
|
|
267
|
-
* instead of re-emitting the full content. Pairs with the read-before-edit
|
|
268
|
-
* guard in `edit` / `multi_edit`.
|
|
269
|
-
*
|
|
270
|
-
* Requires a session (set via `createSession()`); without one, the flag is
|
|
271
|
-
* a no-op since per-session state has nowhere to live.
|
|
272
|
-
*
|
|
273
|
-
* Default: `true`.
|
|
480
|
+
* When `false`, skills with `source: 'project'` are skipped during
|
|
481
|
+
* resolution with a diagnostic. Default `true` (preserves existing behavior).
|
|
482
|
+
* Useful for host SDKs handling untrusted repositories.
|
|
274
483
|
*/
|
|
275
|
-
|
|
484
|
+
trustProjectSkills?: boolean;
|
|
485
|
+
}
|
|
486
|
+
//#endregion
|
|
487
|
+
//#region src/skills/activation.d.ts
|
|
488
|
+
/** How a skill was activated. Surfaced in `skills:activate` hook ctx. */
|
|
489
|
+
type ActivationVia = 'model' | 'explicit' | 'resume';
|
|
490
|
+
/** Reason a skill was deactivated. Surfaced in `skills:deactivate` hook ctx. */
|
|
491
|
+
type DeactivationReason = 'run-end' | 'explicit' | 'reset';
|
|
492
|
+
/** A skill currently active in the state machine. */
|
|
493
|
+
interface ActiveSkill {
|
|
494
|
+
skill: SkillConfig;
|
|
495
|
+
activatedAt: number;
|
|
496
|
+
activatedVia: ActivationVia;
|
|
497
|
+
}
|
|
498
|
+
/**
|
|
499
|
+
* Per-agent skill activation state. Public read-surface is the `active()` list
|
|
500
|
+
* and `isActive(name)` predicate; writes go through `activate()` / `deactivate()`.
|
|
501
|
+
*/
|
|
502
|
+
interface SkillActivationState {
|
|
503
|
+
/** List of currently active skills in activation order. Returns a snapshot. */
|
|
504
|
+
active: () => readonly ActiveSkill[];
|
|
505
|
+
/** Is the skill with this canonical name currently active? */
|
|
506
|
+
isActive: (name: string) => boolean;
|
|
507
|
+
/** Retrieve the `ActiveSkill` record by name, or `undefined`. */
|
|
508
|
+
get: (name: string) => ActiveSkill | undefined;
|
|
276
509
|
/**
|
|
277
|
-
*
|
|
278
|
-
*
|
|
279
|
-
*
|
|
280
|
-
*
|
|
281
|
-
* - **Struct** — geometric decay starting after `afterTurn`, multiplying by
|
|
282
|
-
* `factor` each subsequent turn, clamped to `floor`. Example
|
|
283
|
-
* `{ afterTurn: 5, factor: 0.5, floor: 1024 }` with a base budget of 8192:
|
|
284
|
-
* turns 1-5 = 8192, turn 6 = 4096, turn 7 = 2048, turn 8+ = 1024.
|
|
285
|
-
* - **Function** — `(runTurn, baseBudget) => number`. Arbitrary curves;
|
|
286
|
-
* `runTurn` is 1-indexed, run-relative (resumed sessions reset).
|
|
287
|
-
*
|
|
288
|
-
* No-op when `thinkingBudget` is unset. Honored by every provider that
|
|
289
|
-
* respects `thinkingBudget` (anthropic explicit-budget `enabled` path,
|
|
290
|
-
* adaptive `maxTokensCap`, openai-compat `max_tokens` padding).
|
|
291
|
-
*
|
|
292
|
-
* Default: `undefined` (no decay).
|
|
510
|
+
* Mark a skill as active.
|
|
511
|
+
* - Returns `'ok'` on a fresh activation (caller should fire `skills:activate`).
|
|
512
|
+
* - Returns `'already-active'` if the skill was already in the set (idempotent).
|
|
513
|
+
* - Returns `'cap-reached'` if the `maxActive` cap would be exceeded. State is unchanged.
|
|
293
514
|
*/
|
|
294
|
-
|
|
295
|
-
afterTurn: number;
|
|
296
|
-
factor: number;
|
|
297
|
-
floor: number;
|
|
298
|
-
} | ((runTurn: number, baseBudget: number) => number);
|
|
515
|
+
activate: (skill: SkillConfig, via: ActivationVia) => 'ok' | 'already-active' | 'cap-reached';
|
|
299
516
|
/**
|
|
300
|
-
*
|
|
301
|
-
*
|
|
302
|
-
* reaches `max`, the framework fires `onExceed`:
|
|
303
|
-
*
|
|
304
|
-
* - `'steer'` (default) — let the call execute, but emit a synthetic user
|
|
305
|
-
* message after the turn that nudges the model away from re-calling the
|
|
306
|
-
* tool. Reuses the existing post-turn steer pathway used by
|
|
307
|
-
* `toolOutputBudget`. Fires `tool-budget:exceeded` with `mode: 'steer'`.
|
|
308
|
-
* - `'block'` — refuse the call via `tool:gate` `block`. The model sees a
|
|
309
|
-
* `Blocked: <reason>` tool result. Fires `tool-budget:exceeded` with
|
|
310
|
-
* `mode: 'block'`.
|
|
311
|
-
* - **Function** — `(ctx) => { mode, message }`. The consumer supplies the
|
|
312
|
-
* steering / refusal text and chooses the mode dynamically.
|
|
313
|
-
*
|
|
314
|
-
* Counts include both real dispatches and dedup substitutes (Z19 hits).
|
|
315
|
-
* Excludes calls already blocked by an earlier gate (skill allow-list,
|
|
316
|
-
* consumer hook). Tool dispatched by spawned subagents has its own per-run
|
|
317
|
-
* counter — child counts never charge the parent.
|
|
318
|
-
*
|
|
319
|
-
* For MCP tools, key by the namespaced wire name (`mcp_<server>_<tool>`).
|
|
320
|
-
*
|
|
321
|
-
* Atomic in parallel mode: the middleware tracks its own per-tool
|
|
322
|
-
* approval counter, incremented synchronously at gate-time. A
|
|
323
|
-
* 4-call parallel batch against `max: 2` will let the first 2 through
|
|
324
|
-
* and refuse the rest, even though the loop's `runToolCounts` only
|
|
325
|
-
* propagates between calls (not within a single batch's gate fan-out).
|
|
326
|
-
*
|
|
327
|
-
* Default: `undefined` (no budget enforcement).
|
|
517
|
+
* Mark a skill as inactive. Returns the removed `ActiveSkill` record or `undefined`
|
|
518
|
+
* if it wasn't active. Callers fire `skills:deactivate` on removal.
|
|
328
519
|
*/
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
max: number;
|
|
335
|
-
}) => {
|
|
336
|
-
mode: 'steer' | 'block';
|
|
337
|
-
message: string;
|
|
338
|
-
});
|
|
339
|
-
}>;
|
|
520
|
+
deactivate: (name: string) => ActiveSkill | undefined;
|
|
521
|
+
/** Remove every active skill. Returns the list of removed records. */
|
|
522
|
+
clear: () => readonly ActiveSkill[];
|
|
523
|
+
}
|
|
524
|
+
interface SkillActivationStateOptions {
|
|
340
525
|
/**
|
|
341
|
-
*
|
|
342
|
-
*
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
526
|
+
* Cap on concurrent activations. `undefined` (the default) disables the cap.
|
|
527
|
+
* When set, `activate()` returns `'cap-reached'` once the set is at size `maxActive`.
|
|
528
|
+
*/
|
|
529
|
+
maxActive?: number;
|
|
530
|
+
}
|
|
531
|
+
declare function createSkillActivationState(options?: SkillActivationStateOptions): SkillActivationState;
|
|
532
|
+
//#endregion
|
|
533
|
+
//#region src/agent.d.ts
|
|
534
|
+
interface AgentHooks {
|
|
535
|
+
'system:before': (ctx: {
|
|
536
|
+
system: string;
|
|
537
|
+
}) => void;
|
|
538
|
+
'turn:before': (ctx: {
|
|
539
|
+
turn: number;
|
|
540
|
+
turnId: string;
|
|
541
|
+
options: StreamOptions;
|
|
542
|
+
}) => void;
|
|
543
|
+
/**
|
|
544
|
+
* Fires after each assistant turn (before its tool-result follow-up
|
|
545
|
+
* dispatches; the loop iterates back to a fresh `turn:before` once the
|
|
546
|
+
* tool results are produced).
|
|
357
547
|
*
|
|
358
|
-
*
|
|
359
|
-
*
|
|
360
|
-
*
|
|
548
|
+
* `toolCounts.turn` — calls **emitted** by the model in this assistant
|
|
549
|
+
* turn, keyed by canonical tool name. Reflects what the model asked for,
|
|
550
|
+
* regardless of downstream gate outcome. Most useful for spotting per-turn
|
|
551
|
+
* spikes ("the model called todowrite 4 times in one turn").
|
|
361
552
|
*
|
|
362
|
-
*
|
|
363
|
-
*
|
|
364
|
-
*
|
|
365
|
-
*
|
|
366
|
-
*
|
|
367
|
-
*
|
|
368
|
-
* },
|
|
369
|
-
* }
|
|
370
|
-
* ```
|
|
553
|
+
* `toolCounts.run` — cumulative running counter of **dispatched** calls
|
|
554
|
+
* scoped to this `runId`, captured at fire time. Excludes calls that were
|
|
555
|
+
* `block`ed by `tool:gate` handlers. Includes calls short-circuited via
|
|
556
|
+
* `tool:gate` `result` substitution (the model still asked, the framework
|
|
557
|
+
* just answered without the tool running). Resumed sessions start a fresh
|
|
558
|
+
* run with empty counts.
|
|
371
559
|
*
|
|
372
|
-
*
|
|
373
|
-
|
|
374
|
-
|
|
560
|
+
* Both fields are frozen snapshots; mutate-safe.
|
|
561
|
+
*/
|
|
562
|
+
'turn:after': (ctx: {
|
|
563
|
+
turn: number;
|
|
564
|
+
turnId: string;
|
|
565
|
+
usage: TurnUsage;
|
|
566
|
+
message: SessionTurn;
|
|
567
|
+
toolCounts: {
|
|
568
|
+
turn: Readonly<Record<string, number>>;
|
|
569
|
+
run: Readonly<Record<string, number>>;
|
|
570
|
+
};
|
|
571
|
+
}) => void;
|
|
572
|
+
'stream:text': (ctx: StreamHookContext & {
|
|
573
|
+
delta: string;
|
|
574
|
+
text: string;
|
|
575
|
+
}) => void;
|
|
576
|
+
'stream:end': (ctx: StreamHookContext & {
|
|
577
|
+
text: string;
|
|
578
|
+
}) => void;
|
|
579
|
+
'stream:thinking': (ctx: StreamHookContext & {
|
|
580
|
+
delta: string;
|
|
581
|
+
thinking: string;
|
|
582
|
+
}) => void;
|
|
583
|
+
'oauth:refresh': (ctx: OAuthRefreshHookContext) => void;
|
|
584
|
+
/**
|
|
585
|
+
* Fires before validation, `tool:before`, and `execute`. Two ways to
|
|
586
|
+
* intercept:
|
|
375
587
|
*
|
|
376
|
-
*
|
|
377
|
-
*
|
|
378
|
-
*
|
|
379
|
-
*
|
|
588
|
+
* - Set `block = true` (with a `reason`) to refuse the call. The model
|
|
589
|
+
* sees a `Blocked: <reason>` tool result; `tool:before` / `tool:after`
|
|
590
|
+
* do **not** fire.
|
|
591
|
+
* - Set `result` to substitute a successful tool_result and skip
|
|
592
|
+
* execution. The model sees the substitute as a normal tool_result;
|
|
593
|
+
* `tool:before` does not fire, but `tool:after` and `tool:transform`
|
|
594
|
+
* do — so byte budgets, telemetry, and post-mutation hooks see the
|
|
595
|
+
* substitute. Useful for cache hits, dedup, idempotency guards,
|
|
596
|
+
* plan-mode synthetic acks.
|
|
380
597
|
*
|
|
381
|
-
*
|
|
382
|
-
*
|
|
383
|
-
*
|
|
384
|
-
*
|
|
385
|
-
*
|
|
598
|
+
* If multiple handlers along the chain set both `block` and `result`,
|
|
599
|
+
* `block` wins — refusal beats substitution, so a policy gate
|
|
600
|
+
* (skills allow-list, custom security) can always override an upstream
|
|
601
|
+
* consumer's cache substitute. Mirrors the writable-`result` shape on
|
|
602
|
+
* `tool:unknown` and `tool:error` so consumers learn one pattern.
|
|
386
603
|
*
|
|
387
|
-
*
|
|
388
|
-
*
|
|
389
|
-
*
|
|
390
|
-
*
|
|
391
|
-
* `tool:gate` directly.
|
|
604
|
+
* `runToolCounts` — frozen pre-call snapshot of per-tool dispatched
|
|
605
|
+
* counts in this run. Use it to self-throttle, drive observability, or
|
|
606
|
+
* implement budget guards. Counts every call that passed gate, including
|
|
607
|
+
* dedup substitutes (Z19); excludes `block`ed calls.
|
|
392
608
|
*
|
|
393
|
-
*
|
|
609
|
+
* **Parallel mode** (`toolExecution: 'parallel'`, the default): the
|
|
610
|
+
* snapshot is taken before any dispatches in the batch, so consumer
|
|
611
|
+
* hooks reading `runToolCounts` see the pre-batch view. Built-in
|
|
612
|
+
* budget / dedup middleware uses internal per-call reservation, so
|
|
613
|
+
* `behavior.toolBudgets` enforces atomically even within a parallel
|
|
614
|
+
* batch.
|
|
394
615
|
*/
|
|
395
|
-
|
|
616
|
+
'tool:gate': (ctx: ToolHookContext & {
|
|
617
|
+
block: boolean;
|
|
618
|
+
reason: string;
|
|
619
|
+
result?: string | ToolResultContent[];
|
|
620
|
+
runToolCounts: Readonly<Record<string, number>>;
|
|
621
|
+
}) => void;
|
|
622
|
+
'tool:before': (ctx: ToolHookContext & {
|
|
623
|
+
coercions?: readonly string[];
|
|
624
|
+
runToolCounts: Readonly<Record<string, number>>;
|
|
625
|
+
}) => void;
|
|
626
|
+
'tool:after': (ctx: ToolHookContext & {
|
|
627
|
+
result: string | ToolResultContent[];
|
|
628
|
+
outputBytes: number;
|
|
629
|
+
coercions?: readonly string[];
|
|
630
|
+
runToolCounts: Readonly<Record<string, number>>;
|
|
631
|
+
}) => void;
|
|
396
632
|
/**
|
|
397
|
-
*
|
|
398
|
-
*
|
|
399
|
-
*
|
|
400
|
-
*
|
|
401
|
-
* bytes that have moved.
|
|
402
|
-
*
|
|
403
|
-
* Requires a session. Off by default; turn it on for stricter eval-grade
|
|
404
|
-
* runs where silent edit corruption would invalidate the result.
|
|
633
|
+
* Fires when a tool throws during execution. Mutate `result` to substitute a
|
|
634
|
+
* tool-output payload that gets sent back to the model in place of the
|
|
635
|
+
* default `Tool error: <msg>` string — useful for OSS-model error rewriting
|
|
636
|
+
* (collapse stack traces, hide internal paths, prepend recovery hints).
|
|
405
637
|
*
|
|
406
|
-
*
|
|
638
|
+
* The post-hook value flows through `tool:transform` like a normal output, so
|
|
639
|
+
* downstream byte-budgeting and image-stripping still apply.
|
|
407
640
|
*/
|
|
408
|
-
|
|
641
|
+
'tool:error': (ctx: ToolHookContext & {
|
|
642
|
+
error: Error;
|
|
643
|
+
result?: string | ToolResultContent[];
|
|
644
|
+
}) => void;
|
|
645
|
+
'tool:transform': (ctx: ToolHookContext & {
|
|
646
|
+
result: string | ToolResultContent[];
|
|
647
|
+
isError: boolean;
|
|
648
|
+
outputBytes: number;
|
|
649
|
+
coercions?: readonly string[];
|
|
650
|
+
}) => void;
|
|
409
651
|
/**
|
|
410
|
-
*
|
|
411
|
-
*
|
|
412
|
-
*
|
|
413
|
-
*
|
|
414
|
-
* `AnthropicParams.contextManagement`.
|
|
415
|
-
*
|
|
416
|
-
* - `'off'` (default) — no client-side compaction.
|
|
417
|
-
* - `'tail'` — when total tool-output bytes in the persisted history
|
|
418
|
-
* exceed `compactThreshold`, replace older `tool_result` outputs with a
|
|
419
|
-
* short stub, keeping the newest `compactKeepTurns` turns intact. The
|
|
420
|
-
* compaction is applied to the wire-level message list only; the
|
|
421
|
-
* underlying session turns are not modified.
|
|
652
|
+
* Fires before the generic "Unknown tool" error when the model invokes a tool
|
|
653
|
+
* that isn't registered (hallucinated names, dropped MCP servers, dangling
|
|
654
|
+
* aliases). Mutate `result` to substitute a friendly response or set
|
|
655
|
+
* `suppressError: true` to skip the companion `tool:error` emission.
|
|
422
656
|
*
|
|
423
|
-
*
|
|
657
|
+
* Fires for any unknown tool name — including hallucinated MCP-style names
|
|
658
|
+
* (`mcp_supabase_xxx`); branch on `name.startsWith('mcp_')` to differentiate.
|
|
424
659
|
*/
|
|
425
|
-
|
|
660
|
+
'tool:unknown': (ctx: ToolHookContext & {
|
|
661
|
+
result?: string | ToolResultContent[];
|
|
662
|
+
suppressError: boolean;
|
|
663
|
+
}) => void;
|
|
426
664
|
/**
|
|
427
|
-
*
|
|
428
|
-
*
|
|
429
|
-
*
|
|
430
|
-
*
|
|
665
|
+
* Fires when `validateToolArgs` rejects an input that could not be auto-coerced
|
|
666
|
+
* to satisfy the tool's `inputSchema`. Observational — the tool call still
|
|
667
|
+
* surfaces a `Validation error: …` string back to the model. Useful for
|
|
668
|
+
* counting validation failures separately from runtime tool errors.
|
|
431
669
|
*/
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
* for elision so the model keeps the freshest tool context. Default: `4`.
|
|
437
|
-
*/
|
|
438
|
-
compactKeepTurns?: number;
|
|
670
|
+
'validation:reject': (ctx: ToolHookContext & {
|
|
671
|
+
reason: string;
|
|
672
|
+
schema: Record<string, unknown>;
|
|
673
|
+
}) => void;
|
|
439
674
|
/**
|
|
440
|
-
*
|
|
441
|
-
*
|
|
442
|
-
*
|
|
443
|
-
*
|
|
444
|
-
* chunk verbatim without breaking the match.
|
|
445
|
-
*
|
|
446
|
-
* Set `false` to opt out — useful for callers piping `read_file` into
|
|
447
|
-
* downstream parsers that don't recognize the prefix. Per-call
|
|
448
|
-
* `read_file({ lineNumbers: false })` overrides this default.
|
|
675
|
+
* Fires when `validateToolArgs` successfully auto-coerced one or more input
|
|
676
|
+
* fields to satisfy the tool's `inputSchema`. **Only fires when at least one
|
|
677
|
+
* coercion happened** — never on perfectly-shaped inputs. Useful for counting
|
|
678
|
+
* model "wrongness rate" without re-running validation downstream.
|
|
449
679
|
*
|
|
450
|
-
*
|
|
680
|
+
* `coercions` lists the field names that were coerced. The values landed in
|
|
681
|
+
* the input that the tool actually received; consumers wanting before/after
|
|
682
|
+
* comparison can re-run `validateToolArgs(ctx.input, ctx.schema)`.
|
|
451
683
|
*/
|
|
452
|
-
|
|
684
|
+
'validation:coerce': (ctx: ToolHookContext & {
|
|
685
|
+
coercions: readonly string[];
|
|
686
|
+
schema: Record<string, unknown>;
|
|
687
|
+
}) => void;
|
|
688
|
+
'context:transform': (ctx: {
|
|
689
|
+
messages: SessionMessage[];
|
|
690
|
+
}) => void;
|
|
453
691
|
/**
|
|
454
|
-
*
|
|
455
|
-
*
|
|
456
|
-
*
|
|
457
|
-
*
|
|
458
|
-
*
|
|
459
|
-
*
|
|
460
|
-
* Eliminates the common waste pattern where the model carries the
|
|
461
|
-
* pre-edit file body forward across many turns "in case it needs it".
|
|
462
|
-
* Pairs cleanly with `compactStrategy: 'tail'`: stale reads shrink
|
|
463
|
-
* first, then the byte-threshold compaction fires if anything's left.
|
|
692
|
+
* Fires per request, after `context:transform` and before the request goes
|
|
693
|
+
* out. Mutating `ctx.system` updates the system prompt the provider sends
|
|
694
|
+
* for this turn — useful for runtime-derived sections (e.g. listing files
|
|
695
|
+
* already read in the session, surfacing live tool budgets, injecting
|
|
696
|
+
* skill activation reminders).
|
|
464
697
|
*
|
|
465
|
-
*
|
|
466
|
-
*
|
|
467
|
-
*
|
|
468
|
-
* invalidate prior reads.
|
|
698
|
+
* Cache breakpoints are applied inside the provider after this hook, so
|
|
699
|
+
* mutations land in the cache key naturally — repeated turns with the
|
|
700
|
+
* same derived system text still hit the cache.
|
|
469
701
|
*
|
|
470
|
-
*
|
|
702
|
+
* `messages` is read-only here; use `context:transform` for message
|
|
703
|
+
* surgery. `session` is `undefined` when the run is sessionless.
|
|
471
704
|
*/
|
|
472
|
-
|
|
705
|
+
'system:transform': (ctx: {
|
|
706
|
+
system: string;
|
|
707
|
+
messages: readonly SessionMessage[];
|
|
708
|
+
turn: number;
|
|
709
|
+
turnId: string;
|
|
710
|
+
session?: Session;
|
|
711
|
+
}) => void;
|
|
712
|
+
'steer:inject': (ctx: {
|
|
713
|
+
message: string;
|
|
714
|
+
}) => void;
|
|
715
|
+
'spawn:before': (ctx: SpawnHookContext) => void;
|
|
716
|
+
'spawn:complete': (ctx: ChildRunStats) => void;
|
|
717
|
+
'spawn:error': (ctx: SpawnHookContext & {
|
|
718
|
+
error: Error;
|
|
719
|
+
}) => void;
|
|
720
|
+
'child:stream:text': (ctx: StreamHookContext & {
|
|
721
|
+
delta: string;
|
|
722
|
+
text: string;
|
|
723
|
+
childId: string;
|
|
724
|
+
depth: number;
|
|
725
|
+
}) => void;
|
|
726
|
+
'child:stream:thinking': (ctx: StreamHookContext & {
|
|
727
|
+
delta: string;
|
|
728
|
+
thinking: string;
|
|
729
|
+
childId: string;
|
|
730
|
+
depth: number;
|
|
731
|
+
}) => void;
|
|
732
|
+
'child:stream:end': (ctx: StreamHookContext & {
|
|
733
|
+
text: string;
|
|
734
|
+
childId: string;
|
|
735
|
+
depth: number;
|
|
736
|
+
}) => void;
|
|
473
737
|
/**
|
|
474
|
-
*
|
|
475
|
-
*
|
|
476
|
-
*
|
|
477
|
-
*
|
|
478
|
-
* native tool ("lazy" / progressive disclosure).
|
|
479
|
-
*
|
|
480
|
-
* Native tools (those passed to `createAgent({ tools })`) and skill tools
|
|
481
|
-
* are always eager — they are core to the agent and cheap. Only MCP tools
|
|
482
|
-
* are eligible for lazy disclosure.
|
|
483
|
-
*
|
|
484
|
-
* When `'lazy'`, the agent:
|
|
485
|
-
* - Appends a `<searchable_tools>` section to the system prompt listing
|
|
486
|
-
* every MCP tool by `name` + `description` only (no `inputSchema`).
|
|
487
|
-
* - Auto-injects a `tool_search` native tool (opt out via
|
|
488
|
-
* {@link AgentBehavior.toolSearch}) the model uses to load schemas on
|
|
489
|
-
* demand. Surfaced tools persist for the rest of the run.
|
|
490
|
-
* - Rebuilds the wire-level tool list each turn, appending newly-unlocked
|
|
491
|
-
* tools at the end so the prefix-cache breakpoint advances cleanly.
|
|
492
|
-
*
|
|
493
|
-
* Trade-off: every `tool_search` invocation expands the tool list and
|
|
494
|
-
* invalidates the tool-list cache breakpoint for one turn. With many
|
|
495
|
-
* MCP servers, the savings on cold turns (fewer schemas in context) are
|
|
496
|
-
* substantial; with one tiny MCP server, the overhead may not pay back.
|
|
738
|
+
* Gate-style child events. Unlike the other `child:*` events, the bubble
|
|
739
|
+
* passes the **same `ctx` reference** the subagent's loop is awaiting on:
|
|
740
|
+
* setting `ctx.block` / `ctx.reason` / `ctx.result` on a parent listener
|
|
741
|
+
* propagates straight back to the child, refusing or substituting the call.
|
|
497
742
|
*
|
|
498
|
-
*
|
|
743
|
+
* Use these to gate subagent tool calls (native + MCP) from the parent
|
|
744
|
+
* without registering listeners on every child agent. The parent's own
|
|
745
|
+
* `tool:gate` / `mcp:tool:gate` listeners are NOT auto-shared with
|
|
746
|
+
* children — that would also share their budgets and dedup state.
|
|
499
747
|
*/
|
|
500
|
-
|
|
748
|
+
'child:tool:gate': (ctx: ToolHookContext & {
|
|
749
|
+
block: boolean;
|
|
750
|
+
reason: string;
|
|
751
|
+
result?: string | ToolResultContent[];
|
|
752
|
+
runToolCounts: Readonly<Record<string, number>>;
|
|
753
|
+
childId: string;
|
|
754
|
+
depth: number;
|
|
755
|
+
}) => void;
|
|
756
|
+
'child:mcp:tool:gate': (ctx: McpToolHookContext & {
|
|
757
|
+
block: boolean;
|
|
758
|
+
reason: string;
|
|
759
|
+
result?: string | ToolResultContent[];
|
|
760
|
+
childId: string;
|
|
761
|
+
depth: number;
|
|
762
|
+
}) => void;
|
|
763
|
+
'child:tool:before': (ctx: ToolHookContext & {
|
|
764
|
+
coercions?: readonly string[];
|
|
765
|
+
runToolCounts: Readonly<Record<string, number>>;
|
|
766
|
+
childId: string;
|
|
767
|
+
depth: number;
|
|
768
|
+
}) => void;
|
|
769
|
+
'child:tool:after': (ctx: ToolHookContext & {
|
|
770
|
+
result: string | ToolResultContent[];
|
|
771
|
+
outputBytes: number;
|
|
772
|
+
coercions?: readonly string[];
|
|
773
|
+
runToolCounts: Readonly<Record<string, number>>;
|
|
774
|
+
childId: string;
|
|
775
|
+
depth: number;
|
|
776
|
+
}) => void;
|
|
777
|
+
'child:tool:error': (ctx: ToolHookContext & {
|
|
778
|
+
error: Error;
|
|
779
|
+
childId: string;
|
|
780
|
+
depth: number;
|
|
781
|
+
}) => void;
|
|
782
|
+
'child:turn:after': (ctx: {
|
|
783
|
+
turn: number;
|
|
784
|
+
turnId: string;
|
|
785
|
+
usage: TurnUsage;
|
|
786
|
+
message: SessionTurn;
|
|
787
|
+
toolCounts: {
|
|
788
|
+
turn: Readonly<Record<string, number>>;
|
|
789
|
+
run: Readonly<Record<string, number>>;
|
|
790
|
+
};
|
|
791
|
+
childId: string;
|
|
792
|
+
depth: number;
|
|
793
|
+
}) => void;
|
|
794
|
+
'mcp:connect': (ctx: {
|
|
795
|
+
name: string;
|
|
796
|
+
transport: string;
|
|
797
|
+
tools: string[];
|
|
798
|
+
}) => void;
|
|
799
|
+
'mcp:error': (ctx: {
|
|
800
|
+
name: string;
|
|
801
|
+
error: Error;
|
|
802
|
+
}) => void;
|
|
803
|
+
'mcp:close': (ctx: {
|
|
804
|
+
name: string;
|
|
805
|
+
}) => void;
|
|
501
806
|
/**
|
|
502
|
-
*
|
|
503
|
-
*
|
|
807
|
+
* Fires at the start of a per-server bootstrap attempt, before any network I/O.
|
|
808
|
+
* Pairs with `mcp:bootstrap:end` and is always emitted, regardless of outcome.
|
|
809
|
+
*/
|
|
810
|
+
'mcp:bootstrap:start': (ctx: {
|
|
811
|
+
name: string;
|
|
812
|
+
transport: string;
|
|
813
|
+
}) => void;
|
|
814
|
+
/**
|
|
815
|
+
* Fires at the end of a per-server bootstrap attempt. `durationMs` spans from
|
|
816
|
+
* the matching `mcp:bootstrap:start`. On `ok: false` carries the originating
|
|
817
|
+
* error so consumers can log / trace without relying on a separate `mcp:error`.
|
|
818
|
+
*/
|
|
819
|
+
'mcp:bootstrap:end': (ctx: {
|
|
820
|
+
name: string;
|
|
821
|
+
transport: string;
|
|
822
|
+
durationMs: number;
|
|
823
|
+
} & ({
|
|
824
|
+
ok: true;
|
|
825
|
+
toolCount: number;
|
|
826
|
+
} | {
|
|
827
|
+
ok: false;
|
|
828
|
+
error: Error;
|
|
829
|
+
})) => void;
|
|
830
|
+
/**
|
|
831
|
+
* Fires once per server after `listTools()` and after the config-side filters
|
|
832
|
+
* (`enabledTools` / `disabledTools` / `toolFilter`) have applied, but BEFORE
|
|
833
|
+
* tools are registered. Handlers may mutate `ctx.tools` in place — splicing,
|
|
834
|
+
* reordering, or replacing entries — to further narrow what the model sees.
|
|
504
835
|
*
|
|
505
|
-
* -
|
|
506
|
-
*
|
|
507
|
-
*
|
|
508
|
-
* pointed at a non-existent tool.
|
|
509
|
-
* - `limit` — default cap on results returned per `tool_search` call when
|
|
510
|
-
* the model omits the parameter. Default: `20`.
|
|
836
|
+
* Composes with config-side filters: config drops tools the host's static
|
|
837
|
+
* policy excludes; this hook is the runtime escape hatch for per-user, per-
|
|
838
|
+
* environment, or capability-driven decisions that the config can't express.
|
|
511
839
|
*
|
|
512
|
-
*
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
840
|
+
* Items are upstream tool descriptors (NOT yet namespaced as `mcp_<server>_<tool>`).
|
|
841
|
+
*/
|
|
842
|
+
'mcp:tools:filter': (ctx: {
|
|
843
|
+
server: string;
|
|
844
|
+
transport: 'stdio' | 'sse' | 'streamable-http';
|
|
845
|
+
tools: Array<{
|
|
846
|
+
name: string;
|
|
847
|
+
description?: string | null;
|
|
848
|
+
inputSchema?: unknown;
|
|
849
|
+
}>;
|
|
850
|
+
}) => void;
|
|
851
|
+
/**
|
|
852
|
+
* MCP-side counterpart of `tool:gate`. Same shape: set `block` to refuse,
|
|
853
|
+
* set `result` to substitute a successful payload and skip the upstream
|
|
854
|
+
* MCP `callTool`. When both are set across the handler chain, `block` wins.
|
|
521
855
|
*
|
|
522
|
-
*
|
|
856
|
+
* Fires INSIDE the MCP wrapper's `execute`, after the loop's `tool:gate`
|
|
857
|
+
* already ran. Does **not** carry `runToolCounts` — those are loop-level
|
|
858
|
+
* and already exposed on `tool:gate` for MCP tools (which are registered
|
|
859
|
+
* as agent tools under their namespaced name `mcp_<server>_<tool>`). Use
|
|
860
|
+
* `tool:gate` for budget / dedup logic; reserve `mcp:tool:gate` for
|
|
861
|
+
* MCP-specific concerns (per-server routing, transport-aware refusals).
|
|
523
862
|
*/
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
}
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
* MCP servers can return a mix of text, image, resource, and audio blocks. Tools
|
|
568
|
-
* return `string` for the common text-only case or `ToolResultContent[]` when they
|
|
569
|
-
* need to preserve non-text content (e.g. screenshots from a browser MCP).
|
|
570
|
-
*
|
|
571
|
-
* Providers that support native multi-part tool results (Anthropic, OpenAI Codex via
|
|
572
|
-
* pi-ai) route image blocks into their wire format verbatim; OpenAI-compat providers
|
|
573
|
-
* route them via a companion-user-message fallback when the underlying model/endpoint
|
|
574
|
-
* does not accept images inside tool-role messages.
|
|
575
|
-
*/
|
|
576
|
-
type ToolResultContent = ToolResultTextContent | ToolResultImageContent;
|
|
577
|
-
interface ToolResultTextContent {
|
|
578
|
-
type: 'text';
|
|
579
|
-
text: string;
|
|
580
|
-
}
|
|
581
|
-
interface ToolResultImageContent {
|
|
582
|
-
type: 'image';
|
|
583
|
-
/** IANA media type (e.g. `image/png`, `image/jpeg`) */
|
|
584
|
-
mediaType: string;
|
|
585
|
-
/** Base64-encoded payload */
|
|
586
|
-
data: string;
|
|
587
|
-
}
|
|
588
|
-
/**
|
|
589
|
-
* Lossy flattener — converts `ToolResultContent[]` (or a plain string) to a single
|
|
590
|
-
* string. Image blocks are replaced with `[image: <media> — <n> b64 bytes]` markers.
|
|
591
|
-
*
|
|
592
|
-
* Use at UI boundaries where a string is required; providers that understand
|
|
593
|
-
* structured content should route the array through without flattening.
|
|
594
|
-
*/
|
|
595
|
-
declare function toolResultToText(content: string | ToolResultContent[]): string;
|
|
596
|
-
/**
|
|
597
|
-
* Approximate byte length of a tool output as it goes back to the model.
|
|
598
|
-
*
|
|
599
|
-
* - Plain text: UTF-8 byte length.
|
|
600
|
-
* - Structured content: text blocks contribute their UTF-8 byte length; image
|
|
601
|
-
* blocks contribute their **base64 character length**, since that is what
|
|
602
|
-
* the model tokenizes (the wire-encoded payload, not the decoded image).
|
|
603
|
-
*
|
|
604
|
-
* Used by the agent loop to populate `outputBytes` on `tool:after`,
|
|
605
|
-
* `tool:transform`, `mcp:tool:after`, and `mcp:tool:transform` hooks so
|
|
606
|
-
* consumers can size-budget tool output without re-counting bytes themselves.
|
|
607
|
-
*/
|
|
608
|
-
declare function toolOutputByteLength(content: string | ToolResultContent[]): number;
|
|
609
|
-
type SessionContentBlock = {
|
|
610
|
-
type: 'text';
|
|
611
|
-
text: string;
|
|
612
|
-
} | {
|
|
613
|
-
type: 'image';
|
|
614
|
-
mediaType: string;
|
|
615
|
-
data: string;
|
|
616
|
-
} | {
|
|
617
|
-
type: 'tool_call';
|
|
618
|
-
id: string;
|
|
619
|
-
name: string;
|
|
620
|
-
input: Record<string, unknown>;
|
|
621
|
-
} | {
|
|
622
|
-
type: 'tool_result';
|
|
623
|
-
callId: string;
|
|
624
|
-
/**
|
|
625
|
-
* Tool output — either a plain string (text-only, the common case) or a structured
|
|
626
|
-
* array of content blocks (text + image for multimodal tools such as screenshots).
|
|
627
|
-
*/
|
|
628
|
-
output: string | ToolResultContent[];
|
|
629
|
-
isError?: boolean;
|
|
630
|
-
} | {
|
|
631
|
-
type: 'thinking';
|
|
632
|
-
text: string;
|
|
633
|
-
signature?: string;
|
|
863
|
+
'mcp:tool:gate': (ctx: McpToolHookContext & {
|
|
864
|
+
block: boolean;
|
|
865
|
+
reason: string;
|
|
866
|
+
result?: string | ToolResultContent[];
|
|
867
|
+
}) => void;
|
|
868
|
+
'mcp:tool:before': (ctx: McpToolHookContext) => void;
|
|
869
|
+
'mcp:tool:after': (ctx: McpToolHookContext & {
|
|
870
|
+
result: string | ToolResultContent[];
|
|
871
|
+
outputBytes: number;
|
|
872
|
+
}) => void;
|
|
873
|
+
'mcp:tool:transform': (ctx: McpToolHookContext & {
|
|
874
|
+
result: string | ToolResultContent[];
|
|
875
|
+
outputBytes: number;
|
|
876
|
+
}) => void;
|
|
877
|
+
'mcp:tool:error': (ctx: McpToolHookContext & {
|
|
878
|
+
error: Error;
|
|
879
|
+
}) => void;
|
|
880
|
+
'skills:resolve': (ctx: {
|
|
881
|
+
skills: SkillConfig[];
|
|
882
|
+
}) => void;
|
|
883
|
+
'skills:catalog': (ctx: {
|
|
884
|
+
catalog: string;
|
|
885
|
+
skills: SkillConfig[];
|
|
886
|
+
}) => void;
|
|
887
|
+
'skills:activate': (ctx: {
|
|
888
|
+
skill: SkillConfig;
|
|
889
|
+
via: ActivationVia;
|
|
890
|
+
}) => void;
|
|
891
|
+
'skills:deactivate': (ctx: {
|
|
892
|
+
skill: SkillConfig;
|
|
893
|
+
reason: DeactivationReason;
|
|
894
|
+
}) => void;
|
|
895
|
+
'usage': (ctx: {
|
|
896
|
+
turn: number;
|
|
897
|
+
turnId: string;
|
|
898
|
+
usage: TurnUsage;
|
|
899
|
+
totalIn: number;
|
|
900
|
+
totalOut: number;
|
|
901
|
+
}) => void;
|
|
902
|
+
'output': (ctx: {
|
|
903
|
+
output: Record<string, unknown>;
|
|
904
|
+
schema: Record<string, unknown>;
|
|
905
|
+
}) => void;
|
|
634
906
|
/**
|
|
635
|
-
*
|
|
636
|
-
*
|
|
637
|
-
*
|
|
907
|
+
* Fires when a turn's total tool-output bytes exceed `behavior.toolOutputBudget`.
|
|
908
|
+
* Measured post-`tool:transform`. Loop injects a synthetic user message after
|
|
909
|
+
* the tool-results turn instructing the model to summarize.
|
|
638
910
|
*/
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
911
|
+
'budget:exceeded': (ctx: {
|
|
912
|
+
turn: number;
|
|
913
|
+
turnId: string;
|
|
914
|
+
bytes: number;
|
|
915
|
+
budget: number;
|
|
916
|
+
}) => void;
|
|
644
917
|
/**
|
|
645
|
-
*
|
|
646
|
-
*
|
|
647
|
-
* `
|
|
648
|
-
*
|
|
918
|
+
* Fires when a per-tool budget configured via `behavior.toolBudgets` is
|
|
919
|
+
* exceeded for a specific tool. `mode` reflects how the framework reacted:
|
|
920
|
+
* `'steer'` lets the call run and queues a post-turn nudge; `'block'`
|
|
921
|
+
* refuses the call outright with `Blocked: <message>`.
|
|
649
922
|
*
|
|
650
|
-
*
|
|
651
|
-
*
|
|
652
|
-
*
|
|
653
|
-
|
|
654
|
-
type: 'provider_reasoning';
|
|
655
|
-
producer: 'openrouter';
|
|
656
|
-
details: unknown[];
|
|
657
|
-
/**
|
|
658
|
-
* Model id that produced the details. Reasoning is bound to a specific
|
|
659
|
-
* upstream route — a model switch on the next turn invalidates the
|
|
660
|
-
* embedded signatures, so the sender drops the block on mismatch.
|
|
923
|
+
* `count` is the run-cumulative dispatched count just before this call.
|
|
924
|
+
* Use `turnId` to correlate with `turn:after` if you need the integer turn
|
|
925
|
+
* index. Distinct from `budget:exceeded` (byte-level) so consumers can
|
|
926
|
+
* subscribe specifically; both can fire in the same turn.
|
|
661
927
|
*/
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
id: string;
|
|
671
|
-
/** Run that produced this turn (e.g. 'run_1') */
|
|
672
|
-
runId?: string;
|
|
673
|
-
role: 'user' | 'assistant' | 'system';
|
|
674
|
-
content: SessionContentBlock[];
|
|
675
|
-
/** Token usage — only present on assistant turns */
|
|
676
|
-
usage?: TurnUsage;
|
|
677
|
-
/** Unix timestamp (Date.now()) when the turn was created */
|
|
678
|
-
createdAt: number;
|
|
679
|
-
}
|
|
680
|
-
/**
|
|
681
|
-
* Per-run hook registrations. Each entry can be a single handler or an array of handlers.
|
|
682
|
-
* Keys are `AgentHooks` event names (loose-typed here to avoid a circular import; agent.ts
|
|
683
|
-
* narrows it to the strongly-typed map).
|
|
684
|
-
*/
|
|
685
|
-
type RunHookMap = Record<string, ((ctx: any) => unknown) | ((ctx: any) => unknown)[]>;
|
|
686
|
-
interface AgentRunOptions {
|
|
687
|
-
model?: string;
|
|
928
|
+
'tool-budget:exceeded': (ctx: {
|
|
929
|
+
tool: string;
|
|
930
|
+
count: number;
|
|
931
|
+
max: number;
|
|
932
|
+
turnId: string;
|
|
933
|
+
mode: 'steer' | 'block';
|
|
934
|
+
}) => void;
|
|
935
|
+
'agent:abort': (ctx: object) => void;
|
|
688
936
|
/**
|
|
689
|
-
*
|
|
937
|
+
* Run finished — fires on all exit paths (completion, maxTurns, abort).
|
|
690
938
|
*
|
|
691
|
-
*
|
|
692
|
-
*
|
|
939
|
+
* Since 4.0 the `AgentStats` carried here is **cumulative** across the
|
|
940
|
+
* parent agent loop and every recursively-spawned sub-agent
|
|
941
|
+
* (`totalIn` / `totalOut` / `cost` / `totalCacheRead` / `totalCacheCreation`).
|
|
942
|
+
* For parent-loop-only counts use `ctx.turnUsage` (parent-only array);
|
|
943
|
+
* for tree-wide turn counts use `flattenTurns(ctx).length`.
|
|
693
944
|
*/
|
|
694
|
-
|
|
945
|
+
'agent:done': (ctx: AgentStats) => void;
|
|
946
|
+
'session:start': (ctx: SessionHookContext & {
|
|
947
|
+
runId: string;
|
|
948
|
+
prompt: string;
|
|
949
|
+
}) => void;
|
|
950
|
+
'session:end': (ctx: SessionHookContext & {
|
|
951
|
+
runId: string;
|
|
952
|
+
status: SessionEndStatus;
|
|
953
|
+
turnRange: [number, number];
|
|
954
|
+
}) => void;
|
|
955
|
+
'session:turns': (ctx: SessionHookContext & {
|
|
956
|
+
turns: SessionTurn[];
|
|
957
|
+
count: number;
|
|
958
|
+
}) => void;
|
|
959
|
+
'session:meta': (ctx: SessionHookContext & {
|
|
960
|
+
key: string;
|
|
961
|
+
value: unknown;
|
|
962
|
+
}) => void;
|
|
963
|
+
'session:save': (ctx: SessionHookContext) => void;
|
|
964
|
+
}
|
|
965
|
+
interface AgentOptions {
|
|
966
|
+
provider: Provider;
|
|
967
|
+
/** Display name for the agent (used in traces/logs). */
|
|
968
|
+
name?: string;
|
|
969
|
+
/** Default system prompt injected when no system is provided at run time. */
|
|
695
970
|
system?: string;
|
|
696
|
-
|
|
697
|
-
/** Abort signal — when triggered, the agent stops after the current turn */
|
|
698
|
-
signal?: AbortSignal;
|
|
699
|
-
/** Behavior overrides for this run (overrides agent defaults) */
|
|
700
|
-
behavior?: AgentBehavior;
|
|
701
|
-
/** Tool overrides for this run. Pass {} for no tools. Omit to use agent tools. */
|
|
971
|
+
/** Tool definitions available to the agent. Defaults to no tools. */
|
|
702
972
|
tools?: Record<string, ToolDef>;
|
|
703
973
|
/**
|
|
704
|
-
*
|
|
705
|
-
* detached in a finally block so handlers never leak across runs.
|
|
974
|
+
* Map canonical tool names to LLM-facing (aliased) names.
|
|
706
975
|
*
|
|
707
|
-
*
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
/**
|
|
711
|
-
* Parent run id. Populated automatically by the `spawn` tool when the child
|
|
712
|
-
* shares the parent's session; recorded on the resulting `SessionRun` so the
|
|
713
|
-
* parent↔child run tree can be reconstructed from a persisted session.
|
|
714
|
-
*/
|
|
715
|
-
parentRunId?: string;
|
|
716
|
-
/**
|
|
717
|
-
* Zero-based subagent depth. 0 = top-level `agent.run()`, 1 = first-level
|
|
718
|
-
* child spawned by a parent agent, and so on. Used by the spawn tool to
|
|
719
|
-
* enforce `maxDepth` and to stamp `child:*` forwarded hook payloads.
|
|
720
|
-
*/
|
|
721
|
-
depth?: number;
|
|
722
|
-
}
|
|
723
|
-
/**
|
|
724
|
-
* Reason the provider gave for stopping the turn.
|
|
725
|
-
*
|
|
726
|
-
* - `'stop'` — natural turn end (`end_turn` / `stop_sequence`).
|
|
727
|
-
* - `'tool-calls'` — model emitted tool_use blocks.
|
|
728
|
-
* - `'length'` — `max_tokens` reached, or (Anthropic 4.6+) the response bumped
|
|
729
|
-
* against the model's context window mid-stream
|
|
730
|
-
* (`model_context_window_exceeded`). The partial response is preserved; the
|
|
731
|
-
* loop emits this reason so consumers can prune/retry.
|
|
732
|
-
* - `'content-filter'` — model refused.
|
|
733
|
-
* - `'pause'` — Anthropic `pause_turn`: a server-side mid-turn pause for very
|
|
734
|
-
* long thinking. The loop continues with a synthetic "Please continue."
|
|
735
|
-
* user message rather than terminating; consumers see the pause via this
|
|
736
|
-
* finish reason on the prior assistant turn.
|
|
737
|
-
* - `'error'` — provider classified the turn as failed.
|
|
738
|
-
* - `'other'` — unknown / unmapped.
|
|
739
|
-
*/
|
|
740
|
-
type TurnFinishReason = 'stop' | 'tool-calls' | 'length' | 'content-filter' | 'pause' | 'error' | 'other';
|
|
741
|
-
interface TurnUsage {
|
|
742
|
-
input: number;
|
|
743
|
-
output: number;
|
|
744
|
-
/** Tokens written to cache (Anthropic) */
|
|
745
|
-
cacheCreation?: number;
|
|
746
|
-
/** Tokens read from cache (Anthropic) */
|
|
747
|
-
cacheRead?: number;
|
|
748
|
-
/** Thinking/reasoning tokens used */
|
|
749
|
-
thinking?: number;
|
|
750
|
-
/** Cost in USD as reported by the provider (OpenRouter) */
|
|
751
|
-
cost?: number;
|
|
752
|
-
/**
|
|
753
|
-
* Why the model stopped this turn. Providers normalize native stop reasons to this union.
|
|
754
|
-
* Absent when the provider did not surface a reason (e.g. mock turns).
|
|
755
|
-
*/
|
|
756
|
-
finishReason?: TurnFinishReason;
|
|
757
|
-
/**
|
|
758
|
-
* The model ID the provider ultimately used. May differ from the requested model when the
|
|
759
|
-
* provider remaps aliases. Absent for providers that do not echo a model ID.
|
|
760
|
-
*/
|
|
761
|
-
modelId?: string;
|
|
762
|
-
}
|
|
763
|
-
interface AgentStats {
|
|
764
|
-
/**
|
|
765
|
-
* Cumulative input tokens across the parent agent loop **and** every
|
|
766
|
-
* recursively-spawned sub-agent. Use this for billing / token-ledger
|
|
767
|
-
* consumption.
|
|
768
|
-
*/
|
|
769
|
-
totalIn: number;
|
|
770
|
-
/** Cumulative output tokens. Same semantics as {@link AgentStats.totalIn}. */
|
|
771
|
-
totalOut: number;
|
|
772
|
-
/**
|
|
773
|
-
* Cumulative cache-read tokens across the parent agent loop and every
|
|
774
|
-
* recursively-spawned sub-agent. Surfaced at the top level (rather than
|
|
775
|
-
* only per-`TurnUsage`) because Anthropic prices cache reads at a separate
|
|
776
|
-
* line-item rate from regular input — billing-correct cost computation
|
|
777
|
-
* needs this number directly. Always `0` for providers that don't report
|
|
778
|
-
* cache usage.
|
|
779
|
-
*/
|
|
780
|
-
totalCacheRead: number;
|
|
781
|
-
/**
|
|
782
|
-
* Cumulative cache-creation tokens across the parent agent loop and every
|
|
783
|
-
* recursively-spawned sub-agent. Same rationale as
|
|
784
|
-
* {@link AgentStats.totalCacheRead} — separate Anthropic billing rate.
|
|
785
|
-
* Always `0` for providers that don't report cache usage.
|
|
976
|
+
* Aliasing is **LLM-boundary-only**: the alias is what the provider's tool spec
|
|
977
|
+
* carries and what the model calls the tool; the canonical name is what lives in
|
|
978
|
+
* `session.turns` and what the agent uses to look up the tool implementation.
|
|
786
979
|
*/
|
|
787
|
-
|
|
980
|
+
toolAliases?: Record<string, string>;
|
|
981
|
+
/** Agent-level behavior defaults (overridden by run-level behavior) */
|
|
982
|
+
behavior?: AgentBehavior;
|
|
983
|
+
/** Execution context: where tools run. Defaults to in-process. */
|
|
984
|
+
execution?: ExecutionContext;
|
|
985
|
+
/** MCP servers to connect and expose as tools */
|
|
986
|
+
mcpServers?: McpServerConfig[];
|
|
987
|
+
/** Session for identity, turn persistence, and run tracking */
|
|
988
|
+
session?: Session;
|
|
989
|
+
/** Skills configuration */
|
|
990
|
+
skills?: SkillsConfig;
|
|
788
991
|
/**
|
|
789
|
-
*
|
|
790
|
-
*
|
|
791
|
-
*
|
|
792
|
-
*
|
|
992
|
+
* Test seam — replaces the default MCP connector with a custom
|
|
993
|
+
* implementation. Bypasses the `mcpServers` normalization layer entirely
|
|
994
|
+
* and is **not** part of the supported public API. Subject to change or
|
|
995
|
+
* removal in any release.
|
|
793
996
|
*
|
|
794
|
-
*
|
|
795
|
-
*/
|
|
796
|
-
turns: number;
|
|
797
|
-
/**
|
|
798
|
-
* Wall-clock duration of the top-level `agent.run()` call, in milliseconds.
|
|
799
|
-
* Children run during parent tool calls so this naturally subsumes child
|
|
800
|
-
* wall time — sequential children inflate it, parallel children compress
|
|
801
|
-
* into the parent's window.
|
|
997
|
+
* @internal
|
|
802
998
|
*/
|
|
803
|
-
|
|
999
|
+
mcpConnector?: (configs: McpServerConfig[]) => Promise<McpConnection>;
|
|
804
1000
|
/**
|
|
805
|
-
*
|
|
806
|
-
*
|
|
807
|
-
*
|
|
1001
|
+
* Pre-connect MCP servers in the background as soon as `createAgent` returns,
|
|
1002
|
+
* instead of deferring the bootstrap to the first `agent.run()`.
|
|
1003
|
+
*
|
|
1004
|
+
* Useful when MCP latency is the dominant cost of a cold start: callers that
|
|
1005
|
+
* construct the agent early (e.g. at process init) can hide the bootstrap
|
|
1006
|
+
* behind other setup work. If bootstrap fails, the error is stored and
|
|
1007
|
+
* surfaced on the first `agent.run()` / `agent.warmup()`; the in-flight
|
|
1008
|
+
* promise is `await`ed by both paths so the error is never silently lost.
|
|
1009
|
+
*
|
|
1010
|
+
* No-op when `mcpServers` is empty. Default: `false`.
|
|
808
1011
|
*/
|
|
809
|
-
|
|
1012
|
+
eager?: boolean;
|
|
1013
|
+
}
|
|
1014
|
+
interface Agent {
|
|
1015
|
+
hooks: Hookable<AgentHooks>;
|
|
1016
|
+
run: (options: AgentRunOptions) => Promise<AgentStats>;
|
|
1017
|
+
abort: () => void;
|
|
1018
|
+
steer: (message: string) => void;
|
|
1019
|
+
followUp: (message: string) => void;
|
|
1020
|
+
waitForIdle: () => Promise<void>;
|
|
810
1021
|
/**
|
|
811
|
-
*
|
|
812
|
-
*
|
|
813
|
-
*
|
|
1022
|
+
* Clear the agent's in-memory state (turns, queues, skill activations).
|
|
1023
|
+
* Fires `skills:deactivate` with `reason: 'reset'` for each previously active
|
|
1024
|
+
* skill. Awaiting lets host apps observe listener rejections.
|
|
814
1025
|
*/
|
|
815
|
-
|
|
816
|
-
/** Stats from child agents spawned during this run, in completion order. Recursive. */
|
|
817
|
-
children?: ChildRunStats[];
|
|
818
|
-
/** Structured output from schema enforcement (only present when behavior.schema is set) */
|
|
819
|
-
output?: Record<string, unknown>;
|
|
1026
|
+
reset: () => Promise<void>;
|
|
820
1027
|
/**
|
|
821
|
-
*
|
|
822
|
-
*
|
|
823
|
-
*
|
|
824
|
-
* Absent when the run produced no observable signals (e.g. aborted before any stream event).
|
|
1028
|
+
* Destroy the execution context and clean up resources.
|
|
1029
|
+
* Idempotent — safe to call from both a `finally` block and a signal handler.
|
|
825
1030
|
*/
|
|
826
|
-
|
|
827
|
-
}
|
|
828
|
-
interface ChildRunStats {
|
|
829
|
-
id: string;
|
|
830
|
-
task: string;
|
|
1031
|
+
destroy: () => Promise<void>;
|
|
831
1032
|
/**
|
|
832
|
-
*
|
|
833
|
-
*
|
|
834
|
-
*
|
|
835
|
-
*
|
|
1033
|
+
* Explicitly activate a skill by name. Fires `skills:activate` with
|
|
1034
|
+
* `via: 'explicit'`. Throws if the skill isn't in the resolved catalog or
|
|
1035
|
+
* if the `maxActive` cap is reached. Idempotent — activating an already-active
|
|
1036
|
+
* skill is a no-op.
|
|
836
1037
|
*/
|
|
837
|
-
|
|
1038
|
+
activateSkill: (name: string) => Promise<void>;
|
|
838
1039
|
/**
|
|
839
|
-
*
|
|
840
|
-
*
|
|
841
|
-
* runs by depth.
|
|
1040
|
+
* Deactivate a skill by name. Fires `skills:deactivate` with `reason: 'explicit'`.
|
|
1041
|
+
* No-op when the skill wasn't active.
|
|
842
1042
|
*/
|
|
843
|
-
|
|
1043
|
+
deactivateSkill: (name: string) => Promise<void>;
|
|
844
1044
|
/**
|
|
845
|
-
*
|
|
846
|
-
*
|
|
847
|
-
*
|
|
1045
|
+
* Pre-connect MCP servers without running a turn. Idempotent and concurrency-safe:
|
|
1046
|
+
* - No MCP servers configured → resolves immediately.
|
|
1047
|
+
* - Connection already established → resolves immediately.
|
|
1048
|
+
* - Another `warmup()` / `run()` is bootstrapping → awaits the in-flight promise.
|
|
1049
|
+
*
|
|
1050
|
+
* Use from host code that wants to hide MCP bootstrap latency behind other
|
|
1051
|
+
* startup work (UI init, auth, etc.). Safe to call multiple times and from
|
|
1052
|
+
* multiple callers concurrently.
|
|
848
1053
|
*/
|
|
849
|
-
|
|
1054
|
+
warmup: () => Promise<void>;
|
|
1055
|
+
readonly isRunning: boolean;
|
|
1056
|
+
readonly turns: SessionTurn[];
|
|
1057
|
+
readonly execution: ExecutionContext;
|
|
1058
|
+
readonly handle: ExecutionHandle | null;
|
|
1059
|
+
readonly session: Session | null;
|
|
1060
|
+
/** Snapshot of currently active skills. */
|
|
1061
|
+
readonly activeSkills: readonly ActiveSkill[];
|
|
850
1062
|
/**
|
|
851
|
-
*
|
|
852
|
-
*
|
|
853
|
-
*
|
|
1063
|
+
* Frozen view of the underlying `provider.meta`. Read-only to prevent
|
|
1064
|
+
* accidental cross-agent contamination — writes are rejected at runtime
|
|
1065
|
+
* (via `Object.freeze`) and at compile time (via `Readonly`). To override
|
|
1066
|
+
* model / capability defaults, construct a new provider.
|
|
854
1067
|
*/
|
|
855
|
-
|
|
856
|
-
}
|
|
857
|
-
/**
|
|
858
|
-
* Base context for tool execution hooks.
|
|
859
|
-
*
|
|
860
|
-
* `name` is the canonical tool identity — the spec name registered on the agent (or the
|
|
861
|
-
* `mcp_{server}_{tool}` name for MCP tools). Hooks should policy-match against `name`.
|
|
862
|
-
*
|
|
863
|
-
* `displayName` is the outward-facing name — the alias surfaced to the LLM when
|
|
864
|
-
* `AgentOptions.toolAliases` maps the canonical name; otherwise equal to `name`.
|
|
865
|
-
* UI/telemetry adapters should emit `displayName`.
|
|
866
|
-
*
|
|
867
|
-
* Canonical vs. alias matters on session resume: `session.turns` persists canonical
|
|
868
|
-
* names only, so renaming an alias cannot desync history.
|
|
869
|
-
*/
|
|
870
|
-
interface ToolHookContext {
|
|
871
|
-
turnId: string;
|
|
872
|
-
callId: string;
|
|
873
|
-
/** Canonical tool name (spec name). Stable across alias-map changes. */
|
|
874
|
-
name: string;
|
|
875
|
-
/** Aliased (wire) name — equal to `name` when no alias is defined. */
|
|
876
|
-
displayName: string;
|
|
877
|
-
input: Record<string, unknown>;
|
|
1068
|
+
readonly meta: Readonly<Record<string, unknown>>;
|
|
878
1069
|
}
|
|
1070
|
+
declare function createAgent({
|
|
1071
|
+
provider,
|
|
1072
|
+
name: agentName,
|
|
1073
|
+
system: agentSystem,
|
|
1074
|
+
tools: agentTools,
|
|
1075
|
+
toolAliases,
|
|
1076
|
+
behavior: agentBehavior,
|
|
1077
|
+
execution,
|
|
1078
|
+
mcpServers,
|
|
1079
|
+
session,
|
|
1080
|
+
skills: agentSkills,
|
|
1081
|
+
mcpConnector,
|
|
1082
|
+
eager
|
|
1083
|
+
}: AgentOptions): Agent;
|
|
1084
|
+
//#endregion
|
|
1085
|
+
//#region src/tools/types.d.ts
|
|
879
1086
|
/**
|
|
880
|
-
*
|
|
881
|
-
*
|
|
882
|
-
* `tool` is the native tool name on the MCP server. `server` is the configured server
|
|
883
|
-
* name. The canonical zidane-namespaced identity is `mcp_{server}_{tool}`.
|
|
1087
|
+
* Runtime context passed to every tool execution.
|
|
1088
|
+
* Provides access to the agent's provider, abort signal, execution environment, and hooks.
|
|
884
1089
|
*
|
|
885
|
-
*
|
|
886
|
-
*
|
|
887
|
-
* alias that the LLM sees.
|
|
1090
|
+
* The preset-y fields (`name`, `system`, `tools`, `toolAliases`, `mcpServers`, `skills`,
|
|
1091
|
+
* `behavior`) mirror the agent's own options so child-spawning tools can inherit them.
|
|
888
1092
|
*/
|
|
889
|
-
interface
|
|
1093
|
+
interface ToolContext {
|
|
1094
|
+
/** The LLM provider for this agent run */
|
|
1095
|
+
provider: Provider;
|
|
1096
|
+
/** Abort signal — tools should check this for early termination */
|
|
1097
|
+
signal: AbortSignal;
|
|
1098
|
+
/** The execution context (shell, filesystem, etc.) */
|
|
1099
|
+
execution: ExecutionContext;
|
|
1100
|
+
/** The active execution handle for the current agent run */
|
|
1101
|
+
handle: ExecutionHandle;
|
|
1102
|
+
/** Agent hooks for emitting events (e.g. spawn:complete) */
|
|
1103
|
+
hooks: Hookable<AgentHooks>;
|
|
1104
|
+
/** Agent display name (preset or user-supplied) */
|
|
1105
|
+
name?: string;
|
|
1106
|
+
/** Agent default system prompt */
|
|
1107
|
+
system?: string;
|
|
1108
|
+
/** Source tool map the agent was created with (pre-MCP-merge, pre-skills-injection) */
|
|
1109
|
+
tools: Record<string, ToolDef>;
|
|
1110
|
+
/**
|
|
1111
|
+
* Map canonical tool names to LLM-facing (aliased) names.
|
|
1112
|
+
*
|
|
1113
|
+
* Aliasing is **LLM-boundary-only**:
|
|
1114
|
+
* - The alias is what the provider's tool spec carries, what the model calls it, and
|
|
1115
|
+
* what appears in `ToolHookContext.displayName` / `McpToolHookContext.displayName`.
|
|
1116
|
+
* - The canonical name is what lives in `session.turns`, `ToolHookContext.name`, and
|
|
1117
|
+
* what the agent uses to look up the tool implementation. Alias changes never
|
|
1118
|
+
* desync persisted history.
|
|
1119
|
+
*/
|
|
1120
|
+
toolAliases?: Record<string, string>;
|
|
1121
|
+
/** MCP servers configured on the agent (for child inheritance) */
|
|
1122
|
+
mcpServers?: McpServerConfig[];
|
|
1123
|
+
/** Skills configuration (for child inheritance) */
|
|
1124
|
+
skills?: SkillsConfig;
|
|
1125
|
+
/** Behavior defaults (for child inheritance) */
|
|
1126
|
+
behavior?: AgentBehavior;
|
|
1127
|
+
/** Turn ID that requested this tool call */
|
|
890
1128
|
turnId: string;
|
|
1129
|
+
/** Tool call ID from the model */
|
|
891
1130
|
callId: string;
|
|
892
|
-
server: string;
|
|
893
|
-
tool: string;
|
|
894
|
-
/** Aliased wire name for this MCP tool, or the canonical `mcp_{server}_{tool}` name. */
|
|
895
|
-
displayName: string;
|
|
896
|
-
input: Record<string, unknown>;
|
|
897
|
-
}
|
|
898
|
-
/** Base context for session hooks */
|
|
899
|
-
interface SessionHookContext {
|
|
900
|
-
sessionId: string;
|
|
901
|
-
}
|
|
902
|
-
/** Base context for spawn hooks */
|
|
903
|
-
interface SpawnHookContext {
|
|
904
|
-
id: string;
|
|
905
|
-
task: string;
|
|
906
1131
|
/**
|
|
907
|
-
*
|
|
908
|
-
*
|
|
909
|
-
*
|
|
1132
|
+
* The run id this tool call is part of. Populated by the agent loop when
|
|
1133
|
+
* invoking tools. Optional on the type so host code constructing contexts
|
|
1134
|
+
* by hand (tests, direct tool invocations) doesn't have to synthesize one.
|
|
1135
|
+
*
|
|
1136
|
+
* Spawn-style tools rely on this to tag child runs with `parentRunId` so
|
|
1137
|
+
* the subagent tree can be reconstructed from a persisted session.
|
|
1138
|
+
*/
|
|
1139
|
+
runId?: string;
|
|
1140
|
+
/**
|
|
1141
|
+
* The agent's session, when one was provided to `createAgent`. Tools that
|
|
1142
|
+
* want to persist their own state (or, in the case of `spawn`, inherit the
|
|
1143
|
+
* parent's session for child persistence) can read from here.
|
|
1144
|
+
*/
|
|
1145
|
+
session?: Session;
|
|
1146
|
+
/**
|
|
1147
|
+
* Subagent depth for the agent owning this tool call. 0 = top-level,
|
|
1148
|
+
* 1 = first-level child, … Used by spawn to enforce a `maxDepth` cap.
|
|
1149
|
+
* Undefined is treated as 0 by spawn.
|
|
910
1150
|
*/
|
|
911
1151
|
depth?: number;
|
|
912
1152
|
}
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
expires: number;
|
|
926
|
-
};
|
|
927
|
-
credentials: Record<string, unknown> & {
|
|
928
|
-
access: string;
|
|
929
|
-
refresh: string;
|
|
930
|
-
expires: number;
|
|
931
|
-
};
|
|
1153
|
+
interface ToolDef {
|
|
1154
|
+
spec: ToolSpec;
|
|
1155
|
+
/**
|
|
1156
|
+
* Execute the tool and return its output.
|
|
1157
|
+
*
|
|
1158
|
+
* Return a plain string for text-only tools (the common case). Return a
|
|
1159
|
+
* `ToolResultContent[]` when the tool produces non-text content (images, mixed
|
|
1160
|
+
* text+image) that the provider can route through natively (Anthropic
|
|
1161
|
+
* `tool_result.content` arrays, OpenAI Codex pi-ai) or through the
|
|
1162
|
+
* companion-user-message fallback (OpenAI Chat Completions).
|
|
1163
|
+
*/
|
|
1164
|
+
execute: (input: Record<string, unknown>, ctx: ToolContext) => Promise<string | ToolResultContent[]>;
|
|
932
1165
|
}
|
|
933
|
-
type
|
|
1166
|
+
type ToolMap = Map<string, ToolDef>;
|
|
934
1167
|
//#endregion
|
|
935
|
-
//#region src/
|
|
1168
|
+
//#region src/types.d.ts
|
|
936
1169
|
/**
|
|
937
|
-
*
|
|
938
|
-
* the Messages API. Typed loosely (Record-of-unknown) so we don't pin a specific
|
|
939
|
-
* SDK schema version: the v0.90 SDK does not yet type this field, but the wire
|
|
940
|
-
* format is stable behind the `context-management-2025-06-27` beta.
|
|
1170
|
+
* Thinking / extended-reasoning configuration.
|
|
941
1171
|
*
|
|
942
|
-
*
|
|
1172
|
+
* - `'off'` — no thinking.
|
|
1173
|
+
* - `'minimal' | 'low' | 'medium' | 'high'` — explicit token budget. Maps to
|
|
1174
|
+
* provider-specific reasoning controls (Anthropic `thinking.type='enabled'`
|
|
1175
|
+
* with a budget; OpenAI `reasoning_effort`).
|
|
1176
|
+
* - `'adaptive'` — let the model decide per-turn whether and how much to think.
|
|
1177
|
+
* Anthropic-only (`thinking.type='adaptive'`). Other providers fall back to
|
|
1178
|
+
* no reasoning when this value is supplied.
|
|
943
1179
|
*/
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
|
|
1180
|
+
type ThinkingLevel = 'off' | 'minimal' | 'low' | 'medium' | 'high' | 'adaptive';
|
|
1181
|
+
interface McpServerConfig {
|
|
1182
|
+
/** Display name (used for tool namespacing) */
|
|
1183
|
+
name: string;
|
|
1184
|
+
/** Transport type */
|
|
1185
|
+
transport: 'stdio' | 'sse' | 'streamable-http';
|
|
1186
|
+
/** For stdio: command to run */
|
|
1187
|
+
command?: string;
|
|
1188
|
+
/** For stdio: command arguments */
|
|
1189
|
+
args?: string[];
|
|
954
1190
|
/**
|
|
955
|
-
*
|
|
956
|
-
*
|
|
957
|
-
*
|
|
1191
|
+
* For stdio: environment variables to pass to the server process.
|
|
1192
|
+
*
|
|
1193
|
+
* Merged on top of the MCP SDK's default inherited environment — a safety
|
|
1194
|
+
* whitelist (`PATH`, `HOME`, `LANG`, `SHELL`, `USER` on POSIX; `APPDATA`,
|
|
1195
|
+
* `PATH`, ... on Win32). Setting this to `{}` no longer strips `PATH` from
|
|
1196
|
+
* the child process. Set {@link McpServerConfig.strictEnv} to `true` to
|
|
1197
|
+
* pass `env` verbatim with no inherited defaults.
|
|
958
1198
|
*/
|
|
959
|
-
|
|
1199
|
+
env?: Record<string, string>;
|
|
960
1200
|
/**
|
|
961
|
-
*
|
|
962
|
-
*
|
|
963
|
-
*
|
|
964
|
-
*
|
|
965
|
-
*
|
|
966
|
-
* (token-accurate; pair with {@link AnthropicParams.contextManagement}).
|
|
967
|
-
* - `'token-efficient-tools-2026-03-28'` — terser tool_use wire format.
|
|
968
|
-
* - `'interleaved-thinking-2025-05-14'` — think between tool calls within
|
|
969
|
-
* one turn.
|
|
970
|
-
* - `'redact-thinking-2026-02-12'` — replace large thinking blocks with
|
|
971
|
-
* stubs server-side.
|
|
972
|
-
* - `'prompt-caching-scope-2026-01-05'` — extended prompt-cache scope.
|
|
973
|
-
*
|
|
974
|
-
* Honored on both the OAuth and API-key paths.
|
|
1201
|
+
* When true, {@link McpServerConfig.env} is passed verbatim to the spawned
|
|
1202
|
+
* process — the MCP SDK's default inherited environment (`PATH`, `HOME`, ...)
|
|
1203
|
+
* is NOT merged in. Most consumers should leave this off; the default merge
|
|
1204
|
+
* prevents `spawn ENOENT` when a stdio server declares an `env` without
|
|
1205
|
+
* restating `PATH`.
|
|
975
1206
|
*/
|
|
976
|
-
|
|
1207
|
+
strictEnv?: boolean;
|
|
1208
|
+
/** For sse/streamable-http: server URL */
|
|
1209
|
+
url?: string;
|
|
1210
|
+
/** Optional headers for HTTP transports */
|
|
1211
|
+
headers?: Record<string, string>;
|
|
977
1212
|
/**
|
|
978
|
-
*
|
|
979
|
-
* `context_management`. Requires the `context-management-2025-06-27` beta —
|
|
980
|
-
* add it to {@link AnthropicParams.extraBetas}.
|
|
1213
|
+
* Timeout in milliseconds for MCP server bootstrap (connect + tool discovery).
|
|
981
1214
|
*
|
|
982
|
-
*
|
|
983
|
-
*
|
|
1215
|
+
* Zidane connects MCP servers lazily on the first `run()`. Without a
|
|
1216
|
+
* bootstrap timeout, a slow or hung server can delay the first provider call
|
|
1217
|
+
* for an arbitrarily long time even when that MCP server is never used.
|
|
984
1218
|
*
|
|
985
|
-
*
|
|
986
|
-
* contextManagement: {
|
|
987
|
-
* edits: [{
|
|
988
|
-
* type: 'clear_tool_uses_20250919',
|
|
989
|
-
* trigger: { type: 'input_tokens', value: 180_000 },
|
|
990
|
-
* clear_at_least: { type: 'input_tokens', value: 140_000 },
|
|
991
|
-
* clear_tool_inputs: ['Read', 'Bash', 'Grep'],
|
|
992
|
-
* }],
|
|
993
|
-
* }
|
|
994
|
-
* ```
|
|
1219
|
+
* Default: `10000`.
|
|
995
1220
|
*/
|
|
996
|
-
|
|
1221
|
+
bootstrapTimeout?: number;
|
|
1222
|
+
/** Timeout in milliseconds for MCP tool calls (default: 30000) */
|
|
1223
|
+
toolTimeout?: number;
|
|
997
1224
|
/**
|
|
998
|
-
*
|
|
999
|
-
*
|
|
1000
|
-
*
|
|
1001
|
-
*
|
|
1225
|
+
* Allow-list of tool names to expose. Names match the upstream tool name
|
|
1226
|
+
* (NOT the namespaced `mcp_{server}_{tool}` form). Tools not in the list are
|
|
1227
|
+
* dropped before registration — the model never sees them in its catalog and
|
|
1228
|
+
* the wire cost of advertising them is avoided.
|
|
1002
1229
|
*
|
|
1003
|
-
*
|
|
1004
|
-
*
|
|
1005
|
-
*
|
|
1006
|
-
* {@link
|
|
1230
|
+
* Mutually exclusive with {@link McpServerConfig.disabledTools} — passing both
|
|
1231
|
+
* throws at bootstrap time.
|
|
1232
|
+
*
|
|
1233
|
+
* Composes with {@link McpServerConfig.toolFilter}: allow-list applies first,
|
|
1234
|
+
* then the predicate. Composes with the `mcp:tools:filter` hook: config-side
|
|
1235
|
+
* filters apply first, then the hook can further narrow the list.
|
|
1007
1236
|
*/
|
|
1008
|
-
|
|
1009
|
-
}
|
|
1010
|
-
declare function anthropic(anthropicParams?: AnthropicParams): Provider;
|
|
1011
|
-
//#endregion
|
|
1012
|
-
//#region src/providers/cerebras.d.ts
|
|
1013
|
-
interface CerebrasParams {
|
|
1014
|
-
apiKey?: string;
|
|
1015
|
-
defaultModel?: string;
|
|
1237
|
+
enabledTools?: string[];
|
|
1016
1238
|
/**
|
|
1017
|
-
*
|
|
1018
|
-
*
|
|
1019
|
-
* Override when routing to a vision-capable deployment.
|
|
1239
|
+
* Deny-list of tool names. Tools matching are dropped before registration.
|
|
1240
|
+
* Same matching semantics as {@link McpServerConfig.enabledTools}.
|
|
1020
1241
|
*/
|
|
1021
|
-
|
|
1022
|
-
}
|
|
1023
|
-
/**
|
|
1024
|
-
* Cerebras provider.
|
|
1025
|
-
*
|
|
1026
|
-
* Thin wrapper around {@link openaiCompat} with Cerebras-specific defaults
|
|
1027
|
-
* (base URL, default model).
|
|
1028
|
-
*/
|
|
1029
|
-
declare function cerebras(params?: CerebrasParams): Provider;
|
|
1030
|
-
//#endregion
|
|
1031
|
-
//#region src/providers/openai.d.ts
|
|
1032
|
-
interface OpenAIParams {
|
|
1033
|
-
/** OpenAI Codex OAuth access token. Falls back to OPENAI_CODEX_API_KEY and .credentials.json. */
|
|
1034
|
-
apiKey?: string;
|
|
1035
|
-
/** Alias for apiKey, matching the OAuth credential field. */
|
|
1036
|
-
access?: string;
|
|
1037
|
-
refresh?: string;
|
|
1038
|
-
expires?: number;
|
|
1039
|
-
accountId?: string;
|
|
1040
|
-
defaultModel?: string;
|
|
1041
|
-
transport?: 'sse' | 'websocket' | 'auto';
|
|
1042
|
-
}
|
|
1043
|
-
declare function openai(params?: OpenAIParams): Provider;
|
|
1044
|
-
//#endregion
|
|
1045
|
-
//#region src/providers/openai-compat.d.ts
|
|
1046
|
-
/**
|
|
1047
|
-
* HTTP error thrown when an OpenAI-compatible endpoint returns a non-OK response.
|
|
1048
|
-
*
|
|
1049
|
-
* The body is best-effort JSON-parsed; `error.message` / `error.code` / `error.type`
|
|
1050
|
-
* are extracted for clean downstream classification.
|
|
1051
|
-
*/
|
|
1052
|
-
declare class OpenAICompatHttpError extends Error {
|
|
1053
|
-
readonly status: number;
|
|
1054
|
-
readonly providerCode?: string;
|
|
1055
|
-
readonly bodyText: string;
|
|
1056
|
-
constructor(status: number, bodyText: string);
|
|
1057
|
-
}
|
|
1058
|
-
/**
|
|
1059
|
-
* Classify an OpenAI-compatible error into `ClassifiedError`.
|
|
1060
|
-
*
|
|
1061
|
-
* Recognizes:
|
|
1062
|
-
* - `AbortError` (from fetch) → `aborted`.
|
|
1063
|
-
* - `OpenAICompatHttpError` with a context-exceeded code or message → `context_exceeded`.
|
|
1064
|
-
* - Any other `OpenAICompatHttpError` → `provider_error`.
|
|
1065
|
-
*
|
|
1066
|
-
* Returns `null` for unrecognized error shapes (the loop falls back to `AgentProviderError`).
|
|
1067
|
-
*/
|
|
1068
|
-
declare function classifyOpenAICompatError(err: unknown): ClassifiedError | null;
|
|
1069
|
-
/**
|
|
1070
|
-
* Map an OpenAI-compatible `finish_reason` string to the zidane `TurnFinishReason` union.
|
|
1071
|
-
*/
|
|
1072
|
-
declare function mapOAIFinishReason(reason: string | null | undefined): TurnFinishReason | undefined;
|
|
1073
|
-
/**
|
|
1074
|
-
* Auth header config. `scheme` is prepended to the api key with a space, e.g.
|
|
1075
|
-
* `{ name: 'Authorization', scheme: 'Bearer' }` → `Authorization: Bearer <key>`.
|
|
1076
|
-
* Omit `scheme` for raw header values (e.g. `{ name: 'X-Api-Key' }` → `X-Api-Key: <key>`).
|
|
1077
|
-
*
|
|
1078
|
-
* Real-world examples:
|
|
1079
|
-
* - Default OpenAI / OpenRouter / Cerebras: `{ name: 'Authorization', scheme: 'Bearer' }`.
|
|
1080
|
-
* - Baseten: `{ name: 'Authorization', scheme: 'Api-Key' }`.
|
|
1081
|
-
* - Some gateways: `{ name: 'X-Api-Key' }`.
|
|
1082
|
-
*/
|
|
1083
|
-
interface OpenAICompatAuthHeader {
|
|
1084
|
-
name: string;
|
|
1085
|
-
scheme?: string;
|
|
1086
|
-
}
|
|
1087
|
-
interface OpenAICompatParams {
|
|
1088
|
-
/** Bearer-style API key. */
|
|
1089
|
-
apiKey: string;
|
|
1090
|
-
/** Base URL — `/chat/completions` is appended. */
|
|
1091
|
-
baseURL: string;
|
|
1092
|
-
/** Default model id when `run({ model })` is omitted. */
|
|
1093
|
-
defaultModel?: string;
|
|
1094
|
-
/** Provider name exposed as `Provider.name`. Defaults to `'openai-compat'`. */
|
|
1095
|
-
name?: string;
|
|
1096
|
-
/** Auth header shape. Defaults to `{ name: 'Authorization', scheme: 'Bearer' }`. */
|
|
1097
|
-
authHeader?: OpenAICompatAuthHeader;
|
|
1098
|
-
/** Extra headers sent with every request (e.g. referer, user-agent). */
|
|
1099
|
-
extraHeaders?: Record<string, string>;
|
|
1242
|
+
disabledTools?: string[];
|
|
1100
1243
|
/**
|
|
1101
|
-
*
|
|
1102
|
-
*
|
|
1103
|
-
*
|
|
1244
|
+
* Custom predicate run on each upstream tool. Return `true` to keep, `false`
|
|
1245
|
+
* to drop. Receives the raw `listTools()` payload — useful for filtering by
|
|
1246
|
+
* description, schema shape, or other metadata that an allow/deny list can't
|
|
1247
|
+
* express.
|
|
1104
1248
|
*
|
|
1105
|
-
*
|
|
1106
|
-
* conservative assumption matching most OSS text-only OpenAI-compat
|
|
1107
|
-
* endpoints. Override when routing to a known vision-capable endpoint
|
|
1108
|
-
* (e.g. OpenRouter vision models, Baseten image-capable deployments).
|
|
1249
|
+
* Runs after the allow/deny filter but before the `mcp:tools:filter` hook.
|
|
1109
1250
|
*/
|
|
1110
|
-
|
|
1251
|
+
toolFilter?: (tool: {
|
|
1252
|
+
name: string;
|
|
1253
|
+
description?: string | null;
|
|
1254
|
+
inputSchema?: unknown;
|
|
1255
|
+
}) => boolean;
|
|
1111
1256
|
/**
|
|
1112
|
-
*
|
|
1113
|
-
*
|
|
1257
|
+
* Per-server override for {@link AgentBehavior.toolDisclosure}. When set,
|
|
1258
|
+
* this server's tools follow this disclosure mode regardless of the
|
|
1259
|
+
* agent-wide default. Useful when one big MCP server (200+ tools) should
|
|
1260
|
+
* stay lazy while smaller servers stay eager.
|
|
1114
1261
|
*
|
|
1115
|
-
*
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1262
|
+
* Default: inherits from `behavior.toolDisclosure`.
|
|
1263
|
+
*/
|
|
1264
|
+
disclosure?: 'eager' | 'lazy';
|
|
1265
|
+
}
|
|
1266
|
+
type ToolExecutionMode = 'sequential' | 'parallel';
|
|
1267
|
+
interface AgentBehavior {
|
|
1268
|
+
/** Tool execution mode (default: 'sequential') */
|
|
1269
|
+
toolExecution?: ToolExecutionMode;
|
|
1270
|
+
/**
|
|
1271
|
+
* Max agent loop iterations.
|
|
1121
1272
|
*
|
|
1122
|
-
* Default:
|
|
1273
|
+
* Default: unlimited (Infinity). The loop runs until the model signals
|
|
1274
|
+
* completion (no tool calls / `end_turn`), the abort signal fires, or this
|
|
1275
|
+
* cap is hit. Set a finite value as a safety net for runaway loops.
|
|
1123
1276
|
*/
|
|
1124
|
-
|
|
1277
|
+
maxTurns?: number;
|
|
1278
|
+
/** Max tokens per LLM response (default: 16384) */
|
|
1279
|
+
maxTokens?: number;
|
|
1280
|
+
/** Thinking token budget — overrides the level-based default when set */
|
|
1281
|
+
thinkingBudget?: number;
|
|
1282
|
+
/** JSON Schema for structured output enforcement */
|
|
1283
|
+
schema?: Record<string, unknown>;
|
|
1125
1284
|
/**
|
|
1126
|
-
*
|
|
1127
|
-
*
|
|
1128
|
-
*
|
|
1129
|
-
* extended-reasoning state across turns.
|
|
1285
|
+
* Enable provider prompt caching. When on (default), the provider marks the
|
|
1286
|
+
* system prompt, tools, and the last stable message with cache breakpoints so
|
|
1287
|
+
* the shared prefix is served from cache across turns.
|
|
1130
1288
|
*
|
|
1131
|
-
* - `
|
|
1132
|
-
*
|
|
1133
|
-
*
|
|
1134
|
-
*
|
|
1135
|
-
*
|
|
1136
|
-
* blocks before sending. Safe default for hosts that strict-
|
|
1137
|
-
* validate the request schema.
|
|
1289
|
+
* - Anthropic: `cache_control: { type: 'ephemeral' }` on the last `system`
|
|
1290
|
+
* content part, the last tool, and the last message content part.
|
|
1291
|
+
* - OpenAI-compatible / OpenRouter: same shape — honored by Anthropic-backed
|
|
1292
|
+
* OpenRouter routes and by Gemini; ignored (no-op) by providers that cache
|
|
1293
|
+
* automatically (OpenAI, DeepSeek, Grok, Groq, Moonshot).
|
|
1138
1294
|
*
|
|
1139
|
-
*
|
|
1295
|
+
* Usage is surfaced via `TurnUsage.cacheRead` / `TurnUsage.cacheCreation`.
|
|
1296
|
+
*
|
|
1297
|
+
* Default: `true`.
|
|
1140
1298
|
*/
|
|
1141
|
-
|
|
1299
|
+
cache?: boolean;
|
|
1142
1300
|
/**
|
|
1143
|
-
*
|
|
1144
|
-
*
|
|
1145
|
-
*
|
|
1146
|
-
*
|
|
1301
|
+
* Soft per-turn cap on total tool-output bytes. When the sum of `outputBytes`
|
|
1302
|
+
* across a turn's tool results exceeds this value, the loop injects a
|
|
1303
|
+
* synthetic user message instructing the model to summarize before calling
|
|
1304
|
+
* more tools, and fires the `budget:exceeded` hook.
|
|
1147
1305
|
*
|
|
1148
|
-
*
|
|
1149
|
-
*
|
|
1150
|
-
*
|
|
1306
|
+
* Measured **post-`tool:transform`** so consumer truncation counts toward the
|
|
1307
|
+
* budget. Off by default (undefined / `0` disables the check). A reasonable
|
|
1308
|
+
* starting value for OSS-model integrations is `32768`.
|
|
1151
1309
|
*/
|
|
1152
|
-
|
|
1153
|
-
}
|
|
1154
|
-
/**
|
|
1155
|
-
* Factory for any OpenAI-compatible HTTP endpoint.
|
|
1156
|
-
*
|
|
1157
|
-
* Speaks the standard `POST /chat/completions` + `stream: true` + SSE dialect.
|
|
1158
|
-
* Thin wrappers (`openrouter`, `cerebras`) call this with pinned defaults.
|
|
1159
|
-
*
|
|
1160
|
-
* @example Baseten (non-standard auth scheme)
|
|
1161
|
-
* ```ts
|
|
1162
|
-
* openaiCompat({
|
|
1163
|
-
* name: 'baseten',
|
|
1164
|
-
* apiKey: process.env.BASETEN_API_KEY!,
|
|
1165
|
-
* baseURL: process.env.BASETEN_PROXY_URL!,
|
|
1166
|
-
* authHeader: { name: 'Authorization', scheme: 'Api-Key' },
|
|
1167
|
-
* })
|
|
1168
|
-
* ```
|
|
1169
|
-
*/
|
|
1170
|
-
declare function openaiCompat(params: OpenAICompatParams): Provider;
|
|
1171
|
-
//#endregion
|
|
1172
|
-
//#region src/providers/openrouter.d.ts
|
|
1173
|
-
interface OpenRouterParams {
|
|
1174
|
-
apiKey?: string;
|
|
1175
|
-
defaultModel?: string;
|
|
1310
|
+
toolOutputBudget?: number;
|
|
1176
1311
|
/**
|
|
1177
|
-
*
|
|
1178
|
-
*
|
|
1179
|
-
*
|
|
1180
|
-
*
|
|
1181
|
-
*
|
|
1312
|
+
* Deduplicate identical re-reads of the same file in `read_file`. When the
|
|
1313
|
+
* model re-reads a file with the same slice and the bytes haven't changed
|
|
1314
|
+
* since the last read in this session, the tool returns a short stub
|
|
1315
|
+
* instead of re-emitting the full content. Pairs with the read-before-edit
|
|
1316
|
+
* guard in `edit` / `multi_edit`.
|
|
1182
1317
|
*
|
|
1183
|
-
*
|
|
1318
|
+
* Requires a session (set via `createSession()`); without one, the flag is
|
|
1319
|
+
* a no-op since per-session state has nowhere to live.
|
|
1320
|
+
*
|
|
1321
|
+
* Default: `true`.
|
|
1184
1322
|
*/
|
|
1185
|
-
|
|
1186
|
-
}
|
|
1187
|
-
/**
|
|
1188
|
-
* OpenRouter provider.
|
|
1189
|
-
*
|
|
1190
|
-
* Thin wrapper around {@link openaiCompat} with OpenRouter-specific defaults
|
|
1191
|
-
* (base URL, default model) and required attribution headers.
|
|
1192
|
-
*/
|
|
1193
|
-
declare function openrouter(params?: OpenRouterParams): Provider;
|
|
1194
|
-
//#endregion
|
|
1195
|
-
//#region src/providers/index.d.ts
|
|
1196
|
-
interface ToolSpec {
|
|
1197
|
-
name: string;
|
|
1198
|
-
description: string;
|
|
1199
|
-
inputSchema: Record<string, unknown>;
|
|
1200
|
-
}
|
|
1201
|
-
interface ToolCall {
|
|
1202
|
-
id: string;
|
|
1203
|
-
name: string;
|
|
1204
|
-
input: Record<string, unknown>;
|
|
1205
|
-
}
|
|
1206
|
-
interface ToolResult {
|
|
1207
|
-
id: string;
|
|
1323
|
+
dedupReads?: boolean;
|
|
1208
1324
|
/**
|
|
1209
|
-
*
|
|
1210
|
-
*
|
|
1211
|
-
*
|
|
1325
|
+
* Taper the thinking budget over the course of a run. Late turns are
|
|
1326
|
+
* usually checkpoint / cleanup work where reasoning rarely pays for
|
|
1327
|
+
* itself; early turns benefit most. Two forms:
|
|
1212
1328
|
*
|
|
1213
|
-
*
|
|
1329
|
+
* - **Struct** — geometric decay starting after `afterTurn`, multiplying by
|
|
1330
|
+
* `factor` each subsequent turn, clamped to `floor`. Example
|
|
1331
|
+
* `{ afterTurn: 5, factor: 0.5, floor: 1024 }` with a base budget of 8192:
|
|
1332
|
+
* turns 1-5 = 8192, turn 6 = 4096, turn 7 = 2048, turn 8+ = 1024.
|
|
1333
|
+
* - **Function** — `(runTurn, baseBudget) => number`. Arbitrary curves;
|
|
1334
|
+
* `runTurn` is 1-indexed, run-relative (resumed sessions reset).
|
|
1335
|
+
*
|
|
1336
|
+
* No-op when `thinkingBudget` is unset. Honored by every provider that
|
|
1337
|
+
* respects `thinkingBudget` (anthropic explicit-budget `enabled` path,
|
|
1338
|
+
* adaptive `maxTokensCap`, openai-compat `max_tokens` padding).
|
|
1339
|
+
*
|
|
1340
|
+
* Default: `undefined` (no decay).
|
|
1214
1341
|
*/
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
|
|
1218
|
-
|
|
1219
|
-
|
|
1220
|
-
*
|
|
1221
|
-
* When a flag is `undefined` (omitted), the loop applies the conservative
|
|
1222
|
-
* text-only default — images are stripped and replaced with a text marker so
|
|
1223
|
-
* non-vision models do not confabulate about content they cannot see.
|
|
1224
|
-
*/
|
|
1225
|
-
interface ProviderCapabilities {
|
|
1342
|
+
thinkingDecay?: {
|
|
1343
|
+
afterTurn: number;
|
|
1344
|
+
factor: number;
|
|
1345
|
+
floor: number;
|
|
1346
|
+
} | ((runTurn: number, baseBudget: number) => number);
|
|
1226
1347
|
/**
|
|
1227
|
-
*
|
|
1348
|
+
* Per-tool soft call budget for this run. Keyed by **canonical** tool name.
|
|
1349
|
+
* On the first call after the run-cumulative dispatched count for that tool
|
|
1350
|
+
* reaches `max`, the framework fires `onExceed`:
|
|
1228
1351
|
*
|
|
1229
|
-
*
|
|
1230
|
-
*
|
|
1231
|
-
*
|
|
1232
|
-
*
|
|
1352
|
+
* - `'steer'` (default) — let the call execute, but emit a synthetic user
|
|
1353
|
+
* message after the turn that nudges the model away from re-calling the
|
|
1354
|
+
* tool. Reuses the existing post-turn steer pathway used by
|
|
1355
|
+
* `toolOutputBudget`. Fires `tool-budget:exceeded` with `mode: 'steer'`.
|
|
1356
|
+
* - `'block'` — refuse the call via `tool:gate` `block`. The model sees a
|
|
1357
|
+
* `Blocked: <reason>` tool result. Fires `tool-budget:exceeded` with
|
|
1358
|
+
* `mode: 'block'`.
|
|
1359
|
+
* - **Function** — `(ctx) => { mode, message }`. The consumer supplies the
|
|
1360
|
+
* steering / refusal text and chooses the mode dynamically.
|
|
1361
|
+
*
|
|
1362
|
+
* Counts include both real dispatches and dedup substitutes (Z19 hits).
|
|
1363
|
+
* Excludes calls already blocked by an earlier gate (skill allow-list,
|
|
1364
|
+
* consumer hook). Tool dispatched by spawned subagents has its own per-run
|
|
1365
|
+
* counter — child counts never charge the parent.
|
|
1366
|
+
*
|
|
1367
|
+
* For MCP tools, key by the namespaced wire name (`mcp_<server>_<tool>`).
|
|
1368
|
+
*
|
|
1369
|
+
* Atomic in parallel mode: the middleware tracks its own per-tool
|
|
1370
|
+
* approval counter, incremented synchronously at gate-time. A
|
|
1371
|
+
* 4-call parallel batch against `max: 2` will let the first 2 through
|
|
1372
|
+
* and refuse the rest, even though the loop's `runToolCounts` only
|
|
1373
|
+
* propagates between calls (not within a single batch's gate fan-out).
|
|
1374
|
+
*
|
|
1375
|
+
* Default: `undefined` (no budget enforcement).
|
|
1233
1376
|
*/
|
|
1234
|
-
|
|
1377
|
+
toolBudgets?: Record<string, {
|
|
1378
|
+
max: number;
|
|
1379
|
+
onExceed?: 'steer' | 'block' | ((ctx: {
|
|
1380
|
+
tool: string;
|
|
1381
|
+
count: number;
|
|
1382
|
+
max: number;
|
|
1383
|
+
}) => {
|
|
1384
|
+
mode: 'steer' | 'block';
|
|
1385
|
+
message: string;
|
|
1386
|
+
});
|
|
1387
|
+
}>;
|
|
1235
1388
|
/**
|
|
1236
|
-
*
|
|
1237
|
-
* (
|
|
1389
|
+
* Generic per-tool argument deduplication. Keyed by the tool's **canonical**
|
|
1390
|
+
* name (alias-stable). Each entry is a hasher: `(input) => string | undefined`.
|
|
1238
1391
|
*
|
|
1239
|
-
*
|
|
1240
|
-
*
|
|
1241
|
-
*
|
|
1242
|
-
*
|
|
1243
|
-
*
|
|
1392
|
+
* **Hasher contract** — three return values, three meanings:
|
|
1393
|
+
*
|
|
1394
|
+
* | Return | Meaning |
|
|
1395
|
+
* |-------------------------|------------------------------------------------------------------------|
|
|
1396
|
+
* | a non-empty string | Cache key for this call. Equal keys (most-recent-only, this session) |
|
|
1397
|
+
* | | replay the prior recorded result without re-dispatching the tool. |
|
|
1398
|
+
* | `undefined` | **Skip dedup for this call.** The tool runs normally; nothing recorded.|
|
|
1399
|
+
* | `''` / non-string | Treated identically to `undefined` (defensive: no dedup, no error). |
|
|
1400
|
+
*
|
|
1401
|
+
* The `undefined` opt-out is the way to say *"this specific call is not
|
|
1402
|
+
* cacheable"* (timestamps in input, randomness baked in, debug flags). It
|
|
1403
|
+
* is **not** the same as `JSON.stringify(input)` — that would dedup against
|
|
1404
|
+
* the verbatim input. Pick one explicitly:
|
|
1405
|
+
*
|
|
1406
|
+
* ```ts
|
|
1407
|
+
* // Always cache by full input — every identical re-call dedups.
|
|
1408
|
+
* dedupTools: { todowrite: input => JSON.stringify(input) }
|
|
1409
|
+
*
|
|
1410
|
+
* // Cache by a normalized subset; non-cacheable shapes opt out.
|
|
1411
|
+
* dedupTools: {
|
|
1412
|
+
* execute_sql: (input) => {
|
|
1413
|
+
* const q = typeof input.query === 'string' ? input.query.trim().toLowerCase() : undefined
|
|
1414
|
+
* if (!q || q.includes('now()') || q.includes('random()')) return undefined
|
|
1415
|
+
* return q
|
|
1416
|
+
* },
|
|
1417
|
+
* }
|
|
1418
|
+
* ```
|
|
1419
|
+
*
|
|
1420
|
+
* On a hit, the previously-recorded result is replayed as the tool_result
|
|
1421
|
+
* without dispatching the tool. The substitution flows through `tool:gate`
|
|
1422
|
+
* `result` (Z20), so `tool:after` and `tool:transform` still fire.
|
|
1423
|
+
*
|
|
1424
|
+
* Requires a session (`createSession()`); without one, the map is a silent
|
|
1425
|
+
* no-op since per-session state has nowhere to live. Tools with side
|
|
1426
|
+
* effects or non-deterministic outputs (network, time, randomness) MUST
|
|
1427
|
+
* NOT be listed — there is no safety net beyond the consumer's hasher.
|
|
1428
|
+
*
|
|
1429
|
+
* For MCP tools, key by the namespaced wire name (`mcp_<server>_<tool>`).
|
|
1430
|
+
* Parallel mode (`toolExecution: 'parallel'`, the default) sees calls in
|
|
1431
|
+
* the SAME assistant turn race against each other — none can dedup against
|
|
1432
|
+
* a sibling that started in the same batch. Sequential mode honors order
|
|
1433
|
+
* within a turn.
|
|
1434
|
+
*
|
|
1435
|
+
* **Cache policy**: only the most recent `(hash, result)` per tool is
|
|
1436
|
+
* retained. Interleaved patterns (input A, input B, input A) miss on the
|
|
1437
|
+
* second A because B overwrote it. Sufficient for the common spam-the-
|
|
1438
|
+
* same-call loop; consumers needing a richer cache should hook
|
|
1439
|
+
* `tool:gate` directly.
|
|
1440
|
+
*
|
|
1441
|
+
* Default: `undefined` (no per-tool dedup).
|
|
1244
1442
|
*/
|
|
1245
|
-
|
|
1246
|
-
}
|
|
1247
|
-
interface StreamCallbacks {
|
|
1248
|
-
onText: (delta: string) => void;
|
|
1249
|
-
onThinking?: (delta: string) => void;
|
|
1250
|
-
onOAuthRefresh?: (ctx: OAuthRefreshHookContext) => void | Promise<void>;
|
|
1251
|
-
}
|
|
1252
|
-
interface TurnResult {
|
|
1253
|
-
/** Full assistant turn as a SessionMessage */
|
|
1254
|
-
assistantMessage: SessionMessage;
|
|
1255
|
-
/** Text content blocks concatenated */
|
|
1256
|
-
text: string;
|
|
1257
|
-
/** Tool calls requested by the model */
|
|
1258
|
-
toolCalls: ToolCall[];
|
|
1259
|
-
/** Whether the model wants to stop */
|
|
1260
|
-
done: boolean;
|
|
1261
|
-
usage: TurnUsage;
|
|
1262
|
-
}
|
|
1263
|
-
interface StreamOptions {
|
|
1264
|
-
model: string;
|
|
1265
|
-
system: string;
|
|
1266
|
-
tools: unknown[];
|
|
1267
|
-
messages: SessionMessage[];
|
|
1268
|
-
maxTokens: number;
|
|
1269
|
-
/** Thinking/reasoning level (optional, default: off) */
|
|
1270
|
-
thinking?: ThinkingLevel;
|
|
1271
|
-
/** Exact thinking token budget — overrides the level-based default when set */
|
|
1272
|
-
thinkingBudget?: number;
|
|
1273
|
-
/** Force tool selection behavior */
|
|
1274
|
-
toolChoice?: {
|
|
1275
|
-
type: 'auto' | 'required' | 'tool';
|
|
1276
|
-
name?: string;
|
|
1277
|
-
};
|
|
1443
|
+
dedupTools?: Record<string, (input: Record<string, unknown>) => string | undefined>;
|
|
1278
1444
|
/**
|
|
1279
|
-
*
|
|
1280
|
-
*
|
|
1281
|
-
*
|
|
1445
|
+
* Require `read_file` before `edit` / `multi_edit` on the same path, and
|
|
1446
|
+
* reject edits when the file has changed on disk since the last read in
|
|
1447
|
+
* this session. Eliminates the silent-corruption failure mode where a
|
|
1448
|
+
* model "remembers" stale content and applies a substring edit against
|
|
1449
|
+
* bytes that have moved.
|
|
1282
1450
|
*
|
|
1283
|
-
*
|
|
1451
|
+
* Requires a session. Off by default; turn it on for stricter eval-grade
|
|
1452
|
+
* runs where silent edit corruption would invalidate the result.
|
|
1453
|
+
*
|
|
1454
|
+
* Default: `false`.
|
|
1284
1455
|
*/
|
|
1285
|
-
|
|
1286
|
-
/** Abort signal for cancellation */
|
|
1287
|
-
signal?: AbortSignal;
|
|
1288
|
-
}
|
|
1289
|
-
interface Provider {
|
|
1290
|
-
readonly name: string;
|
|
1291
|
-
readonly meta: {
|
|
1292
|
-
defaultModel: string; /** Provider-level capability flags. See {@link ProviderCapabilities}. */
|
|
1293
|
-
capabilities?: ProviderCapabilities;
|
|
1294
|
-
} & Record<string, unknown>;
|
|
1295
|
-
/** Format tool specs for this provider */
|
|
1296
|
-
formatTools: (tools: ToolSpec[]) => unknown[];
|
|
1297
|
-
/** Create a text-only user message. Multimodal content goes through `promptMessage`. */
|
|
1298
|
-
userMessage: (content: string) => SessionMessage;
|
|
1299
|
-
/** Create an assistant message (for priming) */
|
|
1300
|
-
assistantMessage: (content: string) => SessionMessage;
|
|
1301
|
-
/** Create a tool results message to send back */
|
|
1302
|
-
toolResultsMessage: (results: ToolResult[]) => SessionMessage;
|
|
1303
|
-
/** Stream a turn, calling onText for each text delta */
|
|
1304
|
-
stream: (options: StreamOptions, callbacks: StreamCallbacks) => Promise<TurnResult>;
|
|
1456
|
+
requireReadBeforeEdit?: boolean;
|
|
1305
1457
|
/**
|
|
1306
|
-
*
|
|
1458
|
+
* Client-side context compaction strategy. Use this for non-Anthropic
|
|
1459
|
+
* providers (OSS via cerebras / openai-compat / openrouter) that don't
|
|
1460
|
+
* have a server-side equivalent. Anthropic users should prefer the
|
|
1461
|
+
* server-side `context-management-2025-06-27` beta — see
|
|
1462
|
+
* `AnthropicParams.contextManagement`.
|
|
1307
1463
|
*
|
|
1308
|
-
*
|
|
1309
|
-
*
|
|
1310
|
-
*
|
|
1311
|
-
*
|
|
1464
|
+
* - `'off'` (default) — no client-side compaction.
|
|
1465
|
+
* - `'tail'` — when total tool-output bytes in the persisted history
|
|
1466
|
+
* exceed `compactThreshold`, replace older `tool_result` outputs with a
|
|
1467
|
+
* short stub, keeping the newest `compactKeepTurns` turns intact. The
|
|
1468
|
+
* compaction is applied to the wire-level message list only; the
|
|
1469
|
+
* underlying session turns are not modified.
|
|
1470
|
+
*
|
|
1471
|
+
* Default: `'off'`.
|
|
1312
1472
|
*/
|
|
1313
|
-
|
|
1473
|
+
compactStrategy?: 'off' | 'tail';
|
|
1314
1474
|
/**
|
|
1315
|
-
*
|
|
1316
|
-
*
|
|
1317
|
-
*
|
|
1318
|
-
*
|
|
1319
|
-
* route it to one of the typed error classes.
|
|
1475
|
+
* Soft byte threshold that triggers tail compaction when
|
|
1476
|
+
* `compactStrategy === 'tail'`. Counts the post-`context:transform` bytes
|
|
1477
|
+
* of `tool_result` outputs across all messages. Default: `131_072` (128
|
|
1478
|
+
* KiB). Ignored when compaction is off.
|
|
1320
1479
|
*/
|
|
1321
|
-
|
|
1322
|
-
}
|
|
1323
|
-
//#endregion
|
|
1324
|
-
//#region src/session/file-map.d.ts
|
|
1325
|
-
/**
|
|
1326
|
-
* Host-provided file-map adapter. Three methods exchanging `Record<string, string>`
|
|
1327
|
-
* payloads — the whole persistence surface the wrapper needs.
|
|
1328
|
-
*/
|
|
1329
|
-
interface FileMapAdapter {
|
|
1330
|
-
/** Load the current file map. Returns an empty `files` record when nothing is persisted. */
|
|
1331
|
-
get: () => Promise<{
|
|
1332
|
-
files: Record<string, string>;
|
|
1333
|
-
}>;
|
|
1334
|
-
/** Replace the persisted file map. Full-rewrite semantics. */
|
|
1335
|
-
save: (files: Record<string, string>) => Promise<void>;
|
|
1336
|
-
/** Delete all persisted state. */
|
|
1337
|
-
delete: () => Promise<void>;
|
|
1338
|
-
}
|
|
1339
|
-
interface FileMapStoreOptions {
|
|
1340
|
-
/** Filename for the JSONL turns log. Default: `turns.jsonl`. */
|
|
1341
|
-
turnsFile?: string;
|
|
1342
|
-
/** Filename for the metadata JSON. Default: `meta.json`. */
|
|
1343
|
-
metaFile?: string;
|
|
1344
|
-
}
|
|
1345
|
-
/**
|
|
1346
|
-
* Create a single-session `SessionStore` backed by a file-map adapter.
|
|
1347
|
-
*
|
|
1348
|
-
* @example
|
|
1349
|
-
* ```ts
|
|
1350
|
-
* const session = await createSession({
|
|
1351
|
-
* store: createFileMapStore(hostSessionStore),
|
|
1352
|
-
* })
|
|
1353
|
-
* ```
|
|
1354
|
-
*/
|
|
1355
|
-
declare function createFileMapStore(adapter: FileMapAdapter, options?: FileMapStoreOptions): SessionStore;
|
|
1356
|
-
//#endregion
|
|
1357
|
-
//#region src/session/memory.d.ts
|
|
1358
|
-
declare function createMemoryStore(): SessionStore;
|
|
1359
|
-
//#endregion
|
|
1360
|
-
//#region src/session/messages.d.ts
|
|
1361
|
-
declare function fromAnthropic(msg: {
|
|
1362
|
-
role: string;
|
|
1363
|
-
content: unknown;
|
|
1364
|
-
}): SessionMessage;
|
|
1365
|
-
declare function fromOpenAI(msg: {
|
|
1366
|
-
role: string;
|
|
1367
|
-
content: unknown;
|
|
1368
|
-
}): SessionMessage;
|
|
1369
|
-
declare function toAnthropic(msg: SessionMessage): {
|
|
1370
|
-
role: string;
|
|
1371
|
-
content: unknown;
|
|
1372
|
-
};
|
|
1373
|
-
declare function toOpenAI(msg: SessionMessage): {
|
|
1374
|
-
role: string;
|
|
1375
|
-
content: unknown;
|
|
1376
|
-
};
|
|
1377
|
-
declare function autoDetectAndConvert(msg: {
|
|
1378
|
-
role: string;
|
|
1379
|
-
content: unknown;
|
|
1380
|
-
}): SessionMessage;
|
|
1381
|
-
//#endregion
|
|
1382
|
-
//#region src/session/remote.d.ts
|
|
1383
|
-
interface RemoteStoreOptions {
|
|
1384
|
-
/** Base URL of the session API */
|
|
1385
|
-
url: string;
|
|
1386
|
-
/** Optional headers (e.g. for authentication) */
|
|
1387
|
-
headers?: Record<string, string>;
|
|
1388
|
-
}
|
|
1389
|
-
declare function createRemoteStore(options: RemoteStoreOptions): SessionStore;
|
|
1390
|
-
//#endregion
|
|
1391
|
-
//#region src/session/index.d.ts
|
|
1392
|
-
interface SessionRun {
|
|
1393
|
-
id: string;
|
|
1394
|
-
startedAt: number;
|
|
1395
|
-
endedAt?: number;
|
|
1396
|
-
prompt: string;
|
|
1397
|
-
status: 'running' | 'completed' | 'aborted' | 'error';
|
|
1398
|
-
turns?: number;
|
|
1399
|
-
tokensIn?: number;
|
|
1400
|
-
tokensOut?: number;
|
|
1401
|
-
error?: string;
|
|
1402
|
-
/** Per-turn usage breakdown */
|
|
1403
|
-
turnUsage?: TurnUsage[];
|
|
1404
|
-
/** Total usage across all turns */
|
|
1405
|
-
totalUsage?: TurnUsage;
|
|
1406
|
-
/** Estimated cost in USD */
|
|
1407
|
-
cost?: number;
|
|
1480
|
+
compactThreshold?: number;
|
|
1408
1481
|
/**
|
|
1409
|
-
*
|
|
1410
|
-
*
|
|
1411
|
-
*
|
|
1482
|
+
* Number of trailing turns to leave untouched during tail compaction. The
|
|
1483
|
+
* most-recent `compactKeepTurns` user/assistant messages are not eligible
|
|
1484
|
+
* for elision so the model keeps the freshest tool context. Default: `4`.
|
|
1412
1485
|
*/
|
|
1413
|
-
|
|
1486
|
+
compactKeepTurns?: number;
|
|
1414
1487
|
/**
|
|
1415
|
-
*
|
|
1416
|
-
*
|
|
1488
|
+
* Prefix every line of `read_file` output with its 1-indexed line number
|
|
1489
|
+
* followed by a tab (`<N>\t<content>`) — the compact `cat -n`-style
|
|
1490
|
+
* format Claude Code emits. The `edit` tool strips the prefix from
|
|
1491
|
+
* `old_string` / `new_string` so the model can paste back a numbered
|
|
1492
|
+
* chunk verbatim without breaking the match.
|
|
1493
|
+
*
|
|
1494
|
+
* Set `false` to opt out — useful for callers piping `read_file` into
|
|
1495
|
+
* downstream parsers that don't recognize the prefix. Per-call
|
|
1496
|
+
* `read_file({ lineNumbers: false })` overrides this default.
|
|
1497
|
+
*
|
|
1498
|
+
* Default: `true`.
|
|
1417
1499
|
*/
|
|
1418
|
-
|
|
1419
|
-
|
|
1420
|
-
|
|
1421
|
-
|
|
1422
|
-
|
|
1423
|
-
|
|
1424
|
-
|
|
1425
|
-
|
|
1426
|
-
|
|
1427
|
-
|
|
1428
|
-
|
|
1429
|
-
|
|
1430
|
-
|
|
1431
|
-
|
|
1432
|
-
|
|
1433
|
-
|
|
1434
|
-
|
|
1435
|
-
|
|
1436
|
-
|
|
1437
|
-
|
|
1438
|
-
|
|
1439
|
-
/** Delete a session. */
|
|
1440
|
-
delete: (sessionId: string) => Promise<void>;
|
|
1441
|
-
/** List session IDs, optionally filtered. */
|
|
1442
|
-
list: (filter?: {
|
|
1443
|
-
agentId?: string;
|
|
1444
|
-
limit?: number;
|
|
1445
|
-
}) => Promise<string[]>;
|
|
1446
|
-
/** Append new turns to a session (incremental, avoids full re-save). */
|
|
1447
|
-
appendTurns: (sessionId: string, turns: SessionTurn[]) => Promise<void>;
|
|
1448
|
-
/** Return a slice of turns for a session. */
|
|
1449
|
-
getTurns: (sessionId: string, from?: number, limit?: number) => Promise<SessionTurn[]>;
|
|
1450
|
-
/** Persist an updated run record (called after completeRun / abortRun / errorRun). */
|
|
1451
|
-
updateRun: (sessionId: string, run: SessionRun) => Promise<void>;
|
|
1452
|
-
/** Update the top-level status of a session. */
|
|
1453
|
-
updateStatus: (sessionId: string, status: SessionData['status']) => Promise<void>;
|
|
1454
|
-
}
|
|
1455
|
-
interface Session {
|
|
1456
|
-
/** Session ID */
|
|
1457
|
-
readonly id: string;
|
|
1458
|
-
/** Agent ID (optional label) */
|
|
1459
|
-
readonly agentId?: string;
|
|
1460
|
-
/** Current turn history */
|
|
1461
|
-
readonly turns: SessionTurn[];
|
|
1500
|
+
readLineNumbers?: boolean;
|
|
1501
|
+
/**
|
|
1502
|
+
* Replace older `read_file` `tool_result` blocks with a short stub when
|
|
1503
|
+
* a successful `edit` / `multi_edit` / `write_file` later in the same
|
|
1504
|
+
* run modified the same path. The replacement is applied to the
|
|
1505
|
+
* wire-level message list only — persisted session turns keep the
|
|
1506
|
+
* original content.
|
|
1507
|
+
*
|
|
1508
|
+
* Eliminates the common waste pattern where the model carries the
|
|
1509
|
+
* pre-edit file body forward across many turns "in case it needs it".
|
|
1510
|
+
* Pairs cleanly with `compactStrategy: 'tail'`: stale reads shrink
|
|
1511
|
+
* first, then the byte-threshold compaction fires if anything's left.
|
|
1512
|
+
*
|
|
1513
|
+
* Detection is conservative — only triggers when the corresponding
|
|
1514
|
+
* tool_result confirms success (`Edited …`, `Created …`, `Updated …`).
|
|
1515
|
+
* Failed edits and `No change needed` write_file calls do NOT
|
|
1516
|
+
* invalidate prior reads.
|
|
1517
|
+
*
|
|
1518
|
+
* Default: `false`.
|
|
1519
|
+
*/
|
|
1520
|
+
elideStaleReads?: boolean;
|
|
1462
1521
|
/**
|
|
1463
|
-
*
|
|
1522
|
+
* Tool disclosure strategy. Controls whether the model sees every tool's
|
|
1523
|
+
* full `inputSchema` in its tool list every turn ("eager") or whether MCP
|
|
1524
|
+
* tools are advertised as a name+description catalog in the system prompt
|
|
1525
|
+
* and only get full schemas after being surfaced via the `tool_search`
|
|
1526
|
+
* native tool ("lazy" / progressive disclosure).
|
|
1464
1527
|
*
|
|
1465
|
-
*
|
|
1466
|
-
*
|
|
1528
|
+
* Native tools (those passed to `createAgent({ tools })`) and skill tools
|
|
1529
|
+
* are always eager — they are core to the agent and cheap. Only MCP tools
|
|
1530
|
+
* are eligible for lazy disclosure.
|
|
1531
|
+
*
|
|
1532
|
+
* When `'lazy'`, the agent:
|
|
1533
|
+
* - Appends a `<searchable_tools>` section to the system prompt listing
|
|
1534
|
+
* every MCP tool by `name` + `description` only (no `inputSchema`).
|
|
1535
|
+
* - Auto-injects a `tool_search` native tool (opt out via
|
|
1536
|
+
* {@link AgentBehavior.toolSearch}) the model uses to load schemas on
|
|
1537
|
+
* demand. Surfaced tools persist for the rest of the run.
|
|
1538
|
+
* - Rebuilds the wire-level tool list each turn, appending newly-unlocked
|
|
1539
|
+
* tools at the end so the prefix-cache breakpoint advances cleanly.
|
|
1540
|
+
*
|
|
1541
|
+
* Trade-off: every `tool_search` invocation expands the tool list and
|
|
1542
|
+
* invalidates the tool-list cache breakpoint for one turn. With many
|
|
1543
|
+
* MCP servers, the savings on cold turns (fewer schemas in context) are
|
|
1544
|
+
* substantial; with one tiny MCP server, the overhead may not pay back.
|
|
1545
|
+
*
|
|
1546
|
+
* Default: `'eager'`.
|
|
1467
1547
|
*/
|
|
1468
|
-
|
|
1469
|
-
/** Top-level session status */
|
|
1470
|
-
readonly status: SessionData['status'];
|
|
1471
|
-
/** All runs in this session */
|
|
1472
|
-
readonly runs: SessionRun[];
|
|
1473
|
-
/** Arbitrary metadata */
|
|
1474
|
-
readonly metadata: Record<string, unknown>;
|
|
1548
|
+
toolDisclosure?: 'eager' | 'lazy';
|
|
1475
1549
|
/**
|
|
1476
|
-
*
|
|
1477
|
-
*
|
|
1478
|
-
*
|
|
1550
|
+
* Fine-grained config for the `tool_search` tool auto-injected when
|
|
1551
|
+
* {@link AgentBehavior.toolDisclosure} is `'lazy'`. No-op in eager mode.
|
|
1552
|
+
*
|
|
1553
|
+
* - `tool: false` — opt out of the auto-injection entirely. Use when the
|
|
1554
|
+
* host wants to ship a custom discovery tool. Note that the catalog
|
|
1555
|
+
* text drops the call-to-action prose in this case so the model isn't
|
|
1556
|
+
* pointed at a non-existent tool.
|
|
1557
|
+
* - `limit` — default cap on results returned per `tool_search` call when
|
|
1558
|
+
* the model omits the parameter. Default: `20`.
|
|
1559
|
+
*
|
|
1560
|
+
* Note on host-defined `tool_search`: a tool the host registers under the
|
|
1561
|
+
* name `tool_search` (or under any alias whose canonical is `tool_search`)
|
|
1562
|
+
* will shadow the auto-injected one — the catalog text will point at the
|
|
1563
|
+
* host's wire name, but driving the unlock flow requires either using
|
|
1564
|
+
* `createToolSearchTool({ catalog, unlocked })` from `tools/tool-search`
|
|
1565
|
+
* (which internally mutates the unlock set) or fully opting out via
|
|
1566
|
+
* `toolSearch.tool: false` and treating discovery as a host-side concern.
|
|
1567
|
+
* A bare host tool that doesn't touch the unlock set will not advance the
|
|
1568
|
+
* lazy disclosure state and the hard gate will keep refusing lazy calls.
|
|
1569
|
+
*
|
|
1570
|
+
* Default: `undefined` (auto-inject with the default limit).
|
|
1479
1571
|
*/
|
|
1480
|
-
|
|
1481
|
-
|
|
1482
|
-
|
|
1483
|
-
}
|
|
1484
|
-
/** Mark a run as completed */
|
|
1485
|
-
completeRun: (runId: string, stats: {
|
|
1486
|
-
turns: number;
|
|
1487
|
-
tokensIn: number;
|
|
1488
|
-
tokensOut: number;
|
|
1489
|
-
turnUsage?: TurnUsage[];
|
|
1490
|
-
cost?: number;
|
|
1491
|
-
}) => void;
|
|
1492
|
-
/** Mark a run as aborted */
|
|
1493
|
-
abortRun: (runId: string) => void;
|
|
1494
|
-
/** Mark a run as errored */
|
|
1495
|
-
errorRun: (runId: string, error: string) => void;
|
|
1496
|
-
/** Append turns to in-memory history AND persist via store.appendTurns (if store present) */
|
|
1497
|
-
appendTurns: (turns: SessionTurn[]) => Promise<void>;
|
|
1498
|
-
/** Replace all turns in-memory (does not persist — use save() for that) */
|
|
1499
|
-
setTurns: (turns: SessionTurn[]) => void;
|
|
1500
|
-
/** Update the session status in memory AND via store.updateStatus (if store present) */
|
|
1501
|
-
updateStatus: (status: SessionData['status']) => Promise<void>;
|
|
1502
|
-
/** Persist an updated run record via store.updateRun (if store present) */
|
|
1503
|
-
updateRun: (run: SessionRun) => Promise<void>;
|
|
1504
|
-
/** Generate a turn ID using store.generateTurnId if available, else crypto.randomUUID() */
|
|
1505
|
-
generateTurnId: () => string | Promise<string>;
|
|
1506
|
-
/** Set metadata key */
|
|
1507
|
-
setMeta: (key: string, value: unknown) => void;
|
|
1508
|
-
/** Persist the full session document to the store */
|
|
1509
|
-
save: () => Promise<void>;
|
|
1510
|
-
/** Serialize to SessionData */
|
|
1511
|
-
toJSON: () => SessionData;
|
|
1512
|
-
}
|
|
1513
|
-
interface CreateSessionOptions {
|
|
1514
|
-
/** Session ID. If omitted and store provides generateSessionId, that is used. */
|
|
1515
|
-
id?: string;
|
|
1516
|
-
/** Agent ID label */
|
|
1517
|
-
agentId?: string;
|
|
1518
|
-
/** Initial metadata */
|
|
1519
|
-
metadata?: Record<string, unknown>;
|
|
1520
|
-
/** Storage backend (optional, enables save/load) */
|
|
1521
|
-
store?: SessionStore;
|
|
1522
|
-
_data?: SessionData;
|
|
1572
|
+
toolSearch?: {
|
|
1573
|
+
tool?: false;
|
|
1574
|
+
limit?: number;
|
|
1575
|
+
};
|
|
1523
1576
|
}
|
|
1524
1577
|
/**
|
|
1525
|
-
*
|
|
1526
|
-
* Async so stores that generate IDs server-side (e.g. Supabase) can be supported.
|
|
1527
|
-
*/
|
|
1528
|
-
declare function createSession(options?: CreateSessionOptions): Promise<Session>;
|
|
1529
|
-
/**
|
|
1530
|
-
* Load an existing session from a store.
|
|
1531
|
-
*/
|
|
1532
|
-
declare function loadSession(store: SessionStore, sessionId: string): Promise<Session | null>;
|
|
1533
|
-
//#endregion
|
|
1534
|
-
//#region src/skills/types.d.ts
|
|
1535
|
-
/**
|
|
1536
|
-
* Types for the Agent Skills system.
|
|
1578
|
+
* One block of a multimodal user prompt.
|
|
1537
1579
|
*
|
|
1538
|
-
*
|
|
1539
|
-
*
|
|
1540
|
-
*
|
|
1580
|
+
* `agent.run({ prompt })` accepts either a plain string (treated as a single
|
|
1581
|
+
* text part) or an array of these parts for multimodal inputs.
|
|
1582
|
+
*
|
|
1583
|
+
* `document` parts are routed per provider: PDF-style mime types are sent as
|
|
1584
|
+
* native document blocks when the provider supports them; text documents are
|
|
1585
|
+
* inlined as text with an attachment header. Providers that cannot handle an
|
|
1586
|
+
* image or document throw early.
|
|
1541
1587
|
*/
|
|
1542
|
-
|
|
1543
|
-
|
|
1544
|
-
|
|
1545
|
-
|
|
1546
|
-
|
|
1588
|
+
type PromptPart = PromptTextPart | PromptImagePart | PromptDocumentPart;
|
|
1589
|
+
interface PromptTextPart {
|
|
1590
|
+
type: 'text';
|
|
1591
|
+
text: string;
|
|
1592
|
+
}
|
|
1593
|
+
interface PromptImagePart {
|
|
1594
|
+
type: 'image';
|
|
1595
|
+
/** IANA media type (e.g. `image/png`, `image/jpeg`) */
|
|
1596
|
+
mediaType: string;
|
|
1597
|
+
/** Base64-encoded payload */
|
|
1598
|
+
data: string;
|
|
1599
|
+
/** Optional display name */
|
|
1600
|
+
name?: string;
|
|
1601
|
+
}
|
|
1602
|
+
interface PromptDocumentPart {
|
|
1603
|
+
type: 'document';
|
|
1604
|
+
/** IANA media type (e.g. `application/pdf`, `text/plain`) */
|
|
1605
|
+
mediaType: string;
|
|
1606
|
+
/** Either a base64-encoded payload (`encoding: 'base64'`) or raw text (`encoding: 'text'`) */
|
|
1607
|
+
data: string;
|
|
1608
|
+
encoding: 'base64' | 'text';
|
|
1609
|
+
/** Optional display name used in attachment headers */
|
|
1610
|
+
name?: string;
|
|
1547
1611
|
}
|
|
1548
1612
|
/**
|
|
1549
|
-
*
|
|
1550
|
-
*
|
|
1613
|
+
* A single block of structured tool-result content.
|
|
1614
|
+
*
|
|
1615
|
+
* MCP servers can return a mix of text, image, resource, and audio blocks. Tools
|
|
1616
|
+
* return `string` for the common text-only case or `ToolResultContent[]` when they
|
|
1617
|
+
* need to preserve non-text content (e.g. screenshots from a browser MCP).
|
|
1618
|
+
*
|
|
1619
|
+
* Providers that support native multi-part tool results (Anthropic, OpenAI Codex via
|
|
1620
|
+
* pi-ai) route image blocks into their wire format verbatim; OpenAI-compat providers
|
|
1621
|
+
* route them via a companion-user-message fallback when the underlying model/endpoint
|
|
1622
|
+
* does not accept images inside tool-role messages.
|
|
1551
1623
|
*/
|
|
1552
|
-
type
|
|
1553
|
-
|
|
1554
|
-
|
|
1555
|
-
|
|
1556
|
-
/** Stable machine-readable code (e.g. `name-mismatch-directory`). */
|
|
1557
|
-
code: string;
|
|
1558
|
-
/** Human-readable description. */
|
|
1559
|
-
message: string;
|
|
1560
|
-
/** Optional frontmatter field name the diagnostic relates to. */
|
|
1561
|
-
field?: string;
|
|
1624
|
+
type ToolResultContent = ToolResultTextContent | ToolResultImageContent;
|
|
1625
|
+
interface ToolResultTextContent {
|
|
1626
|
+
type: 'text';
|
|
1627
|
+
text: string;
|
|
1562
1628
|
}
|
|
1563
|
-
interface
|
|
1564
|
-
|
|
1565
|
-
|
|
1566
|
-
|
|
1567
|
-
|
|
1568
|
-
|
|
1569
|
-
instructions: string;
|
|
1570
|
-
/**
|
|
1571
|
-
* Where this skill was loaded from. Drives collision precedence and the
|
|
1572
|
-
* `trustProjectSkills` gate. Optional — `parseSkillFile` stamps it; raw
|
|
1573
|
-
* fixtures that omit it are treated as `'project'` by downstream readers.
|
|
1574
|
-
*/
|
|
1575
|
-
source?: SkillSource;
|
|
1576
|
-
/** Absolute path to SKILL.md (undefined for inline skills) */
|
|
1577
|
-
location?: string;
|
|
1578
|
-
/** Skill directory path for resolving relative references */
|
|
1579
|
-
baseDir?: string;
|
|
1580
|
-
/** License identifier or reference */
|
|
1581
|
-
license?: string;
|
|
1582
|
-
/** Environment requirements */
|
|
1583
|
-
compatibility?: string;
|
|
1584
|
-
/**
|
|
1585
|
-
* Flat key-value metadata bag per the spec. For Zidane-specific hints,
|
|
1586
|
-
* use the `zidane.` key prefix (e.g. `metadata['zidane.paths']`).
|
|
1587
|
-
*/
|
|
1588
|
-
metadata?: Record<string, string>;
|
|
1589
|
-
/** Pre-approved tool names (experimental per spec) */
|
|
1590
|
-
allowedTools?: string[];
|
|
1591
|
-
/** Bundled resource files discovered in the skill directory */
|
|
1592
|
-
resources?: SkillResource[];
|
|
1593
|
-
/**
|
|
1594
|
-
* Lenient-load warnings recorded during parsing. Host SDKs can surface these
|
|
1595
|
-
* as inline UI hints. Absent when no issues were found.
|
|
1596
|
-
*/
|
|
1597
|
-
diagnostics?: SkillDiagnostic[];
|
|
1629
|
+
interface ToolResultImageContent {
|
|
1630
|
+
type: 'image';
|
|
1631
|
+
/** IANA media type (e.g. `image/png`, `image/jpeg`) */
|
|
1632
|
+
mediaType: string;
|
|
1633
|
+
/** Base64-encoded payload */
|
|
1634
|
+
data: string;
|
|
1598
1635
|
}
|
|
1599
|
-
|
|
1636
|
+
/**
|
|
1637
|
+
* Lossy flattener — converts `ToolResultContent[]` (or a plain string) to a single
|
|
1638
|
+
* string. Image blocks are replaced with `[image: <media> — <n> b64 bytes]` markers.
|
|
1639
|
+
*
|
|
1640
|
+
* Use at UI boundaries where a string is required; providers that understand
|
|
1641
|
+
* structured content should route the array through without flattening.
|
|
1642
|
+
*/
|
|
1643
|
+
declare function toolResultToText(content: string | ToolResultContent[]): string;
|
|
1644
|
+
/**
|
|
1645
|
+
* Approximate byte length of a tool output as it goes back to the model.
|
|
1646
|
+
*
|
|
1647
|
+
* - Plain text: UTF-8 byte length.
|
|
1648
|
+
* - Structured content: text blocks contribute their UTF-8 byte length; image
|
|
1649
|
+
* blocks contribute their **base64 character length**, since that is what
|
|
1650
|
+
* the model tokenizes (the wire-encoded payload, not the decoded image).
|
|
1651
|
+
*
|
|
1652
|
+
* Used by the agent loop to populate `outputBytes` on `tool:after`,
|
|
1653
|
+
* `tool:transform`, `mcp:tool:after`, and `mcp:tool:transform` hooks so
|
|
1654
|
+
* consumers can size-budget tool output without re-counting bytes themselves.
|
|
1655
|
+
*/
|
|
1656
|
+
declare function toolOutputByteLength(content: string | ToolResultContent[]): number;
|
|
1657
|
+
type SessionContentBlock = {
|
|
1658
|
+
type: 'text';
|
|
1659
|
+
text: string;
|
|
1660
|
+
} | {
|
|
1661
|
+
type: 'image';
|
|
1662
|
+
mediaType: string;
|
|
1663
|
+
data: string;
|
|
1664
|
+
} | {
|
|
1665
|
+
type: 'tool_call';
|
|
1666
|
+
id: string;
|
|
1667
|
+
name: string;
|
|
1668
|
+
input: Record<string, unknown>;
|
|
1669
|
+
} | {
|
|
1670
|
+
type: 'tool_result';
|
|
1671
|
+
callId: string;
|
|
1600
1672
|
/**
|
|
1601
|
-
*
|
|
1602
|
-
*
|
|
1603
|
-
* - `false` or `[]`: fully disable the skills system (no resolution, no catalog, no hooks)
|
|
1604
|
-
* - `string[]`: allowlist — only skills with matching names are enabled
|
|
1673
|
+
* Tool output — either a plain string (text-only, the common case) or a structured
|
|
1674
|
+
* array of content blocks (text + image for multimodal tools such as screenshots).
|
|
1605
1675
|
*/
|
|
1606
|
-
|
|
1607
|
-
|
|
1608
|
-
|
|
1609
|
-
|
|
1610
|
-
|
|
1611
|
-
|
|
1612
|
-
exclude?: string[];
|
|
1613
|
-
/** Skip default scan paths (~/.agents/skills, .zidane/skills, etc.) */
|
|
1614
|
-
skipDefaultPaths?: boolean;
|
|
1676
|
+
output: string | ToolResultContent[];
|
|
1677
|
+
isError?: boolean;
|
|
1678
|
+
} | {
|
|
1679
|
+
type: 'thinking';
|
|
1680
|
+
text: string;
|
|
1681
|
+
signature?: string;
|
|
1615
1682
|
/**
|
|
1616
|
-
*
|
|
1617
|
-
*
|
|
1618
|
-
*
|
|
1619
|
-
* tool instead).
|
|
1683
|
+
* Provider that minted `signature`. Signatures are provider-bound (Anthropic
|
|
1684
|
+
* HMAC vs. OpenAI `encrypted_content`) and are dropped on cross-provider
|
|
1685
|
+
* hops to avoid 400s. Unset means legacy/unknown — forwarded as-is.
|
|
1620
1686
|
*/
|
|
1621
|
-
|
|
1687
|
+
signatureProducer?: 'anthropic' | 'openai';
|
|
1688
|
+
} | {
|
|
1689
|
+
type: 'redacted_thinking';
|
|
1690
|
+
data: string;
|
|
1691
|
+
} | {
|
|
1622
1692
|
/**
|
|
1623
|
-
*
|
|
1624
|
-
*
|
|
1693
|
+
* Opaque round-trip envelope for reasoning state minted by an OpenAI-compat
|
|
1694
|
+
* gateway (currently OpenRouter). The gateway expects its own
|
|
1695
|
+
* `reasoning_details` array echoed back verbatim on the next turn so the
|
|
1696
|
+
* upstream model can resume an extended-reasoning chain across tool calls.
|
|
1697
|
+
*
|
|
1698
|
+
* Stored opaquely because the items are provider-bound (Anthropic HMAC
|
|
1699
|
+
* signatures, OpenAI `encrypted_content`, model-specific summary formats
|
|
1700
|
+
* — all flowing through the gateway's normalized envelope).
|
|
1625
1701
|
*/
|
|
1626
|
-
|
|
1627
|
-
|
|
1628
|
-
|
|
1702
|
+
type: 'provider_reasoning';
|
|
1703
|
+
producer: 'openrouter';
|
|
1704
|
+
details: unknown[];
|
|
1629
1705
|
/**
|
|
1630
|
-
*
|
|
1631
|
-
*
|
|
1632
|
-
*
|
|
1706
|
+
* Model id that produced the details. Reasoning is bound to a specific
|
|
1707
|
+
* upstream route — a model switch on the next turn invalidates the
|
|
1708
|
+
* embedded signatures, so the sender drops the block on mismatch.
|
|
1633
1709
|
*/
|
|
1634
|
-
|
|
1710
|
+
model?: string;
|
|
1711
|
+
};
|
|
1712
|
+
interface SessionMessage {
|
|
1713
|
+
role: 'user' | 'assistant';
|
|
1714
|
+
content: SessionContentBlock[];
|
|
1715
|
+
}
|
|
1716
|
+
interface SessionTurn {
|
|
1717
|
+
/** UUID — generated by the store if it provides generateTurnId, else crypto.randomUUID() */
|
|
1718
|
+
id: string;
|
|
1719
|
+
/** Run that produced this turn (e.g. 'run_1') */
|
|
1720
|
+
runId?: string;
|
|
1721
|
+
role: 'user' | 'assistant' | 'system';
|
|
1722
|
+
content: SessionContentBlock[];
|
|
1723
|
+
/** Token usage — only present on assistant turns */
|
|
1724
|
+
usage?: TurnUsage;
|
|
1725
|
+
/** Unix timestamp (Date.now()) when the turn was created */
|
|
1726
|
+
createdAt: number;
|
|
1635
1727
|
}
|
|
1636
|
-
//#endregion
|
|
1637
|
-
//#region src/tools/types.d.ts
|
|
1638
1728
|
/**
|
|
1639
|
-
*
|
|
1640
|
-
*
|
|
1641
|
-
*
|
|
1642
|
-
* The preset-y fields (`name`, `system`, `tools`, `toolAliases`, `mcpServers`, `skills`,
|
|
1643
|
-
* `behavior`) mirror the agent's own options so child-spawning tools can inherit them.
|
|
1729
|
+
* Per-run hook registrations. Each entry can be a single handler or an array of handlers.
|
|
1730
|
+
* Keys are `AgentHooks` event names (loose-typed here to avoid a circular import; agent.ts
|
|
1731
|
+
* narrows it to the strongly-typed map).
|
|
1644
1732
|
*/
|
|
1645
|
-
|
|
1646
|
-
|
|
1647
|
-
|
|
1648
|
-
/** Abort signal — tools should check this for early termination */
|
|
1649
|
-
signal: AbortSignal;
|
|
1650
|
-
/** The execution context (shell, filesystem, etc.) */
|
|
1651
|
-
execution: ExecutionContext;
|
|
1652
|
-
/** The active execution handle for the current agent run */
|
|
1653
|
-
handle: ExecutionHandle;
|
|
1654
|
-
/** Agent hooks for emitting events (e.g. spawn:complete) */
|
|
1655
|
-
hooks: Hookable<AgentHooks>;
|
|
1656
|
-
/** Agent display name (preset or user-supplied) */
|
|
1657
|
-
name?: string;
|
|
1658
|
-
/** Agent default system prompt */
|
|
1659
|
-
system?: string;
|
|
1660
|
-
/** Source tool map the agent was created with (pre-MCP-merge, pre-skills-injection) */
|
|
1661
|
-
tools: Record<string, ToolDef>;
|
|
1733
|
+
type RunHookMap = Record<string, ((ctx: any) => unknown) | ((ctx: any) => unknown)[]>;
|
|
1734
|
+
interface AgentRunOptions {
|
|
1735
|
+
model?: string;
|
|
1662
1736
|
/**
|
|
1663
|
-
*
|
|
1737
|
+
* User prompt. Optional when resuming a session with existing turns.
|
|
1664
1738
|
*
|
|
1665
|
-
*
|
|
1666
|
-
*
|
|
1667
|
-
* what appears in `ToolHookContext.displayName` / `McpToolHookContext.displayName`.
|
|
1668
|
-
* - The canonical name is what lives in `session.turns`, `ToolHookContext.name`, and
|
|
1669
|
-
* what the agent uses to look up the tool implementation. Alias changes never
|
|
1670
|
-
* desync persisted history.
|
|
1739
|
+
* Accepts either a plain string (single text part) or an array of `PromptPart`s for
|
|
1740
|
+
* multimodal inputs (text, images, documents). See {@link PromptPart}.
|
|
1671
1741
|
*/
|
|
1672
|
-
|
|
1673
|
-
|
|
1674
|
-
|
|
1675
|
-
/**
|
|
1676
|
-
|
|
1677
|
-
/** Behavior
|
|
1742
|
+
prompt?: string | PromptPart[];
|
|
1743
|
+
system?: string;
|
|
1744
|
+
thinking?: ThinkingLevel;
|
|
1745
|
+
/** Abort signal — when triggered, the agent stops after the current turn */
|
|
1746
|
+
signal?: AbortSignal;
|
|
1747
|
+
/** Behavior overrides for this run (overrides agent defaults) */
|
|
1678
1748
|
behavior?: AgentBehavior;
|
|
1679
|
-
/**
|
|
1680
|
-
|
|
1681
|
-
/** Tool call ID from the model */
|
|
1682
|
-
callId: string;
|
|
1749
|
+
/** Tool overrides for this run. Pass {} for no tools. Omit to use agent tools. */
|
|
1750
|
+
tools?: Record<string, ToolDef>;
|
|
1683
1751
|
/**
|
|
1684
|
-
*
|
|
1685
|
-
*
|
|
1686
|
-
* by hand (tests, direct tool invocations) doesn't have to synthesize one.
|
|
1752
|
+
* Per-run hook registrations. Each hook is attached before the run starts and
|
|
1753
|
+
* detached in a finally block so handlers never leak across runs.
|
|
1687
1754
|
*
|
|
1688
|
-
*
|
|
1689
|
-
* the subagent tree can be reconstructed from a persisted session.
|
|
1755
|
+
* Accepts either a single handler or an array (all handlers register).
|
|
1690
1756
|
*/
|
|
1691
|
-
|
|
1757
|
+
hooks?: RunHookMap;
|
|
1692
1758
|
/**
|
|
1693
|
-
*
|
|
1694
|
-
*
|
|
1695
|
-
* parent
|
|
1759
|
+
* Parent run id. Populated automatically by the `spawn` tool when the child
|
|
1760
|
+
* shares the parent's session; recorded on the resulting `SessionRun` so the
|
|
1761
|
+
* parent↔child run tree can be reconstructed from a persisted session.
|
|
1696
1762
|
*/
|
|
1697
|
-
|
|
1763
|
+
parentRunId?: string;
|
|
1698
1764
|
/**
|
|
1699
|
-
*
|
|
1700
|
-
*
|
|
1701
|
-
*
|
|
1765
|
+
* Zero-based subagent depth. 0 = top-level `agent.run()`, 1 = first-level
|
|
1766
|
+
* child spawned by a parent agent, and so on. Used by the spawn tool to
|
|
1767
|
+
* enforce `maxDepth` and to stamp `child:*` forwarded hook payloads.
|
|
1702
1768
|
*/
|
|
1703
1769
|
depth?: number;
|
|
1704
1770
|
}
|
|
1705
|
-
interface ToolDef {
|
|
1706
|
-
spec: ToolSpec;
|
|
1707
|
-
/**
|
|
1708
|
-
* Execute the tool and return its output.
|
|
1709
|
-
*
|
|
1710
|
-
* Return a plain string for text-only tools (the common case). Return a
|
|
1711
|
-
* `ToolResultContent[]` when the tool produces non-text content (images, mixed
|
|
1712
|
-
* text+image) that the provider can route through natively (Anthropic
|
|
1713
|
-
* `tool_result.content` arrays, OpenAI Codex pi-ai) or through the
|
|
1714
|
-
* companion-user-message fallback (OpenAI Chat Completions).
|
|
1715
|
-
*/
|
|
1716
|
-
execute: (input: Record<string, unknown>, ctx: ToolContext) => Promise<string | ToolResultContent[]>;
|
|
1717
|
-
}
|
|
1718
|
-
type ToolMap = Map<string, ToolDef>;
|
|
1719
|
-
//#endregion
|
|
1720
|
-
//#region src/mcp/index.d.ts
|
|
1721
|
-
interface McpConnection {
|
|
1722
|
-
tools: Record<string, ToolDef>;
|
|
1723
|
-
close: () => Promise<void>;
|
|
1724
|
-
}
|
|
1725
|
-
/**
|
|
1726
|
-
* Normalize MCP server configs from any common shape to `McpServerConfig[]`.
|
|
1727
|
-
*
|
|
1728
|
-
* Accepts:
|
|
1729
|
-
* - `McpServerConfig[]` — zidane native (pass-through).
|
|
1730
|
-
* - `McpServerConfig` — a single config object (wrapped to a 1-element array).
|
|
1731
|
-
* - `Record<string, RawShape>` — name-keyed map (common in host-SDK configs), where the key is the server name.
|
|
1732
|
-
* - Mixed shapes with `type` vs `transport`, `httpUrl`/`sseUrl` vs `url`.
|
|
1733
|
-
*
|
|
1734
|
-
* Returns `[]` when `input` is nullish. Throws a descriptive error when the transport
|
|
1735
|
-
* cannot be inferred from a given entry, or when the input shape is unsupported.
|
|
1736
|
-
*/
|
|
1737
|
-
declare function normalizeMcpServers(input: unknown): McpServerConfig[];
|
|
1738
|
-
/**
|
|
1739
|
-
* Lossy flattener — converts MCP `CallToolResult.content` blocks to a single
|
|
1740
|
-
* string. Text blocks are extracted; non-text blocks are JSON-stringified.
|
|
1741
|
-
*
|
|
1742
|
-
* Use this only at UI / log boundaries that require a string. The agent
|
|
1743
|
-
* loop itself routes through {@link normalizeMcpBlocks} so image blocks
|
|
1744
|
-
* survive into provider-native tool_result content (Anthropic blocks,
|
|
1745
|
-
* OpenAI companion-user-message).
|
|
1746
|
-
*/
|
|
1747
|
-
declare function resultToString(content: unknown[]): string;
|
|
1748
|
-
/**
|
|
1749
|
-
* Normalize MCP `CallToolResult.content` to zidane's {@link ToolResultContent[]} shape.
|
|
1750
|
-
*
|
|
1751
|
-
* Handles the four MCP content block types:
|
|
1752
|
-
* - `text` → preserved as `{type:'text', text}`
|
|
1753
|
-
* - `image` → preserved as `{type:'image', mediaType, data}` (MCP uses `mimeType`)
|
|
1754
|
-
* - `resource` with embedded text → flattened to a text block
|
|
1755
|
-
* - `resource` with embedded blob whose `mimeType` is `image/*` → flattened to an image block
|
|
1756
|
-
* - Any unrecognized block → JSON-stringified fallback text block (lossy but safe)
|
|
1757
|
-
*
|
|
1758
|
-
* Returns `null` when the input is not an array — callers should fall back to an empty
|
|
1759
|
-
* result in that case.
|
|
1760
|
-
*/
|
|
1761
|
-
declare function normalizeMcpBlocks(content: unknown): ToolResultContent[] | null;
|
|
1762
|
-
/**
|
|
1763
|
-
* Connect to MCP servers and discover their tools.
|
|
1764
|
-
*
|
|
1765
|
-
* Each tool is namespaced as `mcp_{serverName}_{toolName}` to avoid
|
|
1766
|
-
* collisions with agent tools or tools from other servers.
|
|
1767
|
-
*
|
|
1768
|
-
* @param configs - Array of MCP server configurations
|
|
1769
|
-
* @param _clientFactory - Internal: override client construction for testing
|
|
1770
|
-
* @param hooks - Optional agent hooks for firing mcp:connect, mcp:error, mcp:close events
|
|
1771
|
-
*/
|
|
1772
|
-
declare function connectMcpServers(configs: McpServerConfig[], _clientFactory?: () => Client, hooks?: Hookable<AgentHooks>): Promise<McpConnection>;
|
|
1773
|
-
//#endregion
|
|
1774
|
-
//#region src/skills/activation.d.ts
|
|
1775
|
-
/** How a skill was activated. Surfaced in `skills:activate` hook ctx. */
|
|
1776
|
-
type ActivationVia = 'model' | 'explicit' | 'resume';
|
|
1777
|
-
/** Reason a skill was deactivated. Surfaced in `skills:deactivate` hook ctx. */
|
|
1778
|
-
type DeactivationReason = 'run-end' | 'explicit' | 'reset';
|
|
1779
|
-
/** A skill currently active in the state machine. */
|
|
1780
|
-
interface ActiveSkill {
|
|
1781
|
-
skill: SkillConfig;
|
|
1782
|
-
activatedAt: number;
|
|
1783
|
-
activatedVia: ActivationVia;
|
|
1784
|
-
}
|
|
1785
1771
|
/**
|
|
1786
|
-
*
|
|
1787
|
-
*
|
|
1772
|
+
* Reason the provider gave for stopping the turn.
|
|
1773
|
+
*
|
|
1774
|
+
* - `'stop'` — natural turn end (`end_turn` / `stop_sequence`).
|
|
1775
|
+
* - `'tool-calls'` — model emitted tool_use blocks.
|
|
1776
|
+
* - `'length'` — `max_tokens` reached, or (Anthropic 4.6+) the response bumped
|
|
1777
|
+
* against the model's context window mid-stream
|
|
1778
|
+
* (`model_context_window_exceeded`). The partial response is preserved; the
|
|
1779
|
+
* loop emits this reason so consumers can prune/retry.
|
|
1780
|
+
* - `'content-filter'` — model refused.
|
|
1781
|
+
* - `'pause'` — Anthropic `pause_turn`: a server-side mid-turn pause for very
|
|
1782
|
+
* long thinking. The loop continues with a synthetic "Please continue."
|
|
1783
|
+
* user message rather than terminating; consumers see the pause via this
|
|
1784
|
+
* finish reason on the prior assistant turn.
|
|
1785
|
+
* - `'error'` — provider classified the turn as failed.
|
|
1786
|
+
* - `'other'` — unknown / unmapped.
|
|
1788
1787
|
*/
|
|
1789
|
-
|
|
1790
|
-
|
|
1791
|
-
|
|
1792
|
-
|
|
1793
|
-
|
|
1794
|
-
|
|
1795
|
-
|
|
1788
|
+
type TurnFinishReason = 'stop' | 'tool-calls' | 'length' | 'content-filter' | 'pause' | 'error' | 'other';
|
|
1789
|
+
interface TurnUsage {
|
|
1790
|
+
input: number;
|
|
1791
|
+
output: number;
|
|
1792
|
+
/** Tokens written to cache (Anthropic) */
|
|
1793
|
+
cacheCreation?: number;
|
|
1794
|
+
/** Tokens read from cache (Anthropic) */
|
|
1795
|
+
cacheRead?: number;
|
|
1796
|
+
/** Thinking/reasoning tokens used */
|
|
1797
|
+
thinking?: number;
|
|
1798
|
+
/** Cost in USD as reported by the provider (OpenRouter) */
|
|
1799
|
+
cost?: number;
|
|
1796
1800
|
/**
|
|
1797
|
-
*
|
|
1798
|
-
*
|
|
1799
|
-
* - Returns `'already-active'` if the skill was already in the set (idempotent).
|
|
1800
|
-
* - Returns `'cap-reached'` if the `maxActive` cap would be exceeded. State is unchanged.
|
|
1801
|
+
* Why the model stopped this turn. Providers normalize native stop reasons to this union.
|
|
1802
|
+
* Absent when the provider did not surface a reason (e.g. mock turns).
|
|
1801
1803
|
*/
|
|
1802
|
-
|
|
1804
|
+
finishReason?: TurnFinishReason;
|
|
1803
1805
|
/**
|
|
1804
|
-
*
|
|
1805
|
-
*
|
|
1806
|
+
* The model ID the provider ultimately used. May differ from the requested model when the
|
|
1807
|
+
* provider remaps aliases. Absent for providers that do not echo a model ID.
|
|
1806
1808
|
*/
|
|
1807
|
-
|
|
1808
|
-
/** Remove every active skill. Returns the list of removed records. */
|
|
1809
|
-
clear: () => readonly ActiveSkill[];
|
|
1809
|
+
modelId?: string;
|
|
1810
1810
|
}
|
|
1811
|
-
interface
|
|
1811
|
+
interface AgentStats {
|
|
1812
1812
|
/**
|
|
1813
|
-
*
|
|
1814
|
-
*
|
|
1813
|
+
* Cumulative input tokens across the parent agent loop **and** every
|
|
1814
|
+
* recursively-spawned sub-agent. Use this for billing / token-ledger
|
|
1815
|
+
* consumption.
|
|
1815
1816
|
*/
|
|
1816
|
-
|
|
1817
|
-
}
|
|
1818
|
-
|
|
1819
|
-
//#endregion
|
|
1820
|
-
//#region src/agent.d.ts
|
|
1821
|
-
interface AgentHooks {
|
|
1822
|
-
'system:before': (ctx: {
|
|
1823
|
-
system: string;
|
|
1824
|
-
}) => void;
|
|
1825
|
-
'turn:before': (ctx: {
|
|
1826
|
-
turn: number;
|
|
1827
|
-
turnId: string;
|
|
1828
|
-
options: StreamOptions;
|
|
1829
|
-
}) => void;
|
|
1817
|
+
totalIn: number;
|
|
1818
|
+
/** Cumulative output tokens. Same semantics as {@link AgentStats.totalIn}. */
|
|
1819
|
+
totalOut: number;
|
|
1830
1820
|
/**
|
|
1831
|
-
*
|
|
1832
|
-
*
|
|
1833
|
-
*
|
|
1834
|
-
*
|
|
1835
|
-
*
|
|
1836
|
-
*
|
|
1837
|
-
* regardless of downstream gate outcome. Most useful for spotting per-turn
|
|
1838
|
-
* spikes ("the model called todowrite 4 times in one turn").
|
|
1839
|
-
*
|
|
1840
|
-
* `toolCounts.run` — cumulative running counter of **dispatched** calls
|
|
1841
|
-
* scoped to this `runId`, captured at fire time. Excludes calls that were
|
|
1842
|
-
* `block`ed by `tool:gate` handlers. Includes calls short-circuited via
|
|
1843
|
-
* `tool:gate` `result` substitution (the model still asked, the framework
|
|
1844
|
-
* just answered without the tool running). Resumed sessions start a fresh
|
|
1845
|
-
* run with empty counts.
|
|
1846
|
-
*
|
|
1847
|
-
* Both fields are frozen snapshots; mutate-safe.
|
|
1821
|
+
* Cumulative cache-read tokens across the parent agent loop and every
|
|
1822
|
+
* recursively-spawned sub-agent. Surfaced at the top level (rather than
|
|
1823
|
+
* only per-`TurnUsage`) because Anthropic prices cache reads at a separate
|
|
1824
|
+
* line-item rate from regular input — billing-correct cost computation
|
|
1825
|
+
* needs this number directly. Always `0` for providers that don't report
|
|
1826
|
+
* cache usage.
|
|
1848
1827
|
*/
|
|
1849
|
-
|
|
1850
|
-
turn: number;
|
|
1851
|
-
turnId: string;
|
|
1852
|
-
usage: TurnUsage;
|
|
1853
|
-
message: SessionTurn;
|
|
1854
|
-
toolCounts: {
|
|
1855
|
-
turn: Readonly<Record<string, number>>;
|
|
1856
|
-
run: Readonly<Record<string, number>>;
|
|
1857
|
-
};
|
|
1858
|
-
}) => void;
|
|
1859
|
-
'stream:text': (ctx: StreamHookContext & {
|
|
1860
|
-
delta: string;
|
|
1861
|
-
text: string;
|
|
1862
|
-
}) => void;
|
|
1863
|
-
'stream:end': (ctx: StreamHookContext & {
|
|
1864
|
-
text: string;
|
|
1865
|
-
}) => void;
|
|
1866
|
-
'stream:thinking': (ctx: StreamHookContext & {
|
|
1867
|
-
delta: string;
|
|
1868
|
-
thinking: string;
|
|
1869
|
-
}) => void;
|
|
1870
|
-
'oauth:refresh': (ctx: OAuthRefreshHookContext) => void;
|
|
1828
|
+
totalCacheRead: number;
|
|
1871
1829
|
/**
|
|
1872
|
-
*
|
|
1873
|
-
*
|
|
1874
|
-
*
|
|
1875
|
-
*
|
|
1876
|
-
* sees a `Blocked: <reason>` tool result; `tool:before` / `tool:after`
|
|
1877
|
-
* do **not** fire.
|
|
1878
|
-
* - Set `result` to substitute a successful tool_result and skip
|
|
1879
|
-
* execution. The model sees the substitute as a normal tool_result;
|
|
1880
|
-
* `tool:before` does not fire, but `tool:after` and `tool:transform`
|
|
1881
|
-
* do — so byte budgets, telemetry, and post-mutation hooks see the
|
|
1882
|
-
* substitute. Useful for cache hits, dedup, idempotency guards,
|
|
1883
|
-
* plan-mode synthetic acks.
|
|
1884
|
-
*
|
|
1885
|
-
* If multiple handlers along the chain set both `block` and `result`,
|
|
1886
|
-
* `block` wins — refusal beats substitution, so a policy gate
|
|
1887
|
-
* (skills allow-list, custom security) can always override an upstream
|
|
1888
|
-
* consumer's cache substitute. Mirrors the writable-`result` shape on
|
|
1889
|
-
* `tool:unknown` and `tool:error` so consumers learn one pattern.
|
|
1890
|
-
*
|
|
1891
|
-
* `runToolCounts` — frozen pre-call snapshot of per-tool dispatched
|
|
1892
|
-
* counts in this run. Use it to self-throttle, drive observability, or
|
|
1893
|
-
* implement budget guards. Counts every call that passed gate, including
|
|
1894
|
-
* dedup substitutes (Z19); excludes `block`ed calls.
|
|
1895
|
-
*
|
|
1896
|
-
* **Parallel mode** (`toolExecution: 'parallel'`, the default): the
|
|
1897
|
-
* snapshot is taken before any dispatches in the batch, so consumer
|
|
1898
|
-
* hooks reading `runToolCounts` see the pre-batch view. Built-in
|
|
1899
|
-
* budget / dedup middleware uses internal per-call reservation, so
|
|
1900
|
-
* `behavior.toolBudgets` enforces atomically even within a parallel
|
|
1901
|
-
* batch.
|
|
1830
|
+
* Cumulative cache-creation tokens across the parent agent loop and every
|
|
1831
|
+
* recursively-spawned sub-agent. Same rationale as
|
|
1832
|
+
* {@link AgentStats.totalCacheRead} — separate Anthropic billing rate.
|
|
1833
|
+
* Always `0` for providers that don't report cache usage.
|
|
1902
1834
|
*/
|
|
1903
|
-
|
|
1904
|
-
block: boolean;
|
|
1905
|
-
reason: string;
|
|
1906
|
-
result?: string | ToolResultContent[];
|
|
1907
|
-
runToolCounts: Readonly<Record<string, number>>;
|
|
1908
|
-
}) => void;
|
|
1909
|
-
'tool:before': (ctx: ToolHookContext & {
|
|
1910
|
-
coercions?: readonly string[];
|
|
1911
|
-
runToolCounts: Readonly<Record<string, number>>;
|
|
1912
|
-
}) => void;
|
|
1913
|
-
'tool:after': (ctx: ToolHookContext & {
|
|
1914
|
-
result: string | ToolResultContent[];
|
|
1915
|
-
outputBytes: number;
|
|
1916
|
-
coercions?: readonly string[];
|
|
1917
|
-
runToolCounts: Readonly<Record<string, number>>;
|
|
1918
|
-
}) => void;
|
|
1835
|
+
totalCacheCreation: number;
|
|
1919
1836
|
/**
|
|
1920
|
-
*
|
|
1921
|
-
*
|
|
1922
|
-
*
|
|
1923
|
-
* (
|
|
1837
|
+
* Number of parent agent-loop turns. Children's turn counts live under
|
|
1838
|
+
* `children[].stats.turns` and are NOT folded in here — a single "turns"
|
|
1839
|
+
* number for the whole tree would conflate two different measures
|
|
1840
|
+
* (parent-loop iterations vs. tree-wide tool-call rounds).
|
|
1924
1841
|
*
|
|
1925
|
-
*
|
|
1926
|
-
* downstream byte-budgeting and image-stripping still apply.
|
|
1842
|
+
* Tree-wide turn count: `flattenTurns(stats).length`.
|
|
1927
1843
|
*/
|
|
1928
|
-
|
|
1929
|
-
error: Error;
|
|
1930
|
-
result?: string | ToolResultContent[];
|
|
1931
|
-
}) => void;
|
|
1932
|
-
'tool:transform': (ctx: ToolHookContext & {
|
|
1933
|
-
result: string | ToolResultContent[];
|
|
1934
|
-
isError: boolean;
|
|
1935
|
-
outputBytes: number;
|
|
1936
|
-
coercions?: readonly string[];
|
|
1937
|
-
}) => void;
|
|
1844
|
+
turns: number;
|
|
1938
1845
|
/**
|
|
1939
|
-
*
|
|
1940
|
-
*
|
|
1941
|
-
*
|
|
1942
|
-
*
|
|
1846
|
+
* Wall-clock duration of the top-level `agent.run()` call, in milliseconds.
|
|
1847
|
+
* Children run during parent tool calls so this naturally subsumes child
|
|
1848
|
+
* wall time — sequential children inflate it, parallel children compress
|
|
1849
|
+
* into the parent's window.
|
|
1850
|
+
*/
|
|
1851
|
+
elapsed: number;
|
|
1852
|
+
/**
|
|
1853
|
+
* Per-turn usage breakdown for the **parent loop only**. Children's per-turn
|
|
1854
|
+
* usages live under `children[].stats.turnUsage`. Use {@link flattenTurns}
|
|
1855
|
+
* to walk the full tree.
|
|
1856
|
+
*/
|
|
1857
|
+
turnUsage?: TurnUsage[];
|
|
1858
|
+
/**
|
|
1859
|
+
* Cumulative cost in USD — parent loop plus every recursively-spawned
|
|
1860
|
+
* sub-agent. Sums per-turn `TurnUsage.cost` reported by the provider.
|
|
1861
|
+
* Absent when neither parent nor any descendant reported a non-zero cost.
|
|
1862
|
+
*/
|
|
1863
|
+
cost?: number;
|
|
1864
|
+
/** Stats from child agents spawned during this run, in completion order. Recursive. */
|
|
1865
|
+
children?: ChildRunStats[];
|
|
1866
|
+
/** Structured output from schema enforcement (only present when behavior.schema is set) */
|
|
1867
|
+
output?: Record<string, unknown>;
|
|
1868
|
+
/**
|
|
1869
|
+
* Milliseconds from the start of `agent.run()` to the first observable signal from the
|
|
1870
|
+
* provider (first `stream:text`, `stream:thinking`, or `tool:before` event).
|
|
1943
1871
|
*
|
|
1944
|
-
*
|
|
1945
|
-
* (`mcp_supabase_xxx`); branch on `name.startsWith('mcp_')` to differentiate.
|
|
1872
|
+
* Absent when the run produced no observable signals (e.g. aborted before any stream event).
|
|
1946
1873
|
*/
|
|
1947
|
-
|
|
1948
|
-
|
|
1949
|
-
|
|
1950
|
-
|
|
1874
|
+
timeTillFirstTokenMs?: number;
|
|
1875
|
+
}
|
|
1876
|
+
interface ChildRunStats {
|
|
1877
|
+
id: string;
|
|
1878
|
+
task: string;
|
|
1951
1879
|
/**
|
|
1952
|
-
*
|
|
1953
|
-
*
|
|
1954
|
-
*
|
|
1955
|
-
*
|
|
1880
|
+
* The child agent's full {@link AgentStats}. Cumulative for that child's
|
|
1881
|
+
* own subtree (child loop + its grandchildren). Do **not** sum
|
|
1882
|
+
* `ctx.stats.totalIn` across `spawn:complete` events to derive top-level
|
|
1883
|
+
* totals — `agent.run()`'s return value is the canonical cumulative root.
|
|
1884
|
+
*/
|
|
1885
|
+
stats: AgentStats;
|
|
1886
|
+
/**
|
|
1887
|
+
* Subagent depth when this child ran. 1 = direct child of the top-level
|
|
1888
|
+
* agent, 2 = grandchild, etc. Useful for telemetry that wants to group
|
|
1889
|
+
* runs by depth.
|
|
1890
|
+
*/
|
|
1891
|
+
depth?: number;
|
|
1892
|
+
/**
|
|
1893
|
+
* Terminal state of the child run. `'completed'` is the default. Exposed so
|
|
1894
|
+
* a parent reading `stats.children` can distinguish aborted/timed-out
|
|
1895
|
+
* children without re-parsing the returned string.
|
|
1956
1896
|
*/
|
|
1957
|
-
'
|
|
1958
|
-
reason: string;
|
|
1959
|
-
schema: Record<string, unknown>;
|
|
1960
|
-
}) => void;
|
|
1897
|
+
status?: 'completed' | 'aborted' | 'timeout' | 'error';
|
|
1961
1898
|
/**
|
|
1962
|
-
*
|
|
1963
|
-
*
|
|
1964
|
-
*
|
|
1965
|
-
* model "wrongness rate" without re-running validation downstream.
|
|
1966
|
-
*
|
|
1967
|
-
* `coercions` lists the field names that were coerced. The values landed in
|
|
1968
|
-
* the input that the tool actually received; consumers wanting before/after
|
|
1969
|
-
* comparison can re-run `validateToolArgs(ctx.input, ctx.schema)`.
|
|
1899
|
+
* Final structured output when the child was run with `behavior.schema`.
|
|
1900
|
+
* Mirrors `AgentStats.output` but is surfaced here so the parent can read
|
|
1901
|
+
* it without peeking at the nested `stats` bag.
|
|
1970
1902
|
*/
|
|
1971
|
-
|
|
1972
|
-
|
|
1973
|
-
|
|
1974
|
-
|
|
1975
|
-
|
|
1976
|
-
|
|
1977
|
-
|
|
1903
|
+
output?: Record<string, unknown>;
|
|
1904
|
+
}
|
|
1905
|
+
/**
|
|
1906
|
+
* Base context for tool execution hooks.
|
|
1907
|
+
*
|
|
1908
|
+
* `name` is the canonical tool identity — the spec name registered on the agent (or the
|
|
1909
|
+
* `mcp_{server}_{tool}` name for MCP tools). Hooks should policy-match against `name`.
|
|
1910
|
+
*
|
|
1911
|
+
* `displayName` is the outward-facing name — the alias surfaced to the LLM when
|
|
1912
|
+
* `AgentOptions.toolAliases` maps the canonical name; otherwise equal to `name`.
|
|
1913
|
+
* UI/telemetry adapters should emit `displayName`.
|
|
1914
|
+
*
|
|
1915
|
+
* Canonical vs. alias matters on session resume: `session.turns` persists canonical
|
|
1916
|
+
* names only, so renaming an alias cannot desync history.
|
|
1917
|
+
*/
|
|
1918
|
+
interface ToolHookContext {
|
|
1919
|
+
turnId: string;
|
|
1920
|
+
callId: string;
|
|
1921
|
+
/** Canonical tool name (spec name). Stable across alias-map changes. */
|
|
1922
|
+
name: string;
|
|
1923
|
+
/** Aliased (wire) name — equal to `name` when no alias is defined. */
|
|
1924
|
+
displayName: string;
|
|
1925
|
+
input: Record<string, unknown>;
|
|
1926
|
+
}
|
|
1927
|
+
/**
|
|
1928
|
+
* Base context for MCP tool hooks.
|
|
1929
|
+
*
|
|
1930
|
+
* `tool` is the native tool name on the MCP server. `server` is the configured server
|
|
1931
|
+
* name. The canonical zidane-namespaced identity is `mcp_{server}_{tool}`.
|
|
1932
|
+
*
|
|
1933
|
+
* `displayName` equals the canonical namespaced name unless the agent has aliased
|
|
1934
|
+
* this MCP tool via `AgentOptions.toolAliases`; in which case `displayName` is the
|
|
1935
|
+
* alias that the LLM sees.
|
|
1936
|
+
*/
|
|
1937
|
+
interface McpToolHookContext {
|
|
1938
|
+
turnId: string;
|
|
1939
|
+
callId: string;
|
|
1940
|
+
server: string;
|
|
1941
|
+
tool: string;
|
|
1942
|
+
/** Aliased wire name for this MCP tool, or the canonical `mcp_{server}_{tool}` name. */
|
|
1943
|
+
displayName: string;
|
|
1944
|
+
input: Record<string, unknown>;
|
|
1945
|
+
}
|
|
1946
|
+
/** Base context for session hooks */
|
|
1947
|
+
interface SessionHookContext {
|
|
1948
|
+
sessionId: string;
|
|
1949
|
+
}
|
|
1950
|
+
/** Base context for spawn hooks */
|
|
1951
|
+
interface SpawnHookContext {
|
|
1952
|
+
id: string;
|
|
1953
|
+
task: string;
|
|
1978
1954
|
/**
|
|
1979
|
-
*
|
|
1980
|
-
*
|
|
1981
|
-
*
|
|
1982
|
-
* already read in the session, surfacing live tool budgets, injecting
|
|
1983
|
-
* skill activation reminders).
|
|
1984
|
-
*
|
|
1985
|
-
* Cache breakpoints are applied inside the provider after this hook, so
|
|
1986
|
-
* mutations land in the cache key naturally — repeated turns with the
|
|
1987
|
-
* same derived system text still hit the cache.
|
|
1988
|
-
*
|
|
1989
|
-
* `messages` is read-only here; use `context:transform` for message
|
|
1990
|
-
* surgery. `session` is `undefined` when the run is sessionless.
|
|
1955
|
+
* Subagent depth for the spawn. 1 = direct child of the top-level agent.
|
|
1956
|
+
* Present on spawn:before/complete/error. Absent for grandchild spawns that
|
|
1957
|
+
* bubble through `child:*` events (which carry their own `depth`).
|
|
1991
1958
|
*/
|
|
1992
|
-
|
|
1993
|
-
|
|
1994
|
-
|
|
1995
|
-
|
|
1996
|
-
|
|
1997
|
-
|
|
1998
|
-
|
|
1999
|
-
|
|
2000
|
-
|
|
2001
|
-
|
|
2002
|
-
|
|
2003
|
-
|
|
2004
|
-
|
|
2005
|
-
|
|
2006
|
-
|
|
2007
|
-
|
|
2008
|
-
|
|
2009
|
-
|
|
2010
|
-
|
|
2011
|
-
|
|
2012
|
-
}
|
|
2013
|
-
|
|
2014
|
-
|
|
2015
|
-
|
|
2016
|
-
|
|
2017
|
-
|
|
2018
|
-
|
|
2019
|
-
|
|
2020
|
-
|
|
2021
|
-
|
|
2022
|
-
|
|
2023
|
-
|
|
2024
|
-
|
|
2025
|
-
|
|
2026
|
-
|
|
2027
|
-
|
|
2028
|
-
|
|
2029
|
-
|
|
2030
|
-
|
|
2031
|
-
|
|
2032
|
-
|
|
2033
|
-
|
|
2034
|
-
|
|
2035
|
-
childId: string;
|
|
2036
|
-
depth: number;
|
|
2037
|
-
}) => void;
|
|
2038
|
-
'child:tool:error': (ctx: ToolHookContext & {
|
|
2039
|
-
error: Error;
|
|
2040
|
-
childId: string;
|
|
2041
|
-
depth: number;
|
|
2042
|
-
}) => void;
|
|
2043
|
-
'child:turn:after': (ctx: {
|
|
2044
|
-
turn: number;
|
|
2045
|
-
turnId: string;
|
|
2046
|
-
usage: TurnUsage;
|
|
2047
|
-
message: SessionTurn;
|
|
2048
|
-
toolCounts: {
|
|
2049
|
-
turn: Readonly<Record<string, number>>;
|
|
2050
|
-
run: Readonly<Record<string, number>>;
|
|
2051
|
-
};
|
|
2052
|
-
childId: string;
|
|
2053
|
-
depth: number;
|
|
2054
|
-
}) => void;
|
|
2055
|
-
'mcp:connect': (ctx: {
|
|
2056
|
-
name: string;
|
|
2057
|
-
transport: string;
|
|
2058
|
-
tools: string[];
|
|
2059
|
-
}) => void;
|
|
2060
|
-
'mcp:error': (ctx: {
|
|
2061
|
-
name: string;
|
|
2062
|
-
error: Error;
|
|
2063
|
-
}) => void;
|
|
2064
|
-
'mcp:close': (ctx: {
|
|
2065
|
-
name: string;
|
|
2066
|
-
}) => void;
|
|
1959
|
+
depth?: number;
|
|
1960
|
+
}
|
|
1961
|
+
/** Context for stream hooks */
|
|
1962
|
+
interface StreamHookContext {
|
|
1963
|
+
turnId: string;
|
|
1964
|
+
}
|
|
1965
|
+
/** Context for OAuth refresh hooks */
|
|
1966
|
+
interface OAuthRefreshHookContext {
|
|
1967
|
+
provider: string;
|
|
1968
|
+
providerId: string;
|
|
1969
|
+
source: 'params' | 'file';
|
|
1970
|
+
previousCredentials: Record<string, unknown> & {
|
|
1971
|
+
access: string;
|
|
1972
|
+
refresh: string;
|
|
1973
|
+
expires: number;
|
|
1974
|
+
};
|
|
1975
|
+
credentials: Record<string, unknown> & {
|
|
1976
|
+
access: string;
|
|
1977
|
+
refresh: string;
|
|
1978
|
+
expires: number;
|
|
1979
|
+
};
|
|
1980
|
+
}
|
|
1981
|
+
type SessionEndStatus = 'completed' | 'aborted' | 'error';
|
|
1982
|
+
//#endregion
|
|
1983
|
+
//#region src/providers/anthropic.d.ts
|
|
1984
|
+
/**
|
|
1985
|
+
* Server-side context-management config — the body of `context_management` on
|
|
1986
|
+
* the Messages API. Typed loosely (Record-of-unknown) so we don't pin a specific
|
|
1987
|
+
* SDK schema version: the v0.90 SDK does not yet type this field, but the wire
|
|
1988
|
+
* format is stable behind the `context-management-2025-06-27` beta.
|
|
1989
|
+
*
|
|
1990
|
+
* See: https://docs.anthropic.com/en/docs/build-with-claude/context-management
|
|
1991
|
+
*/
|
|
1992
|
+
interface AnthropicContextManagement {
|
|
1993
|
+
edits?: Array<Record<string, unknown>>;
|
|
1994
|
+
[key: string]: unknown;
|
|
1995
|
+
}
|
|
1996
|
+
interface AnthropicParams {
|
|
1997
|
+
apiKey?: string;
|
|
1998
|
+
access?: string;
|
|
1999
|
+
refresh?: string;
|
|
2000
|
+
expires?: number;
|
|
2001
|
+
defaultModel?: string;
|
|
2067
2002
|
/**
|
|
2068
|
-
*
|
|
2069
|
-
*
|
|
2003
|
+
* Optional override for the Anthropic SDK base URL. Honored end-to-end — headers and
|
|
2004
|
+
* routing pass through to the forwarded host. Useful for proxies (e.g. corporate
|
|
2005
|
+
* gateways, internal router).
|
|
2070
2006
|
*/
|
|
2071
|
-
|
|
2072
|
-
name: string;
|
|
2073
|
-
transport: string;
|
|
2074
|
-
}) => void;
|
|
2007
|
+
baseURL?: string;
|
|
2075
2008
|
/**
|
|
2076
|
-
*
|
|
2077
|
-
*
|
|
2078
|
-
*
|
|
2009
|
+
* Additional `anthropic-beta` flags to opt into. Merged with the OAuth-path
|
|
2010
|
+
* defaults (`claude-code-20250219`, `oauth-2025-04-20`); duplicates are
|
|
2011
|
+
* de-duped. Examples:
|
|
2012
|
+
*
|
|
2013
|
+
* - `'context-management-2025-06-27'` — server-side context compaction
|
|
2014
|
+
* (token-accurate; pair with {@link AnthropicParams.contextManagement}).
|
|
2015
|
+
* - `'token-efficient-tools-2026-03-28'` — terser tool_use wire format.
|
|
2016
|
+
* - `'interleaved-thinking-2025-05-14'` — think between tool calls within
|
|
2017
|
+
* one turn.
|
|
2018
|
+
* - `'redact-thinking-2026-02-12'` — replace large thinking blocks with
|
|
2019
|
+
* stubs server-side.
|
|
2020
|
+
* - `'prompt-caching-scope-2026-01-05'` — extended prompt-cache scope.
|
|
2021
|
+
*
|
|
2022
|
+
* Honored on both the OAuth and API-key paths.
|
|
2079
2023
|
*/
|
|
2080
|
-
|
|
2081
|
-
name: string;
|
|
2082
|
-
transport: string;
|
|
2083
|
-
durationMs: number;
|
|
2084
|
-
} & ({
|
|
2085
|
-
ok: true;
|
|
2086
|
-
toolCount: number;
|
|
2087
|
-
} | {
|
|
2088
|
-
ok: false;
|
|
2089
|
-
error: Error;
|
|
2090
|
-
})) => void;
|
|
2024
|
+
extraBetas?: readonly string[];
|
|
2091
2025
|
/**
|
|
2092
|
-
*
|
|
2093
|
-
*
|
|
2094
|
-
*
|
|
2095
|
-
* reordering, or replacing entries — to further narrow what the model sees.
|
|
2026
|
+
* Server-side context-management directive. Sent on the request body as
|
|
2027
|
+
* `context_management`. Requires the `context-management-2025-06-27` beta —
|
|
2028
|
+
* add it to {@link AnthropicParams.extraBetas}.
|
|
2096
2029
|
*
|
|
2097
|
-
*
|
|
2098
|
-
*
|
|
2099
|
-
* environment, or capability-driven decisions that the config can't express.
|
|
2030
|
+
* Typed loosely so future Anthropic schema additions land without an SDK
|
|
2031
|
+
* bump. A typical compaction edit:
|
|
2100
2032
|
*
|
|
2101
|
-
*
|
|
2033
|
+
* ```ts
|
|
2034
|
+
* contextManagement: {
|
|
2035
|
+
* edits: [{
|
|
2036
|
+
* type: 'clear_tool_uses_20250919',
|
|
2037
|
+
* trigger: { type: 'input_tokens', value: 180_000 },
|
|
2038
|
+
* clear_at_least: { type: 'input_tokens', value: 140_000 },
|
|
2039
|
+
* clear_tool_inputs: ['Read', 'Bash', 'Grep'],
|
|
2040
|
+
* }],
|
|
2041
|
+
* }
|
|
2042
|
+
* ```
|
|
2102
2043
|
*/
|
|
2103
|
-
|
|
2104
|
-
server: string;
|
|
2105
|
-
transport: 'stdio' | 'sse' | 'streamable-http';
|
|
2106
|
-
tools: Array<{
|
|
2107
|
-
name: string;
|
|
2108
|
-
description?: string | null;
|
|
2109
|
-
inputSchema?: unknown;
|
|
2110
|
-
}>;
|
|
2111
|
-
}) => void;
|
|
2044
|
+
contextManagement?: AnthropicContextManagement;
|
|
2112
2045
|
/**
|
|
2113
|
-
*
|
|
2114
|
-
*
|
|
2115
|
-
*
|
|
2046
|
+
* Generic pass-through for fields on the Messages API request body that the
|
|
2047
|
+
* SDK does not yet type. Spread into the request before the typed fields,
|
|
2048
|
+
* so explicit options ({@link AnthropicParams.contextManagement} and the
|
|
2049
|
+
* built-in fields like `model` / `tools` / `messages`) win on collision.
|
|
2116
2050
|
*
|
|
2117
|
-
*
|
|
2118
|
-
*
|
|
2119
|
-
*
|
|
2120
|
-
*
|
|
2121
|
-
* `tool:gate` for budget / dedup logic; reserve `mcp:tool:gate` for
|
|
2122
|
-
* MCP-specific concerns (per-server routing, transport-aware refusals).
|
|
2051
|
+
* Forward-compat escape hatch for new Anthropic betas — when a future flag
|
|
2052
|
+
* ships before zidane has a dedicated typed knob, set it here without
|
|
2053
|
+
* waiting on a release. Most fields will still need the matching beta in
|
|
2054
|
+
* {@link AnthropicParams.extraBetas}.
|
|
2123
2055
|
*/
|
|
2124
|
-
|
|
2125
|
-
|
|
2126
|
-
|
|
2127
|
-
|
|
2128
|
-
|
|
2129
|
-
|
|
2130
|
-
|
|
2131
|
-
|
|
2132
|
-
outputBytes: number;
|
|
2133
|
-
}) => void;
|
|
2134
|
-
'mcp:tool:transform': (ctx: McpToolHookContext & {
|
|
2135
|
-
result: string | ToolResultContent[];
|
|
2136
|
-
outputBytes: number;
|
|
2137
|
-
}) => void;
|
|
2138
|
-
'mcp:tool:error': (ctx: McpToolHookContext & {
|
|
2139
|
-
error: Error;
|
|
2140
|
-
}) => void;
|
|
2141
|
-
'skills:resolve': (ctx: {
|
|
2142
|
-
skills: SkillConfig[];
|
|
2143
|
-
}) => void;
|
|
2144
|
-
'skills:catalog': (ctx: {
|
|
2145
|
-
catalog: string;
|
|
2146
|
-
skills: SkillConfig[];
|
|
2147
|
-
}) => void;
|
|
2148
|
-
'skills:activate': (ctx: {
|
|
2149
|
-
skill: SkillConfig;
|
|
2150
|
-
via: ActivationVia;
|
|
2151
|
-
}) => void;
|
|
2152
|
-
'skills:deactivate': (ctx: {
|
|
2153
|
-
skill: SkillConfig;
|
|
2154
|
-
reason: DeactivationReason;
|
|
2155
|
-
}) => void;
|
|
2156
|
-
'usage': (ctx: {
|
|
2157
|
-
turn: number;
|
|
2158
|
-
turnId: string;
|
|
2159
|
-
usage: TurnUsage;
|
|
2160
|
-
totalIn: number;
|
|
2161
|
-
totalOut: number;
|
|
2162
|
-
}) => void;
|
|
2163
|
-
'output': (ctx: {
|
|
2164
|
-
output: Record<string, unknown>;
|
|
2165
|
-
schema: Record<string, unknown>;
|
|
2166
|
-
}) => void;
|
|
2056
|
+
extraBodyParams?: Record<string, unknown>;
|
|
2057
|
+
}
|
|
2058
|
+
declare function anthropic(anthropicParams?: AnthropicParams): Provider;
|
|
2059
|
+
//#endregion
|
|
2060
|
+
//#region src/providers/cerebras.d.ts
|
|
2061
|
+
interface CerebrasParams {
|
|
2062
|
+
apiKey?: string;
|
|
2063
|
+
defaultModel?: string;
|
|
2167
2064
|
/**
|
|
2168
|
-
*
|
|
2169
|
-
*
|
|
2170
|
-
*
|
|
2065
|
+
* Provider capability flags. Cerebras currently serves text-only OSS models
|
|
2066
|
+
* (GLM, Llama-family, Qwen-family) — default: `{ vision: false, imageInToolResult: false }`.
|
|
2067
|
+
* Override when routing to a vision-capable deployment.
|
|
2171
2068
|
*/
|
|
2172
|
-
|
|
2173
|
-
|
|
2174
|
-
|
|
2175
|
-
|
|
2176
|
-
|
|
2177
|
-
|
|
2069
|
+
capabilities?: ProviderCapabilities;
|
|
2070
|
+
}
|
|
2071
|
+
/**
|
|
2072
|
+
* Cerebras provider.
|
|
2073
|
+
*
|
|
2074
|
+
* Thin wrapper around {@link openaiCompat} with Cerebras-specific defaults
|
|
2075
|
+
* (base URL, default model).
|
|
2076
|
+
*/
|
|
2077
|
+
declare function cerebras(params?: CerebrasParams): Provider;
|
|
2078
|
+
//#endregion
|
|
2079
|
+
//#region src/providers/openai.d.ts
|
|
2080
|
+
interface OpenAIParams {
|
|
2081
|
+
/** OpenAI Codex OAuth access token. Falls back to OPENAI_CODEX_API_KEY and .credentials.json. */
|
|
2082
|
+
apiKey?: string;
|
|
2083
|
+
/** Alias for apiKey, matching the OAuth credential field. */
|
|
2084
|
+
access?: string;
|
|
2085
|
+
refresh?: string;
|
|
2086
|
+
expires?: number;
|
|
2087
|
+
accountId?: string;
|
|
2088
|
+
defaultModel?: string;
|
|
2089
|
+
transport?: 'sse' | 'websocket' | 'auto';
|
|
2090
|
+
}
|
|
2091
|
+
declare function openai(params?: OpenAIParams): Provider;
|
|
2092
|
+
//#endregion
|
|
2093
|
+
//#region src/providers/openai-compat.d.ts
|
|
2094
|
+
/**
|
|
2095
|
+
* HTTP error thrown when an OpenAI-compatible endpoint returns a non-OK response.
|
|
2096
|
+
*
|
|
2097
|
+
* The body is best-effort JSON-parsed; `error.message` / `error.code` / `error.type`
|
|
2098
|
+
* are extracted for clean downstream classification.
|
|
2099
|
+
*/
|
|
2100
|
+
declare class OpenAICompatHttpError extends Error {
|
|
2101
|
+
readonly status: number;
|
|
2102
|
+
readonly providerCode?: string;
|
|
2103
|
+
readonly bodyText: string;
|
|
2104
|
+
constructor(status: number, bodyText: string);
|
|
2105
|
+
}
|
|
2106
|
+
/**
|
|
2107
|
+
* Classify an OpenAI-compatible error into `ClassifiedError`.
|
|
2108
|
+
*
|
|
2109
|
+
* Recognizes:
|
|
2110
|
+
* - `AbortError` (from fetch) → `aborted`.
|
|
2111
|
+
* - `OpenAICompatHttpError` with a context-exceeded code or message → `context_exceeded`.
|
|
2112
|
+
* - Any other `OpenAICompatHttpError` → `provider_error`.
|
|
2113
|
+
*
|
|
2114
|
+
* Returns `null` for unrecognized error shapes (the loop falls back to `AgentProviderError`).
|
|
2115
|
+
*/
|
|
2116
|
+
declare function classifyOpenAICompatError(err: unknown): ClassifiedError | null;
|
|
2117
|
+
/**
|
|
2118
|
+
* Map an OpenAI-compatible `finish_reason` string to the zidane `TurnFinishReason` union.
|
|
2119
|
+
*/
|
|
2120
|
+
declare function mapOAIFinishReason(reason: string | null | undefined): TurnFinishReason | undefined;
|
|
2121
|
+
/**
|
|
2122
|
+
* Auth header config. `scheme` is prepended to the api key with a space, e.g.
|
|
2123
|
+
* `{ name: 'Authorization', scheme: 'Bearer' }` → `Authorization: Bearer <key>`.
|
|
2124
|
+
* Omit `scheme` for raw header values (e.g. `{ name: 'X-Api-Key' }` → `X-Api-Key: <key>`).
|
|
2125
|
+
*
|
|
2126
|
+
* Real-world examples:
|
|
2127
|
+
* - Default OpenAI / OpenRouter / Cerebras: `{ name: 'Authorization', scheme: 'Bearer' }`.
|
|
2128
|
+
* - Baseten: `{ name: 'Authorization', scheme: 'Api-Key' }`.
|
|
2129
|
+
* - Some gateways: `{ name: 'X-Api-Key' }`.
|
|
2130
|
+
*/
|
|
2131
|
+
interface OpenAICompatAuthHeader {
|
|
2132
|
+
name: string;
|
|
2133
|
+
scheme?: string;
|
|
2134
|
+
}
|
|
2135
|
+
interface OpenAICompatParams {
|
|
2136
|
+
/** Bearer-style API key. */
|
|
2137
|
+
apiKey: string;
|
|
2138
|
+
/** Base URL — `/chat/completions` is appended. */
|
|
2139
|
+
baseURL: string;
|
|
2140
|
+
/** Default model id when `run({ model })` is omitted. */
|
|
2141
|
+
defaultModel?: string;
|
|
2142
|
+
/** Provider name exposed as `Provider.name`. Defaults to `'openai-compat'`. */
|
|
2143
|
+
name?: string;
|
|
2144
|
+
/** Auth header shape. Defaults to `{ name: 'Authorization', scheme: 'Bearer' }`. */
|
|
2145
|
+
authHeader?: OpenAICompatAuthHeader;
|
|
2146
|
+
/** Extra headers sent with every request (e.g. referer, user-agent). */
|
|
2147
|
+
extraHeaders?: Record<string, string>;
|
|
2178
2148
|
/**
|
|
2179
|
-
*
|
|
2180
|
-
*
|
|
2181
|
-
*
|
|
2182
|
-
* refuses the call outright with `Blocked: <message>`.
|
|
2149
|
+
* Provider-level capability flags. Routed into the message shaper and the
|
|
2150
|
+
* agent loop so images in tool results + user messages are handled correctly
|
|
2151
|
+
* for the underlying model.
|
|
2183
2152
|
*
|
|
2184
|
-
*
|
|
2185
|
-
*
|
|
2186
|
-
*
|
|
2187
|
-
*
|
|
2153
|
+
* Defaults when omitted: `vision: false`, `imageInToolResult: false` — a
|
|
2154
|
+
* conservative assumption matching most OSS text-only OpenAI-compat
|
|
2155
|
+
* endpoints. Override when routing to a known vision-capable endpoint
|
|
2156
|
+
* (e.g. OpenRouter vision models, Baseten image-capable deployments).
|
|
2188
2157
|
*/
|
|
2189
|
-
|
|
2190
|
-
tool: string;
|
|
2191
|
-
count: number;
|
|
2192
|
-
max: number;
|
|
2193
|
-
turnId: string;
|
|
2194
|
-
mode: 'steer' | 'block';
|
|
2195
|
-
}) => void;
|
|
2196
|
-
'agent:abort': (ctx: object) => void;
|
|
2158
|
+
capabilities?: ProviderCapabilities;
|
|
2197
2159
|
/**
|
|
2198
|
-
*
|
|
2160
|
+
* Whether this endpoint honors `cache_control: { type: 'ephemeral' }` markers
|
|
2161
|
+
* on message content parts and tool definitions.
|
|
2199
2162
|
*
|
|
2200
|
-
*
|
|
2201
|
-
*
|
|
2202
|
-
*
|
|
2203
|
-
*
|
|
2204
|
-
*
|
|
2163
|
+
* - `true` — inject markers when the caller asks for caching. OpenRouter routes
|
|
2164
|
+
* to Anthropic/Gemini forward the markers; routes to OpenAI/DeepSeek/
|
|
2165
|
+
* Grok/Groq/Moonshot ignore them (those backends cache automatically).
|
|
2166
|
+
* - `false` — never inject markers. Safe default for endpoints that strictly
|
|
2167
|
+
* validate the request schema (OpenAI direct, most OSS inference
|
|
2168
|
+
* servers) and would reject unknown fields.
|
|
2169
|
+
*
|
|
2170
|
+
* Default: `false`. The `openrouter` wrapper sets this to `true`.
|
|
2205
2171
|
*/
|
|
2206
|
-
|
|
2207
|
-
'session:start': (ctx: SessionHookContext & {
|
|
2208
|
-
runId: string;
|
|
2209
|
-
prompt: string;
|
|
2210
|
-
}) => void;
|
|
2211
|
-
'session:end': (ctx: SessionHookContext & {
|
|
2212
|
-
runId: string;
|
|
2213
|
-
status: SessionEndStatus;
|
|
2214
|
-
turnRange: [number, number];
|
|
2215
|
-
}) => void;
|
|
2216
|
-
'session:turns': (ctx: SessionHookContext & {
|
|
2217
|
-
turns: SessionTurn[];
|
|
2218
|
-
count: number;
|
|
2219
|
-
}) => void;
|
|
2220
|
-
'session:meta': (ctx: SessionHookContext & {
|
|
2221
|
-
key: string;
|
|
2222
|
-
value: unknown;
|
|
2223
|
-
}) => void;
|
|
2224
|
-
'session:save': (ctx: SessionHookContext) => void;
|
|
2225
|
-
}
|
|
2226
|
-
interface AgentOptions {
|
|
2227
|
-
provider: Provider;
|
|
2228
|
-
/** Display name for the agent (used in traces/logs). */
|
|
2229
|
-
name?: string;
|
|
2230
|
-
/** Default system prompt injected when no system is provided at run time. */
|
|
2231
|
-
system?: string;
|
|
2232
|
-
/** Tool definitions available to the agent. Defaults to no tools. */
|
|
2233
|
-
tools?: Record<string, ToolDef>;
|
|
2172
|
+
cacheBreakpoints?: boolean;
|
|
2234
2173
|
/**
|
|
2235
|
-
*
|
|
2174
|
+
* Whether this endpoint speaks OpenRouter's normalized reasoning envelope —
|
|
2175
|
+
* `reasoning: { effort | max_tokens | exclude }` on requests and structured
|
|
2176
|
+
* `reasoning_details[]` on assistant messages, round-tripped to preserve
|
|
2177
|
+
* extended-reasoning state across turns.
|
|
2236
2178
|
*
|
|
2237
|
-
*
|
|
2238
|
-
*
|
|
2239
|
-
*
|
|
2179
|
+
* - `true` — map zidane's `behavior.thinking` / `behavior.thinkingBudget` to
|
|
2180
|
+
* the request's `reasoning` field, capture `reasoning_details`
|
|
2181
|
+
* from streaming responses into `provider_reasoning` blocks, and
|
|
2182
|
+
* echo them back on subsequent assistant messages.
|
|
2183
|
+
* - `false` — never set the field; drop any stored `provider_reasoning`
|
|
2184
|
+
* blocks before sending. Safe default for hosts that strict-
|
|
2185
|
+
* validate the request schema.
|
|
2186
|
+
*
|
|
2187
|
+
* Default: `false`. The `openrouter` wrapper sets this to `true`.
|
|
2240
2188
|
*/
|
|
2241
|
-
|
|
2242
|
-
/** Agent-level behavior defaults (overridden by run-level behavior) */
|
|
2243
|
-
behavior?: AgentBehavior;
|
|
2244
|
-
/** Execution context: where tools run. Defaults to in-process. */
|
|
2245
|
-
execution?: ExecutionContext;
|
|
2246
|
-
/** MCP servers to connect and expose as tools */
|
|
2247
|
-
mcpServers?: McpServerConfig[];
|
|
2248
|
-
/** Session for identity, turn persistence, and run tracking */
|
|
2249
|
-
session?: Session;
|
|
2250
|
-
/** Skills configuration */
|
|
2251
|
-
skills?: SkillsConfig;
|
|
2189
|
+
supportsReasoning?: boolean;
|
|
2252
2190
|
/**
|
|
2253
|
-
*
|
|
2254
|
-
*
|
|
2255
|
-
*
|
|
2256
|
-
*
|
|
2191
|
+
* Generic pass-through for fields on the Chat Completions request body that
|
|
2192
|
+
* zidane does not yet type. Spread into the request before the typed core
|
|
2193
|
+
* (model / messages / tools / max_tokens / stream / tool_choice), so
|
|
2194
|
+
* explicit options always win on collision.
|
|
2257
2195
|
*
|
|
2258
|
-
*
|
|
2196
|
+
* Forward-compat escape hatch for endpoints that ship one-off fields ahead
|
|
2197
|
+
* of zidane (e.g. OpenAI `reasoning_effort`, OpenRouter `provider` routing,
|
|
2198
|
+
* vendor-specific `safety_level` knobs).
|
|
2259
2199
|
*/
|
|
2260
|
-
|
|
2200
|
+
extraBodyParams?: Record<string, unknown>;
|
|
2201
|
+
}
|
|
2202
|
+
/**
|
|
2203
|
+
* Factory for any OpenAI-compatible HTTP endpoint.
|
|
2204
|
+
*
|
|
2205
|
+
* Speaks the standard `POST /chat/completions` + `stream: true` + SSE dialect.
|
|
2206
|
+
* Thin wrappers (`openrouter`, `cerebras`) call this with pinned defaults.
|
|
2207
|
+
*
|
|
2208
|
+
* @example Baseten (non-standard auth scheme)
|
|
2209
|
+
* ```ts
|
|
2210
|
+
* openaiCompat({
|
|
2211
|
+
* name: 'baseten',
|
|
2212
|
+
* apiKey: process.env.BASETEN_API_KEY!,
|
|
2213
|
+
* baseURL: process.env.BASETEN_PROXY_URL!,
|
|
2214
|
+
* authHeader: { name: 'Authorization', scheme: 'Api-Key' },
|
|
2215
|
+
* })
|
|
2216
|
+
* ```
|
|
2217
|
+
*/
|
|
2218
|
+
declare function openaiCompat(params: OpenAICompatParams): Provider;
|
|
2219
|
+
//#endregion
|
|
2220
|
+
//#region src/providers/openrouter.d.ts
|
|
2221
|
+
interface OpenRouterParams {
|
|
2222
|
+
apiKey?: string;
|
|
2223
|
+
defaultModel?: string;
|
|
2261
2224
|
/**
|
|
2262
|
-
*
|
|
2263
|
-
*
|
|
2264
|
-
*
|
|
2265
|
-
*
|
|
2266
|
-
*
|
|
2267
|
-
* behind other setup work. If bootstrap fails, the error is stored and
|
|
2268
|
-
* surfaced on the first `agent.run()` / `agent.warmup()`; the in-flight
|
|
2269
|
-
* promise is `await`ed by both paths so the error is never silently lost.
|
|
2225
|
+
* Provider capability flags. OpenRouter itself is a router — whether vision or
|
|
2226
|
+
* native image-in-tool-result are supported depends on the downstream model.
|
|
2227
|
+
* Default: `{ vision: true, imageInToolResult: false }` — matches the default
|
|
2228
|
+
* `anthropic/claude-sonnet-4-6` model (vision-capable via companion user-message
|
|
2229
|
+
* fallback since OpenRouter exposes Claude over the Chat Completions dialect).
|
|
2270
2230
|
*
|
|
2271
|
-
*
|
|
2231
|
+
* Override when routing to a known-text-only model (e.g. `meta-llama/llama-3-8b-instruct`).
|
|
2272
2232
|
*/
|
|
2273
|
-
|
|
2233
|
+
capabilities?: ProviderCapabilities;
|
|
2274
2234
|
}
|
|
2275
|
-
|
|
2276
|
-
|
|
2277
|
-
|
|
2278
|
-
|
|
2279
|
-
|
|
2280
|
-
|
|
2281
|
-
|
|
2235
|
+
/**
|
|
2236
|
+
* OpenRouter provider.
|
|
2237
|
+
*
|
|
2238
|
+
* Thin wrapper around {@link openaiCompat} with OpenRouter-specific defaults
|
|
2239
|
+
* (base URL, default model) and required attribution headers.
|
|
2240
|
+
*/
|
|
2241
|
+
declare function openrouter(params?: OpenRouterParams): Provider;
|
|
2242
|
+
//#endregion
|
|
2243
|
+
//#region src/providers/index.d.ts
|
|
2244
|
+
interface ToolSpec {
|
|
2245
|
+
name: string;
|
|
2246
|
+
description: string;
|
|
2247
|
+
inputSchema: Record<string, unknown>;
|
|
2248
|
+
}
|
|
2249
|
+
interface ToolCall {
|
|
2250
|
+
id: string;
|
|
2251
|
+
name: string;
|
|
2252
|
+
input: Record<string, unknown>;
|
|
2253
|
+
}
|
|
2254
|
+
interface ToolResult {
|
|
2255
|
+
id: string;
|
|
2282
2256
|
/**
|
|
2283
|
-
*
|
|
2284
|
-
*
|
|
2285
|
-
*
|
|
2257
|
+
* Tool output — plain string for text-only tools (the common case) or a structured
|
|
2258
|
+
* array of content blocks for tools that return images or mixed content (e.g. an
|
|
2259
|
+
* MCP browser server returning a screenshot).
|
|
2260
|
+
*
|
|
2261
|
+
* Use `toolResultToText(content)` when a downstream consumer only handles strings.
|
|
2286
2262
|
*/
|
|
2287
|
-
|
|
2263
|
+
content: string | ToolResultContent[];
|
|
2264
|
+
}
|
|
2265
|
+
/**
|
|
2266
|
+
* Provider-level capability flags used by the agent loop to route tool results
|
|
2267
|
+
* and user messages appropriately.
|
|
2268
|
+
*
|
|
2269
|
+
* When a flag is `undefined` (omitted), the loop applies the conservative
|
|
2270
|
+
* text-only default — images are stripped and replaced with a text marker so
|
|
2271
|
+
* non-vision models do not confabulate about content they cannot see.
|
|
2272
|
+
*/
|
|
2273
|
+
interface ProviderCapabilities {
|
|
2288
2274
|
/**
|
|
2289
|
-
*
|
|
2290
|
-
*
|
|
2275
|
+
* Model accepts image input anywhere (user messages and tool results).
|
|
2276
|
+
*
|
|
2277
|
+
* When `false`, the loop replaces image blocks with
|
|
2278
|
+
* `"[image omitted — model does not support vision]"` before they reach the provider.
|
|
2279
|
+
* Gives the model an honest marker instead of letting JSON-stringified base64 slip
|
|
2280
|
+
* through and get confabulated over.
|
|
2291
2281
|
*/
|
|
2292
|
-
|
|
2282
|
+
vision?: boolean;
|
|
2293
2283
|
/**
|
|
2294
|
-
*
|
|
2295
|
-
* `
|
|
2296
|
-
*
|
|
2297
|
-
*
|
|
2284
|
+
* Provider wire format embeds images inside tool-role messages natively
|
|
2285
|
+
* (Anthropic `tool_result.content` arrays, OpenAI Codex pi-ai `toolResult` blocks).
|
|
2286
|
+
*
|
|
2287
|
+
* When `false`, a vision-capable provider still gets images — but via a
|
|
2288
|
+
* companion `user` message emitted immediately after the flattened
|
|
2289
|
+
* `tool`/`tool_result` marker. This is the Claude Desktop / Cline pattern
|
|
2290
|
+
* and works on any OpenAI Chat Completions endpoint that accepts image
|
|
2291
|
+
* URLs in user messages.
|
|
2298
2292
|
*/
|
|
2299
|
-
|
|
2293
|
+
imageInToolResult?: boolean;
|
|
2294
|
+
}
|
|
2295
|
+
interface StreamCallbacks {
|
|
2296
|
+
onText: (delta: string) => void;
|
|
2297
|
+
onThinking?: (delta: string) => void;
|
|
2298
|
+
onOAuthRefresh?: (ctx: OAuthRefreshHookContext) => void | Promise<void>;
|
|
2299
|
+
}
|
|
2300
|
+
interface TurnResult {
|
|
2301
|
+
/** Full assistant turn as a SessionMessage */
|
|
2302
|
+
assistantMessage: SessionMessage;
|
|
2303
|
+
/** Text content blocks concatenated */
|
|
2304
|
+
text: string;
|
|
2305
|
+
/** Tool calls requested by the model */
|
|
2306
|
+
toolCalls: ToolCall[];
|
|
2307
|
+
/** Whether the model wants to stop */
|
|
2308
|
+
done: boolean;
|
|
2309
|
+
usage: TurnUsage;
|
|
2310
|
+
}
|
|
2311
|
+
interface StreamOptions {
|
|
2312
|
+
model: string;
|
|
2313
|
+
system: string;
|
|
2314
|
+
tools: unknown[];
|
|
2315
|
+
messages: SessionMessage[];
|
|
2316
|
+
maxTokens: number;
|
|
2317
|
+
/** Thinking/reasoning level (optional, default: off) */
|
|
2318
|
+
thinking?: ThinkingLevel;
|
|
2319
|
+
/** Exact thinking token budget — overrides the level-based default when set */
|
|
2320
|
+
thinkingBudget?: number;
|
|
2321
|
+
/** Force tool selection behavior */
|
|
2322
|
+
toolChoice?: {
|
|
2323
|
+
type: 'auto' | 'required' | 'tool';
|
|
2324
|
+
name?: string;
|
|
2325
|
+
};
|
|
2300
2326
|
/**
|
|
2301
|
-
*
|
|
2302
|
-
*
|
|
2327
|
+
* Enable prompt caching on this call. When `true`, providers that support it
|
|
2328
|
+
* insert `cache_control` breakpoints on the system prompt, last tool, and
|
|
2329
|
+
* last stable message so the shared prefix is cached across turns.
|
|
2330
|
+
*
|
|
2331
|
+
* Default: `false` (providers opt callers in — the agent loop passes `true`).
|
|
2303
2332
|
*/
|
|
2304
|
-
|
|
2333
|
+
cache?: boolean;
|
|
2334
|
+
/** Abort signal for cancellation */
|
|
2335
|
+
signal?: AbortSignal;
|
|
2336
|
+
}
|
|
2337
|
+
interface Provider {
|
|
2338
|
+
readonly name: string;
|
|
2339
|
+
readonly meta: {
|
|
2340
|
+
defaultModel: string; /** Provider-level capability flags. See {@link ProviderCapabilities}. */
|
|
2341
|
+
capabilities?: ProviderCapabilities;
|
|
2342
|
+
} & Record<string, unknown>;
|
|
2343
|
+
/** Format tool specs for this provider */
|
|
2344
|
+
formatTools: (tools: ToolSpec[]) => unknown[];
|
|
2345
|
+
/** Create a text-only user message. Multimodal content goes through `promptMessage`. */
|
|
2346
|
+
userMessage: (content: string) => SessionMessage;
|
|
2347
|
+
/** Create an assistant message (for priming) */
|
|
2348
|
+
assistantMessage: (content: string) => SessionMessage;
|
|
2349
|
+
/** Create a tool results message to send back */
|
|
2350
|
+
toolResultsMessage: (results: ToolResult[]) => SessionMessage;
|
|
2351
|
+
/** Stream a turn, calling onText for each text delta */
|
|
2352
|
+
stream: (options: StreamOptions, callbacks: StreamCallbacks) => Promise<TurnResult>;
|
|
2305
2353
|
/**
|
|
2306
|
-
*
|
|
2307
|
-
* - No MCP servers configured → resolves immediately.
|
|
2308
|
-
* - Connection already established → resolves immediately.
|
|
2309
|
-
* - Another `warmup()` / `run()` is bootstrapping → awaits the in-flight promise.
|
|
2354
|
+
* Build a user `SessionMessage` from multimodal prompt parts.
|
|
2310
2355
|
*
|
|
2311
|
-
*
|
|
2312
|
-
*
|
|
2313
|
-
*
|
|
2356
|
+
* Providers that cannot handle a particular part type (e.g. document) should throw.
|
|
2357
|
+
* The agent loop always canonicalizes the run-level prompt into parts before calling
|
|
2358
|
+
* this method; providers may fall back to `userMessage` for the text-only path if
|
|
2359
|
+
* they do not implement this.
|
|
2314
2360
|
*/
|
|
2315
|
-
|
|
2316
|
-
readonly isRunning: boolean;
|
|
2317
|
-
readonly turns: SessionTurn[];
|
|
2318
|
-
readonly execution: ExecutionContext;
|
|
2319
|
-
readonly handle: ExecutionHandle | null;
|
|
2320
|
-
readonly session: Session | null;
|
|
2321
|
-
/** Snapshot of currently active skills. */
|
|
2322
|
-
readonly activeSkills: readonly ActiveSkill[];
|
|
2361
|
+
promptMessage?: (parts: PromptPart[]) => SessionMessage;
|
|
2323
2362
|
/**
|
|
2324
|
-
*
|
|
2325
|
-
*
|
|
2326
|
-
*
|
|
2327
|
-
*
|
|
2363
|
+
* Classify a native provider error for downstream typed-error wrapping.
|
|
2364
|
+
*
|
|
2365
|
+
* Return `null` when the error is not recognized — the loop will wrap it in
|
|
2366
|
+
* `AgentProviderError` with the provider's name. Return a `ClassifiedError` to
|
|
2367
|
+
* route it to one of the typed error classes.
|
|
2328
2368
|
*/
|
|
2329
|
-
|
|
2369
|
+
classifyError?: (err: unknown) => ClassifiedError | null;
|
|
2330
2370
|
}
|
|
2331
|
-
declare function createAgent({
|
|
2332
|
-
provider,
|
|
2333
|
-
name: agentName,
|
|
2334
|
-
system: agentSystem,
|
|
2335
|
-
tools: agentTools,
|
|
2336
|
-
toolAliases,
|
|
2337
|
-
behavior: agentBehavior,
|
|
2338
|
-
execution,
|
|
2339
|
-
mcpServers,
|
|
2340
|
-
session,
|
|
2341
|
-
skills: agentSkills,
|
|
2342
|
-
mcpConnector,
|
|
2343
|
-
eager
|
|
2344
|
-
}: AgentOptions): Agent;
|
|
2345
2371
|
//#endregion
|
|
2346
|
-
export {
|
|
2347
|
-
//# sourceMappingURL=
|
|
2372
|
+
export { ToolDef as $, PromptDocumentPart as A, createMemoryStore as At, SpawnHookContext as B, AgentContextExceededError as Bt, AgentBehavior as C, RemoteStoreOptions as Ct, McpServerConfig as D, fromOpenAI as Dt, ChildRunStats as E, fromAnthropic as Et, SessionContentBlock as F, connectMcpServers as Ft, ToolResultContent as G, ClassifiedErrorKind as Gt, ThinkingLevel as H, AgentToolNotAllowedError as Ht, SessionEndStatus as I, normalizeMcpBlocks as It, TurnFinishReason as J, ToolResultImageContent as K, matchesContextExceeded as Kt, SessionHookContext as L, normalizeMcpServers as Lt, PromptPart as M, FileMapStoreOptions as Mt, PromptTextPart as N, createFileMapStore as Nt, McpToolHookContext as O, toAnthropic as Ot, RunHookMap as P, McpConnection as Pt, ToolContext as Q, SessionMessage as R, resultToString as Rt, anthropic as S, loadSession as St, AgentStats as T, autoDetectAndConvert as Tt, ToolExecutionMode as U, CONTEXT_EXCEEDED_MESSAGE_PATTERNS as Ut, StreamHookContext as V, AgentProviderError as Vt, ToolHookContext as W, ClassifiedError as Wt, toolOutputByteLength as X, TurnUsage as Y, toolResultToText as Z, OpenAIParams as _, Session as _t, ToolCall as a, ActivationVia as at, cerebras as b, SessionStore as bt, TurnResult as c, SkillActivationState as ct, OpenAICompatAuthHeader as d, SkillConfig as dt, ToolMap as et, OpenAICompatHttpError as f, SkillDiagnostic as ft, openaiCompat as g, CreateSessionOptions as gt, mapOAIFinishReason as h, SkillsConfig as ht, StreamOptions as i, createAgent as it, PromptImagePart as j, FileMapAdapter as jt, OAuthRefreshHookContext as k, toOpenAI as kt, OpenRouterParams as l, SkillActivationStateOptions as lt, classifyOpenAICompatError as m, SkillSource as mt, ProviderCapabilities as n, AgentHooks as nt, ToolResult as o, ActiveSkill as ot, OpenAICompatParams as p, SkillResource as pt, ToolResultTextContent as q, toTypedError as qt, StreamCallbacks as r, AgentOptions as rt, ToolSpec as s, DeactivationReason as st, Provider as t, Agent as tt, openrouter as u, createSkillActivationState as ut, openai as v, SessionData as vt, AgentRunOptions as w, createRemoteStore as wt, AnthropicParams as x, createSession as xt, CerebrasParams as y, SessionRun as yt, SessionTurn as z, AgentAbortedError as zt };
|
|
2373
|
+
//# sourceMappingURL=index-bgh-k8Mv.d.ts.map
|