@anthropic-ai/claude-agent-sdk 0.3.324 → 0.3.326
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/README.md +1 -1
- package/bridge.mjs +96 -96
- package/browser-sdk.d.ts +7 -0
- package/browser-sdk.js +73 -71
- package/core-2h2qc9qv.mjs +18 -0
- package/core-9sxfsmzx.mjs +18 -0
- package/{core-qe0dk8na.mjs → core-ba5rrckm.mjs} +2 -2
- package/core-dnsvg8nc.mjs +53 -0
- package/{core-hjrk2537.mjs → core-h6r54bwv.mjs} +2 -2
- package/core-k67vj6j9.mjs +20 -0
- package/core-qbjntcdf.mjs +18 -0
- package/core-qj4dtgyt.mjs +17 -0
- package/core-rn7tc54w.mjs +17 -0
- package/core-sstebd83.mjs +18 -0
- package/core-td7rt8zt.mjs +17 -0
- package/{core-mjr5v0tc.mjs → core-tf03rfab.mjs} +3 -3
- package/core-x4kwpwv9.mjs +16 -0
- package/core-y6bhrwmk.mjs +47 -0
- package/{core-nbx2rjdx.mjs → core-ya1m7gzj.mjs} +3 -3
- package/core.d.ts +1 -0
- package/core.mjs +11 -11
- package/manifest.json +22 -22
- package/manifest.zst.json +26 -26
- package/package.json +25 -21
- package/sdk-tools.d.ts +7 -6
- package/sdk.d.ts +175 -123
- package/sdk.mjs +88 -85
- package/core-4tdxk2rb.mjs +0 -16
- package/core-7sc5aw3j.mjs +0 -17
- package/core-de9edyhn.mjs +0 -19
- package/core-dtdat34e.mjs +0 -45
- package/core-qkncpzfw.mjs +0 -42
- package/core-s4as5f4b.mjs +0 -18
- package/core-ttsjec9g.mjs +0 -17
package/sdk.d.ts
CHANGED
|
@@ -226,7 +226,7 @@ export declare type BaseOutputFormat = {
|
|
|
226
226
|
*
|
|
227
227
|
* @alpha
|
|
228
228
|
*/
|
|
229
|
-
export declare const BUILTIN_TOOL_NAMES: readonly ['Agent', 'Artifact', 'AskUserQuestion', 'Bash', 'ClaudeDesign', 'CronCreate', 'CronDelete', 'CronList', 'Edit', 'EndConversation', 'EnterPlanMode', 'EnterWorktree', 'ExitPlanMode', 'ExitWorktree', 'Glob', 'Grep', 'ListAgents', 'ListMcpResourcesTool', 'LSP', 'Monitor', 'NotebookEdit', 'OfferChromeSetup', 'PowerShell', 'Projects', 'propose_skills', '
|
|
229
|
+
export declare const BUILTIN_TOOL_NAMES: readonly ['Agent', 'Artifact', 'AskUserQuestion', 'Bash', 'ClaudeDesign', 'CronCreate', 'CronDelete', 'CronList', 'Edit', 'EndConversation', 'EnterPlanMode', 'EnterWorktree', 'ExitPlanMode', 'ExitWorktree', 'Glob', 'Grep', 'ListAgents', 'ListMcpResourcesTool', 'LSP', 'Monitor', 'NotebookEdit', 'OfferChromeSetup', 'PowerShell', 'Projects', 'propose_skills', 'PushNotification', 'Read', 'ReadMcpResourceDirTool', 'ReadMcpResourceTool', 'ReadNotifications', 'RemoteTrigger', 'ReportFindings', 'ScheduleWakeup', 'SendFeedback', 'SendMessage', 'SendUserFile', 'SendUserMessage', 'SetGoal', 'ShareOnboardingGuide', 'ShowOnboardingRolePicker', 'Skill', 'SubagentHandback', 'TaskCreate', 'TaskGet', 'TaskList', 'TaskStop', 'TaskUpdate', 'TodoWrite', 'ToolSearch', 'WaitForMcpServers', 'WebFetch', 'WebSearch', 'Workflow', 'Write'];
|
|
230
230
|
|
|
231
231
|
/**
|
|
232
232
|
* Permission callback function for controlling tool usage.
|
|
@@ -1054,6 +1054,7 @@ export declare interface HookCallbackMatcher {
|
|
|
1054
1054
|
* the first prompt is sent only once those checks have passed.
|
|
1055
1055
|
*/
|
|
1056
1056
|
onFailure?: 'continue' | 'block';
|
|
1057
|
+
|
|
1057
1058
|
}
|
|
1058
1059
|
|
|
1059
1060
|
export declare type HookEvent = 'PreToolUse' | 'PostToolUse' | 'PostToolUseFailure' | 'PostToolBatch' | 'Notification' | 'UserPromptSubmit' | 'UserPromptExpansion' | 'SessionStart' | 'SessionEnd' | 'Stop' | 'StopFailure' | 'SubagentStart' | 'SubagentStop' | 'PreCompact' | 'PostCompact' | 'PreModelSwitch' | 'PostModelSwitch' | 'PermissionRequest' | 'PermissionDenied' | 'Setup' | 'TeammateIdle' | 'TaskCreated' | 'TaskCompleted' | 'Elicitation' | 'ElicitationResult' | 'ConfigChange' | 'WorktreeCreate' | 'WorktreeRemove' | 'InstructionsLoaded' | 'CwdChanged' | 'FileChanged' | 'DirectoryAdded' | 'MessageDisplay';
|
|
@@ -1310,8 +1311,9 @@ export declare type McpSdkServerConfig = {
|
|
|
1310
1311
|
|
|
1311
1312
|
|
|
1312
1313
|
|
|
1314
|
+
|
|
1313
1315
|
/**
|
|
1314
|
-
* Per-tool permission policy the host declares for this server's tools (not the tool definitions passed to createSdkMcpServer). always_ask: the CLI asks the host (canUseTool or the permission prompt tool) before each call, even where an allow rule or allowedTools covers the tool, and under bypassPermissions outside a hosted remote session (CLAUDE_CODE_REMOTE); under dontAsk the call is denied; in auto mode the classifier decides, except that by default a tool annotated destructiveHint still asks. always_deny: calls are denied. always_allow and org_max_permission are ignored on sdk servers; grant allows with allowedTools or canUseTool. Read from initialize (sdkMcpServerConfigs) and from each mcp_set_servers entry that names the server. On the wire an entry without tools states no policy: on initialize the stored list and the rules stand; on mcp_set_servers the rules are replaced without them. The Agent SDK always re-sends the registered list. An entry whose policy is not one of the three asks; an entry without a string name is dropped and the rest apply; a value that is not a list reads as absent.
|
|
1316
|
+
* Per-tool permission policy the host declares for this server's tools (not the tool definitions passed to createSdkMcpServer). always_ask: the CLI asks the host (canUseTool or the permission prompt tool) before each call, even where an allow rule or allowedTools covers the tool, and under bypassPermissions outside a hosted remote session (CLAUDE_CODE_REMOTE); under dontAsk the call is denied; in auto mode the classifier decides, except that by default a tool annotated destructiveHint still asks. always_deny: calls are denied, except a mod's own ($.tool.call, $.mcp.call). always_allow and org_max_permission are ignored on sdk servers; grant allows with allowedTools or canUseTool. Read from initialize (sdkMcpServerConfigs) and from each mcp_set_servers entry that names the server. On the wire an entry without tools states no policy: on initialize the stored list and the rules stand; on mcp_set_servers the rules are replaced without them. The Agent SDK always re-sends the registered list. An entry whose policy is not one of the three asks; an entry without a string name is dropped and the rest apply; a value that is not a list reads as absent.
|
|
1315
1317
|
*/
|
|
1316
1318
|
tools?: McpServerToolPolicy[];
|
|
1317
1319
|
};
|
|
@@ -2075,6 +2077,9 @@ export declare type Options = {
|
|
|
2075
2077
|
* MCP (Model Context Protocol) server configurations.
|
|
2076
2078
|
* Keys are server names, values are server configurations.
|
|
2077
2079
|
*
|
|
2080
|
+
* Servers that Claude Code runs or connects to (stdio, SSE, HTTP) reach it on its command
|
|
2081
|
+
* line unless `mcpServersDelivery` is `'initialize'`; see that option's deprecation notice.
|
|
2082
|
+
*
|
|
2078
2083
|
* @example
|
|
2079
2084
|
* ```typescript
|
|
2080
2085
|
* mcpServers: {
|
|
@@ -2086,6 +2091,34 @@ export declare type Options = {
|
|
|
2086
2091
|
* ```
|
|
2087
2092
|
*/
|
|
2088
2093
|
mcpServers?: Record<string, McpServerConfig>;
|
|
2094
|
+
/**
|
|
2095
|
+
* How the `mcpServers` that Claude Code runs or connects to (stdio, SSE, HTTP) reach it.
|
|
2096
|
+
* In-process servers (`createSdkMcpServer`) are not affected.
|
|
2097
|
+
* - `'argv'` (default) - Sent in one `--mcp-config` flag: works with any Claude Code version,
|
|
2098
|
+
* but puts server `env` and `headers` on the command line, which other users of the
|
|
2099
|
+
* machine can read.
|
|
2100
|
+
* - `'initialize'` - Sent over stdin in the initialize request, so `env` and `headers` stay
|
|
2101
|
+
* off the command line. The prompt waits for Claude Code's answer, and an error answer ends
|
|
2102
|
+
* the session. Requires the Claude Code bundled with this SDK or newer: an older one started
|
|
2103
|
+
* through `pathToClaudeCodeExecutable` or `spawnClaudeCodeProcess` exits at startup with an
|
|
2104
|
+
* unknown-option error (before 2.1.261), or has its session ended by this SDK with an error
|
|
2105
|
+
* naming this option. `initializationResult().mcp_servers_applied` is true when Claude Code
|
|
2106
|
+
* took the servers at launch, which does not mean each connected.
|
|
2107
|
+
*
|
|
2108
|
+
* A launch given `--sdk-url` (through `extraArgs` or `executableArgs`) always uses
|
|
2109
|
+
* `--mcp-config`, because that session cannot read the request at launch.
|
|
2110
|
+
*
|
|
2111
|
+
* Deprecation notice: sending these servers on the command line is deprecated, and a future
|
|
2112
|
+
* release changes the default to `'initialize'`. An app that starts its own Claude Code through
|
|
2113
|
+
* `pathToClaudeCodeExecutable` or `spawnClaudeCodeProcess` should update it to at least the
|
|
2114
|
+
* bundled version and set `'initialize'`, or set `'argv'` to stay on the command line; while it
|
|
2115
|
+
* leaves this option unset, this SDK emits a `DeprecationWarning` once per process (code
|
|
2116
|
+
* `CLAUDE_SDK_MCP_SERVERS_ARGV_DEPRECATED`). Apps that use the bundled Claude Code need not
|
|
2117
|
+
* update it, get no warning, and can set `'initialize'` now.
|
|
2118
|
+
*
|
|
2119
|
+
* @default 'argv'
|
|
2120
|
+
*/
|
|
2121
|
+
mcpServersDelivery?: 'argv' | 'initialize';
|
|
2089
2122
|
/**
|
|
2090
2123
|
* Claude model to use. Defaults to the CLI default model.
|
|
2091
2124
|
* Examples: 'claude-sonnet-5', 'claude-opus-4-8', 'claude-fable-5'
|
|
@@ -3016,6 +3049,108 @@ export declare type ProvenanceEntry = {
|
|
|
3016
3049
|
policyOrigin?: PolicySettingsOrigin;
|
|
3017
3050
|
};
|
|
3018
3051
|
|
|
3052
|
+
declare const PublishedSandboxSettingsSchema: () => z.ZodObject<{
|
|
3053
|
+
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
3054
|
+
failIfUnavailable: z.ZodOptional<z.ZodBoolean>;
|
|
3055
|
+
autoAllowBashIfSandboxed: z.ZodOptional<z.ZodBoolean>;
|
|
3056
|
+
allowUnsandboxedCommands: z.ZodOptional<z.ZodBoolean>;
|
|
3057
|
+
network: z.ZodOptional<z.ZodObject<{
|
|
3058
|
+
allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3059
|
+
deniedDomains: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3060
|
+
strictAllowlist: z.ZodOptional<z.ZodBoolean>;
|
|
3061
|
+
allowManagedDomainsOnly: z.ZodOptional<z.ZodBoolean>;
|
|
3062
|
+
allowUnixSockets: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3063
|
+
allowAllUnixSockets: z.ZodOptional<z.ZodBoolean>;
|
|
3064
|
+
allowLocalBinding: z.ZodOptional<z.ZodBoolean>;
|
|
3065
|
+
allowMachLookup: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3066
|
+
httpProxyPort: z.ZodOptional<z.ZodNumber>;
|
|
3067
|
+
socksProxyPort: z.ZodOptional<z.ZodNumber>;
|
|
3068
|
+
tlsTerminate: z.ZodOptional<z.ZodObject<{
|
|
3069
|
+
caCertPath: z.ZodOptional<z.ZodString>;
|
|
3070
|
+
caKeyPath: z.ZodOptional<z.ZodString>;
|
|
3071
|
+
}, z.core.$strip>>;
|
|
3072
|
+
}, z.core.$strip>>;
|
|
3073
|
+
filesystem: z.ZodOptional<z.ZodObject<{
|
|
3074
|
+
allowWrite: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3075
|
+
denyWrite: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3076
|
+
denyRead: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3077
|
+
allowRead: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3078
|
+
allowManagedReadPathsOnly: z.ZodOptional<z.ZodBoolean>;
|
|
3079
|
+
disabled: z.ZodOptional<z.ZodBoolean>;
|
|
3080
|
+
}, z.core.$strip>>;
|
|
3081
|
+
credentials: z.ZodOptional<z.ZodObject<{
|
|
3082
|
+
files: z.ZodOptional<z.ZodArray<z.ZodPreprocess<z.ZodObject<{
|
|
3083
|
+
path: z.ZodString;
|
|
3084
|
+
mode: z.ZodEnum<{
|
|
3085
|
+
deny: "deny";
|
|
3086
|
+
mask: "mask";
|
|
3087
|
+
}>;
|
|
3088
|
+
extract: z.ZodOptional<z.ZodString>;
|
|
3089
|
+
onExtractNoMatch: z.ZodOptional<z.ZodEnum<{
|
|
3090
|
+
deny: "deny";
|
|
3091
|
+
error: "error";
|
|
3092
|
+
warn: "warn";
|
|
3093
|
+
}>>;
|
|
3094
|
+
decode: z.ZodOptional<z.ZodEnum<{
|
|
3095
|
+
jwt: "jwt";
|
|
3096
|
+
}>>;
|
|
3097
|
+
maskClaims: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3098
|
+
maskDuplicates: z.ZodOptional<z.ZodBoolean>;
|
|
3099
|
+
injectHosts: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3100
|
+
}, z.core.$strip>, unknown>>>;
|
|
3101
|
+
envVars: z.ZodOptional<z.ZodArray<z.ZodPreprocess<z.ZodObject<{
|
|
3102
|
+
name: z.ZodString;
|
|
3103
|
+
mode: z.ZodEnum<{
|
|
3104
|
+
deny: "deny";
|
|
3105
|
+
mask: "mask";
|
|
3106
|
+
}>;
|
|
3107
|
+
extract: z.ZodOptional<z.ZodString>;
|
|
3108
|
+
onExtractNoMatch: z.ZodOptional<z.ZodEnum<{
|
|
3109
|
+
deny: "deny";
|
|
3110
|
+
error: "error";
|
|
3111
|
+
warn: "warn";
|
|
3112
|
+
}>>;
|
|
3113
|
+
decode: z.ZodOptional<z.ZodEnum<{
|
|
3114
|
+
jwt: "jwt";
|
|
3115
|
+
}>>;
|
|
3116
|
+
maskClaims: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3117
|
+
injectHosts: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3118
|
+
}, z.core.$strip>, unknown>>>;
|
|
3119
|
+
allowPlaintextInject: z.ZodOptional<z.ZodBoolean>;
|
|
3120
|
+
awsPairs: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
3121
|
+
accessKeyIdVar: z.ZodString;
|
|
3122
|
+
secretAccessKeyVar: z.ZodString;
|
|
3123
|
+
sessionTokenVar: z.ZodOptional<z.ZodString>;
|
|
3124
|
+
}, z.core.$strip>>>;
|
|
3125
|
+
sigv4: z.ZodOptional<z.ZodObject<{
|
|
3126
|
+
streaming: z.ZodOptional<z.ZodEnum<{
|
|
3127
|
+
deny: "deny";
|
|
3128
|
+
passthrough: "passthrough";
|
|
3129
|
+
}>>;
|
|
3130
|
+
presigned: z.ZodOptional<z.ZodEnum<{
|
|
3131
|
+
deny: "deny";
|
|
3132
|
+
passthrough: "passthrough";
|
|
3133
|
+
}>>;
|
|
3134
|
+
sigv4a: z.ZodOptional<z.ZodEnum<{
|
|
3135
|
+
deny: "deny";
|
|
3136
|
+
passthrough: "passthrough";
|
|
3137
|
+
}>>;
|
|
3138
|
+
}, z.core.$strip>>;
|
|
3139
|
+
}, z.core.$strip>>;
|
|
3140
|
+
ignoreViolations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString>>>;
|
|
3141
|
+
enableWeakerNestedSandbox: z.ZodOptional<z.ZodBoolean>;
|
|
3142
|
+
allowNestedUserNamespaces: z.ZodOptional<z.ZodBoolean>;
|
|
3143
|
+
enableWeakerNetworkIsolation: z.ZodOptional<z.ZodBoolean>;
|
|
3144
|
+
allowAppleEvents: z.ZodOptional<z.ZodBoolean>;
|
|
3145
|
+
excludedCommands: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3146
|
+
ripgrep: z.ZodOptional<z.ZodObject<{
|
|
3147
|
+
command: z.ZodString;
|
|
3148
|
+
args: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3149
|
+
}, z.core.$strip>>;
|
|
3150
|
+
bwrapPath: z.ZodCatch<z.ZodOptional<z.ZodPreprocess<z.ZodString, unknown>>>;
|
|
3151
|
+
socatPath: z.ZodCatch<z.ZodOptional<z.ZodPreprocess<z.ZodString, unknown>>>;
|
|
3152
|
+
}, z.core.$loose>;
|
|
3153
|
+
|
|
3019
3154
|
/**
|
|
3020
3155
|
* Query interface with methods for controlling query execution.
|
|
3021
3156
|
* Extends AsyncGenerator and has methods, so not serializable.
|
|
@@ -3596,7 +3731,7 @@ export declare type RewindFilesResult = {
|
|
|
3596
3731
|
insertions?: number;
|
|
3597
3732
|
deletions?: number;
|
|
3598
3733
|
/**
|
|
3599
|
-
* Count of tracked files NOT restored or deleted because a symlink, hard link, or other non-regular file was detected at the tracked path, its parent directory no longer resolves to where it pointed when the checkpoint was taken, or its backup could not be safely read. Only populated by a real (non-dryRun) rewind — on a dryRun response the field is never set and the preview counts do not reflect link-safety refusals. Absent or 0 on a real rewind means no link-safety refusals occurred; other per-file failures (for example a missing backup file) are not counted here; they are reported in telemetry, and when every differing file fails to restore the rewind itself fails (canRewind: false).
|
|
3734
|
+
* Count of tracked files NOT restored or deleted because a symlink, hard link, or other non-regular file was detected at the tracked path, its parent directory no longer resolves to where it pointed when the checkpoint was taken, it is behind a link in a folder that sandboxed commands can write, or its backup could not be safely read. Only populated by a real (non-dryRun) rewind — on a dryRun response the field is never set and the preview counts do not reflect link-safety refusals. Absent or 0 on a real rewind means no link-safety refusals occurred; other per-file failures (for example a missing backup file) are not counted here; they are reported in telemetry, and when every differing file fails to restore the rewind itself fails (canRewind: false).
|
|
3600
3735
|
*/
|
|
3601
3736
|
skippedLinks?: number;
|
|
3602
3737
|
};
|
|
@@ -3701,112 +3836,7 @@ declare const SandboxNetworkConfigSchema: () => z.ZodOptional<z.ZodObject<{
|
|
|
3701
3836
|
}, z.core.$strip>>;
|
|
3702
3837
|
}, z.core.$strip>>;
|
|
3703
3838
|
|
|
3704
|
-
export declare type SandboxSettings = z.infer<ReturnType<typeof
|
|
3705
|
-
|
|
3706
|
-
/**
|
|
3707
|
-
* Sandbox settings schema.
|
|
3708
|
-
*/
|
|
3709
|
-
declare const SandboxSettingsSchema: () => z.ZodObject<{
|
|
3710
|
-
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
3711
|
-
failIfUnavailable: z.ZodOptional<z.ZodBoolean>;
|
|
3712
|
-
autoAllowBashIfSandboxed: z.ZodOptional<z.ZodBoolean>;
|
|
3713
|
-
allowUnsandboxedCommands: z.ZodOptional<z.ZodBoolean>;
|
|
3714
|
-
network: z.ZodOptional<z.ZodObject<{
|
|
3715
|
-
allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3716
|
-
deniedDomains: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3717
|
-
strictAllowlist: z.ZodOptional<z.ZodBoolean>;
|
|
3718
|
-
allowManagedDomainsOnly: z.ZodOptional<z.ZodBoolean>;
|
|
3719
|
-
allowUnixSockets: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3720
|
-
allowAllUnixSockets: z.ZodOptional<z.ZodBoolean>;
|
|
3721
|
-
allowLocalBinding: z.ZodOptional<z.ZodBoolean>;
|
|
3722
|
-
allowMachLookup: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3723
|
-
httpProxyPort: z.ZodOptional<z.ZodNumber>;
|
|
3724
|
-
socksProxyPort: z.ZodOptional<z.ZodNumber>;
|
|
3725
|
-
tlsTerminate: z.ZodOptional<z.ZodObject<{
|
|
3726
|
-
caCertPath: z.ZodOptional<z.ZodString>;
|
|
3727
|
-
caKeyPath: z.ZodOptional<z.ZodString>;
|
|
3728
|
-
}, z.core.$strip>>;
|
|
3729
|
-
}, z.core.$strip>>;
|
|
3730
|
-
filesystem: z.ZodOptional<z.ZodObject<{
|
|
3731
|
-
allowWrite: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3732
|
-
denyWrite: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3733
|
-
denyRead: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3734
|
-
allowRead: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3735
|
-
allowManagedReadPathsOnly: z.ZodOptional<z.ZodBoolean>;
|
|
3736
|
-
disabled: z.ZodOptional<z.ZodBoolean>;
|
|
3737
|
-
}, z.core.$strip>>;
|
|
3738
|
-
credentials: z.ZodOptional<z.ZodObject<{
|
|
3739
|
-
files: z.ZodOptional<z.ZodArray<z.ZodPreprocess<z.ZodObject<{
|
|
3740
|
-
path: z.ZodString;
|
|
3741
|
-
mode: z.ZodEnum<{
|
|
3742
|
-
deny: "deny";
|
|
3743
|
-
mask: "mask";
|
|
3744
|
-
}>;
|
|
3745
|
-
extract: z.ZodOptional<z.ZodString>;
|
|
3746
|
-
onExtractNoMatch: z.ZodOptional<z.ZodEnum<{
|
|
3747
|
-
deny: "deny";
|
|
3748
|
-
error: "error";
|
|
3749
|
-
warn: "warn";
|
|
3750
|
-
}>>;
|
|
3751
|
-
decode: z.ZodOptional<z.ZodEnum<{
|
|
3752
|
-
jwt: "jwt";
|
|
3753
|
-
}>>;
|
|
3754
|
-
maskClaims: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3755
|
-
maskDuplicates: z.ZodOptional<z.ZodBoolean>;
|
|
3756
|
-
injectHosts: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3757
|
-
}, z.core.$strip>, unknown>>>;
|
|
3758
|
-
envVars: z.ZodOptional<z.ZodArray<z.ZodPreprocess<z.ZodObject<{
|
|
3759
|
-
name: z.ZodString;
|
|
3760
|
-
mode: z.ZodEnum<{
|
|
3761
|
-
deny: "deny";
|
|
3762
|
-
mask: "mask";
|
|
3763
|
-
}>;
|
|
3764
|
-
extract: z.ZodOptional<z.ZodString>;
|
|
3765
|
-
onExtractNoMatch: z.ZodOptional<z.ZodEnum<{
|
|
3766
|
-
deny: "deny";
|
|
3767
|
-
error: "error";
|
|
3768
|
-
warn: "warn";
|
|
3769
|
-
}>>;
|
|
3770
|
-
decode: z.ZodOptional<z.ZodEnum<{
|
|
3771
|
-
jwt: "jwt";
|
|
3772
|
-
}>>;
|
|
3773
|
-
maskClaims: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3774
|
-
injectHosts: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3775
|
-
}, z.core.$strip>, unknown>>>;
|
|
3776
|
-
allowPlaintextInject: z.ZodOptional<z.ZodBoolean>;
|
|
3777
|
-
awsPairs: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
3778
|
-
accessKeyIdVar: z.ZodString;
|
|
3779
|
-
secretAccessKeyVar: z.ZodString;
|
|
3780
|
-
sessionTokenVar: z.ZodOptional<z.ZodString>;
|
|
3781
|
-
}, z.core.$strip>>>;
|
|
3782
|
-
sigv4: z.ZodOptional<z.ZodObject<{
|
|
3783
|
-
streaming: z.ZodOptional<z.ZodEnum<{
|
|
3784
|
-
deny: "deny";
|
|
3785
|
-
passthrough: "passthrough";
|
|
3786
|
-
}>>;
|
|
3787
|
-
presigned: z.ZodOptional<z.ZodEnum<{
|
|
3788
|
-
deny: "deny";
|
|
3789
|
-
passthrough: "passthrough";
|
|
3790
|
-
}>>;
|
|
3791
|
-
sigv4a: z.ZodOptional<z.ZodEnum<{
|
|
3792
|
-
deny: "deny";
|
|
3793
|
-
passthrough: "passthrough";
|
|
3794
|
-
}>>;
|
|
3795
|
-
}, z.core.$strip>>;
|
|
3796
|
-
}, z.core.$strip>>;
|
|
3797
|
-
ignoreViolations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString>>>;
|
|
3798
|
-
enableWeakerNestedSandbox: z.ZodOptional<z.ZodBoolean>;
|
|
3799
|
-
allowNestedUserNamespaces: z.ZodOptional<z.ZodBoolean>;
|
|
3800
|
-
enableWeakerNetworkIsolation: z.ZodOptional<z.ZodBoolean>;
|
|
3801
|
-
allowAppleEvents: z.ZodOptional<z.ZodBoolean>;
|
|
3802
|
-
excludedCommands: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3803
|
-
ripgrep: z.ZodOptional<z.ZodObject<{
|
|
3804
|
-
command: z.ZodString;
|
|
3805
|
-
args: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3806
|
-
}, z.core.$strip>>;
|
|
3807
|
-
bwrapPath: z.ZodCatch<z.ZodOptional<z.ZodPreprocess<z.ZodString, unknown>>>;
|
|
3808
|
-
socatPath: z.ZodCatch<z.ZodOptional<z.ZodPreprocess<z.ZodString, unknown>>>;
|
|
3809
|
-
}, z.core.$loose>;
|
|
3839
|
+
export declare type SandboxSettings = z.infer<ReturnType<typeof PublishedSandboxSettingsSchema>>;
|
|
3810
3840
|
|
|
3811
3841
|
/**
|
|
3812
3842
|
* Emitted when the user's /goal Stop hook reports met (clears) or not-yet-met (bumps iterations + last_reason). Any surface with a goal indicator re-renders from this. value is null when the goal is cleared. From internal QueryEvent 'active_goal'.
|
|
@@ -4479,7 +4509,7 @@ declare type SDKControlGetHooksListingResponse = {
|
|
|
4479
4509
|
exitHint: string;
|
|
4480
4510
|
};
|
|
4481
4511
|
/**
|
|
4482
|
-
* Present only under --bare / CLAUDE_CODE_SIMPLE with the hooks surface gated off: settings-file, flag, policy, and plugin hooks never fire there; session hooks still run.
|
|
4512
|
+
* Present only under --bare / CLAUDE_CODE_SIMPLE with the hooks surface gated off: settings-file, flag, policy, and a person's plugin hooks never fire there; session hooks and the hooks of plugins managed settings enable still run.
|
|
4483
4513
|
*/
|
|
4484
4514
|
bareMode?: {
|
|
4485
4515
|
/**
|
|
@@ -4836,7 +4866,7 @@ declare type SDKControlInitializeRequest = {
|
|
|
4836
4866
|
hooks?: Partial<Record<coreTypes.HookEvent, SDKHookCallbackMatcher[]>>;
|
|
4837
4867
|
sdkMcpServers?: string[];
|
|
4838
4868
|
/**
|
|
4839
|
-
* Settings for the SDK-hosted MCP servers named in sdkMcpServers, keyed by server name. Sent as a separate field so a CLI that predates it ignores it; entries whose name is not in sdkMcpServers, and values that do not match this shape, are ignored rather than rejected. timeout, disableAutoBackground, connectorId, autoModeVerdictTools and
|
|
4869
|
+
* Settings for the SDK-hosted MCP servers named in sdkMcpServers, keyed by server name. Sent as a separate field so a CLI that predates it ignores it; entries whose name is not in sdkMcpServers, and values that do not match this shape, are ignored rather than rejected. timeout, disableAutoBackground, connectorId, autoModeVerdictTools, dataFlowServer and onPersonsMachine apply when the server is first registered; tools (the per-tool permission policy) adds its ask and deny rules on every initialize that names the server. An initialize never removes a rule; mcp_set_servers replaces them.
|
|
4840
4870
|
*/
|
|
4841
4871
|
sdkMcpServerConfigs?: Record<string, {
|
|
4842
4872
|
/**
|
|
@@ -4847,8 +4877,9 @@ declare type SDKControlInitializeRequest = {
|
|
|
4847
4877
|
|
|
4848
4878
|
|
|
4849
4879
|
|
|
4880
|
+
|
|
4850
4881
|
/**
|
|
4851
|
-
* Per-tool permission policy the host declares for this server's tools (not the tool definitions passed to createSdkMcpServer). always_ask: the CLI asks the host (canUseTool or the permission prompt tool) before each call, even where an allow rule or allowedTools covers the tool, and under bypassPermissions outside a hosted remote session (CLAUDE_CODE_REMOTE); under dontAsk the call is denied; in auto mode the classifier decides, except that by default a tool annotated destructiveHint still asks. always_deny: calls are denied. always_allow and org_max_permission are ignored on sdk servers; grant allows with allowedTools or canUseTool. Read from initialize (sdkMcpServerConfigs) and from each mcp_set_servers entry that names the server. On the wire an entry without tools states no policy: on initialize the stored list and the rules stand; on mcp_set_servers the rules are replaced without them. The Agent SDK always re-sends the registered list. An entry whose policy is not one of the three asks; an entry without a string name is dropped and the rest apply; a value that is not a list reads as absent.
|
|
4882
|
+
* Per-tool permission policy the host declares for this server's tools (not the tool definitions passed to createSdkMcpServer). always_ask: the CLI asks the host (canUseTool or the permission prompt tool) before each call, even where an allow rule or allowedTools covers the tool, and under bypassPermissions outside a hosted remote session (CLAUDE_CODE_REMOTE); under dontAsk the call is denied; in auto mode the classifier decides, except that by default a tool annotated destructiveHint still asks. always_deny: calls are denied, except a mod's own ($.tool.call, $.mcp.call). always_allow and org_max_permission are ignored on sdk servers; grant allows with allowedTools or canUseTool. Read from initialize (sdkMcpServerConfigs) and from each mcp_set_servers entry that names the server. On the wire an entry without tools states no policy: on initialize the stored list and the rules stand; on mcp_set_servers the rules are replaced without them. The Agent SDK always re-sends the registered list. An entry whose policy is not one of the three asks; an entry without a string name is dropped and the rest apply; a value that is not a list reads as absent.
|
|
4852
4883
|
*/
|
|
4853
4884
|
tools?: coreTypes.McpServerToolPolicy[];
|
|
4854
4885
|
}>;
|
|
@@ -4918,6 +4949,10 @@ declare type SDKControlInitializeRequest = {
|
|
|
4918
4949
|
* Plugins to load for the session, in the same shape as the SDK `plugins` option: the stdin form of one --plugin-dir flag per entry (--plugin-dir-no-mcp when skipMcpDiscovery is set), so the launch command line does not grow with the plugin count. Loaded only by a CLI launched with --await-initialize, which reads this request during startup before any plugin work. Without that flag, on a repeated initialize, or over a remote session transport the field loads nothing; plugins_applied in the response reports whether the listed plugins are in fact loaded.
|
|
4919
4950
|
*/
|
|
4920
4951
|
plugins?: coreTypes.SdkPluginConfig[];
|
|
4952
|
+
/**
|
|
4953
|
+
* MCP servers for Claude Code to run or connect to, keyed by server name: the serializable entries of the SDK `mcpServers` option (host-resident servers go in sdkMcpServers), as the stdin form of one --mcp-config item, which keeps server credentials (stdio `env`, http and sse `headers`) off the command line. Read only at launch under --await-initialize, and then handled as --mcp-config: an invalid entry is skipped and reported in system/init, not fatal; one difference is that a Claude Code process this one starts is not handed them. Without that flag, on a repeated initialize, or over a remote session transport it loads nothing; use mcp_set_servers in a running session. mcp_servers_applied in the response says whether these are the set read at launch.
|
|
4954
|
+
*/
|
|
4955
|
+
mcpServers?: Record<string, coreTypes.McpServerConfigForProcessTransport>;
|
|
4921
4956
|
|
|
4922
4957
|
|
|
4923
4958
|
|
|
@@ -4954,11 +4989,16 @@ export declare type SDKControlInitializeResponse = {
|
|
|
4954
4989
|
hook_on_failure_supported?: boolean;
|
|
4955
4990
|
|
|
4956
4991
|
|
|
4992
|
+
|
|
4957
4993
|
/**
|
|
4958
4994
|
* Whether every plugin this initialize listed is loaded: true when each one is among the plugins the process loaded at launch (from `plugins` under --await-initialize, or from --plugin-dir), so a re-sent initialize naming the launch set also reads true; false otherwise. The `plugins` field never loads anything after launch. Absent when the request listed no plugins, and on CLIs that predate the field (those never read `plugins`).
|
|
4959
4995
|
*/
|
|
4960
4996
|
plugins_applied?: boolean;
|
|
4961
4997
|
|
|
4998
|
+
/**
|
|
4999
|
+
* Whether the `mcpServers` in this initialize are the set the process read at launch under --await-initialize, so a re-sent initialize naming the same set also reads true; false otherwise. True says they were taken as an --mcp-config item, not that each one connected: a server missing from system/init mcp_servers was not loaded. The field loads nothing after launch. Absent when the request named none, and on CLIs that predate the field, which never read `mcpServers`: a host that sent servers must treat absence as not applied.
|
|
5000
|
+
*/
|
|
5001
|
+
mcp_servers_applied?: boolean;
|
|
4962
5002
|
|
|
4963
5003
|
|
|
4964
5004
|
/**
|
|
@@ -5650,6 +5690,7 @@ declare type SDKHookCallbackMatcher = {
|
|
|
5650
5690
|
* What a failure of these callbacks does: the client answered the hook_callback request with an error, or with an answer that fails validation. 'continue' (default): the failure is reported and the action goes ahead. 'block': the failure counts as a block, as it does for a command hook, so the action the event guards (a tool call, a permission request, a prompt) is blocked. Ignored on Stop, SubagentStop, TaskCompleted and TeammateIdle.
|
|
5651
5691
|
*/
|
|
5652
5692
|
onFailure?: 'continue' | 'block';
|
|
5693
|
+
|
|
5653
5694
|
};
|
|
5654
5695
|
|
|
5655
5696
|
/**
|
|
@@ -5673,6 +5714,7 @@ export declare type SDKHookProgressMessage = {
|
|
|
5673
5714
|
stdout: string;
|
|
5674
5715
|
stderr: string;
|
|
5675
5716
|
output: string;
|
|
5717
|
+
|
|
5676
5718
|
uuid: UUID;
|
|
5677
5719
|
session_id: string;
|
|
5678
5720
|
};
|
|
@@ -5698,6 +5740,9 @@ export declare type SDKHookStartedMessage = {
|
|
|
5698
5740
|
hook_id: string;
|
|
5699
5741
|
hook_name: string;
|
|
5700
5742
|
hook_event: string;
|
|
5743
|
+
|
|
5744
|
+
|
|
5745
|
+
|
|
5701
5746
|
uuid: UUID;
|
|
5702
5747
|
session_id: string;
|
|
5703
5748
|
};
|
|
@@ -6090,6 +6135,7 @@ export declare type SdkPluginConfig = {
|
|
|
6090
6135
|
* When true, the engine loads skills/hooks/agents/commands from this plugin but does NOT read its .mcp.json or manifest mcpServers. Use when the SDK host owns this plugin's MCP connections.
|
|
6091
6136
|
*/
|
|
6092
6137
|
skipMcpDiscovery?: boolean;
|
|
6138
|
+
|
|
6093
6139
|
};
|
|
6094
6140
|
|
|
6095
6141
|
/**
|
|
@@ -6168,7 +6214,7 @@ export declare type SDKResultError = {
|
|
|
6168
6214
|
num_turns: number;
|
|
6169
6215
|
stop_reason: string | null;
|
|
6170
6216
|
/**
|
|
6171
|
-
* Cumulative estimated cost in USD for this query() call, covering the same
|
|
6217
|
+
* Cumulative estimated cost in USD for this query() call, covering the same calls as modelUsage (billed permission classifier calls and stopped or cut calls included, which maxBudgetUsd / --max-budget-usd therefore counts) and sharing its lifecycle: cumulative across turns in streaming-input sessions — each result carries the running total so far, so read the latest result rather than summing across results. Crash/startup-error results may carry zeroed values, a resumed or forked session continues from the total its transcript saved, when it has one (so the first result already carries the earlier turns; maxBudgetUsd counts only the spend since this query() call started or last /clear), and a mid-session /clear resets the running total. An estimate, not a billing statement.
|
|
6172
6218
|
*/
|
|
6173
6219
|
total_cost_usd: number;
|
|
6174
6220
|
/**
|
|
@@ -6176,7 +6222,7 @@ export declare type SDKResultError = {
|
|
|
6176
6222
|
*/
|
|
6177
6223
|
usage: NonNullableUsage;
|
|
6178
6224
|
/**
|
|
6179
|
-
* Per-model totals for every model call made through the query pipeline during this query() call — main loop, Task subagents, sidechains, and internal calls such as compaction and Workflow agents. Cumulative across turns in streaming-input sessions: each result carries the running total so far, so read the latest result rather than summing across results.
|
|
6225
|
+
* Per-model totals for every model call made through the query pipeline during this query() call — main loop, Task subagents, sidechains, and internal calls such as compaction and Workflow agents. Cumulative across turns in streaming-input sessions: each result carries the running total so far, so read the latest result rather than summing across results. Auto mode's permission classifier calls are included where they are billed (not on Pro, Max or Team plans, nor on a claude.ai sign-in whose plan cannot be read), and so is a call stopped or cut mid-response, with its output tokens estimated from what had streamed (low when a long tool call was being written, since the API holds a call's input until it is whole). Other internal helper calls outside the query pipeline (e.g. token-count probes) are excluded; crash/startup-error results may carry zeroed usage, a resumed or forked session continues from the totals its transcript saved, when it has them (so the first result already carries the earlier turns), and a mid-session /clear resets the running total. The correct field for token/cost accounting; treat it as an estimate, not a billing statement.
|
|
6180
6226
|
*/
|
|
6181
6227
|
modelUsage: Record<string, ModelUsage>;
|
|
6182
6228
|
|
|
@@ -6229,6 +6275,7 @@ export declare type SDKResultError = {
|
|
|
6229
6275
|
|
|
6230
6276
|
|
|
6231
6277
|
|
|
6278
|
+
|
|
6232
6279
|
terminal_reason?: TerminalReason;
|
|
6233
6280
|
|
|
6234
6281
|
|
|
@@ -6295,6 +6342,7 @@ export declare type SDKResultSuccess = {
|
|
|
6295
6342
|
|
|
6296
6343
|
|
|
6297
6344
|
|
|
6345
|
+
|
|
6298
6346
|
|
|
6299
6347
|
|
|
6300
6348
|
user_message_uuid?: string;
|
|
@@ -6341,7 +6389,7 @@ export declare type SDKResultSuccess = {
|
|
|
6341
6389
|
result: string;
|
|
6342
6390
|
stop_reason: string | null;
|
|
6343
6391
|
/**
|
|
6344
|
-
* Cumulative estimated cost in USD for this query() call, covering the same
|
|
6392
|
+
* Cumulative estimated cost in USD for this query() call, covering the same calls as modelUsage (billed permission classifier calls and stopped or cut calls included, which maxBudgetUsd / --max-budget-usd therefore counts) and sharing its lifecycle: cumulative across turns in streaming-input sessions — each result carries the running total so far, so read the latest result rather than summing across results. Crash/startup-error results may carry zeroed values, a resumed or forked session continues from the total its transcript saved, when it has one (so the first result already carries the earlier turns; maxBudgetUsd counts only the spend since this query() call started or last /clear), and a mid-session /clear resets the running total. An estimate, not a billing statement.
|
|
6345
6393
|
*/
|
|
6346
6394
|
total_cost_usd: number;
|
|
6347
6395
|
/**
|
|
@@ -6349,7 +6397,7 @@ export declare type SDKResultSuccess = {
|
|
|
6349
6397
|
*/
|
|
6350
6398
|
usage: NonNullableUsage;
|
|
6351
6399
|
/**
|
|
6352
|
-
* Per-model totals for every model call made through the query pipeline during this query() call — main loop, Task subagents, sidechains, and internal calls such as compaction and Workflow agents. Cumulative across turns in streaming-input sessions: each result carries the running total so far, so read the latest result rather than summing across results.
|
|
6400
|
+
* Per-model totals for every model call made through the query pipeline during this query() call — main loop, Task subagents, sidechains, and internal calls such as compaction and Workflow agents. Cumulative across turns in streaming-input sessions: each result carries the running total so far, so read the latest result rather than summing across results. Auto mode's permission classifier calls are included where they are billed (not on Pro, Max or Team plans, nor on a claude.ai sign-in whose plan cannot be read), and so is a call stopped or cut mid-response, with its output tokens estimated from what had streamed (low when a long tool call was being written, since the API holds a call's input until it is whole). Other internal helper calls outside the query pipeline (e.g. token-count probes) are excluded; crash/startup-error results may carry zeroed usage, a resumed or forked session continues from the totals its transcript saved, when it has them (so the first result already carries the earlier turns), and a mid-session /clear resets the running total. The correct field for token/cost accounting; treat it as an estimate, not a billing statement.
|
|
6353
6401
|
*/
|
|
6354
6402
|
modelUsage: Record<string, ModelUsage>;
|
|
6355
6403
|
|
|
@@ -6483,7 +6531,7 @@ export declare type SDKSettingsParseError = {
|
|
|
6483
6531
|
};
|
|
6484
6532
|
|
|
6485
6533
|
/**
|
|
6486
|
-
* Why Claude Code refused to start, so a host can offer the fix instead of a retry. org_pin_api_key_conflict: managed settings pin a first-party or Cloud gateway sign-in, and an Anthropic API key or auth token is configured instead. provider_not_allowed: managed settings list the API providers this machine may use (allowedProviders), and the session is set up for one that is not listed. org_verify_failed: the sign-in's organization could not be verified against the pin (network, or a revoked token). org_pin_mismatch: the sign-in belongs to an organization the pin does not allow. managed_settings_invalid: managed policy settings could not be read, the pin names no organization, or managed model settings (deniedModels, or an availableModels list matched exactly) block the default model and leave no allowed model to use instead. remote_settings_required_unavailable: managed settings the organization requires could not be loaded. gateway_signin_required: the Cloud gateway ended this sign-in. gateway_access_denied: the Cloud gateway refused managed settings for this account. proxy_invalid: a proxy setting is not a complete URL. temp_dir_unusable: the per-user temp directory is unsafe or could not be created. cwd_unavailable: the working directory was deleted, moved or cannot be read. shell_tool_missing: Windows has no shell tool: Git Bash is missing, and PowerShell is missing or turned off by CLAUDE_CODE_USE_POWERSHELL_TOOL. session_held_by_background: the conversation to resume or continue is running as a background session. worktree_resume_refused: the resume was refused because the session's worktree failed its safety checks or the resume was launched from inside it; errors says whether a re-run continues without the worktree. worktree_unverified: the session's worktree could not be verified right now; retrying may succeed. cli_version_too_old: this Claude Code version is below the minimum Anthropic requires. bypass_root: bypass permissions mode was requested while running as root. org_config_required_unavailable: the organization requires its policy limits and managed settings before a session starts, and they could not be loaded (network, proxy, or an Anthropic error); retrying may succeed. org_config_refused: the organization requires its policy limits and managed settings, and Anthropic refused them for this sign-in (expired or revoked session, or the organization does not allow Claude Code for this account); signing in again or an admin's change is the fix, not a retry. sandbox_required_unavailable: a working sandbox is required and it cannot run in this session, for example because bubblewrap is missing or the platform is not supported; make the sandbox available or have the requirement changed. initialize_not_first: Claude Code was started with --await-initialize, and its first stdin line was not the initialize control request (another message, or not valid JSON). Either the host wrote something else first, or a wrapper script between the host and Claude Code read or changed that line; the fix is in the host or the wrapper script, not a retry. config_file_invalid: a configuration file read at start-up is not valid JSON; errors names the file and, for the global configuration file, how to restore or repair it, and invalid_config_file has the paths as fields. The file is left unchanged, and every start without a terminal is refused until it is repaired, so a retry alone does not help. managed_settings_not_delivered: Claude Code was started with --managed-settings-in-initialize and could not use the managed settings in the initialize control request. Stdin ended or failed first, or its first line was too long; the request has no managedSettings object, that object could not be used, or the request's plugins field is malformed; or the launch does not read that request at start-up or also passes --managed-settings. errors says which. Claude Code starts no session without them; the fix is in the host or in a wrapper script between it and Claude Code, not a retry.
|
|
6534
|
+
* Why Claude Code refused to start, so a host can offer the fix instead of a retry. org_pin_api_key_conflict: managed settings pin a first-party or Cloud gateway sign-in, and an Anthropic API key or auth token is configured instead. provider_not_allowed: managed settings list the API providers this machine may use (allowedProviders), and the session is set up for one that is not listed. org_verify_failed: the sign-in's organization could not be verified against the pin (network, or a revoked token). org_pin_mismatch: the sign-in belongs to an organization the pin does not allow. managed_settings_invalid: managed policy settings could not be read, the pin names no organization, or managed model settings (deniedModels, or an availableModels list matched exactly) block the default model and leave no allowed model to use instead. remote_settings_required_unavailable: managed settings the organization requires could not be loaded. gateway_signin_required: the Cloud gateway ended this sign-in. gateway_access_denied: the Cloud gateway refused managed settings for this account. proxy_invalid: a proxy setting is not a complete URL. temp_dir_unusable: the per-user temp directory is unsafe or could not be created. cwd_unavailable: the working directory was deleted, moved or cannot be read. shell_tool_missing: Windows has no shell tool: Git Bash is missing, and PowerShell is missing or turned off by CLAUDE_CODE_USE_POWERSHELL_TOOL. session_held_by_background: the conversation to resume or continue is running as a background session. worktree_resume_refused: the resume was refused because the session's worktree failed its safety checks or the resume was launched from inside it; errors says whether a re-run continues without the worktree. worktree_unverified: the session's worktree could not be verified right now; retrying may succeed. cli_version_too_old: this Claude Code version is below the minimum Anthropic requires. bypass_root: bypass permissions mode was requested while running as root. org_config_required_unavailable: the organization requires its policy limits and managed settings before a session starts, and they could not be loaded (network, proxy, or an Anthropic error); retrying may succeed. org_config_refused: the organization requires its policy limits and managed settings, and Anthropic refused them for this sign-in (expired or revoked session, or the organization does not allow Claude Code for this account); signing in again or an admin's change is the fix, not a retry. sandbox_required_unavailable: a working sandbox is required and it cannot run in this session, for example because bubblewrap is missing or the platform is not supported; make the sandbox available or have the requirement changed. initialize_not_first: Claude Code was started with --await-initialize, and its first stdin line was not the initialize control request (another message, or not valid JSON). Either the host wrote something else first, or a wrapper script between the host and Claude Code read or changed that line; the fix is in the host or the wrapper script, not a retry. config_file_invalid: a configuration file read at start-up is not valid JSON; errors names the file and, for the global configuration file, how to restore or repair it, and invalid_config_file has the paths as fields. The file is left unchanged, and every start without a terminal is refused until it is repaired, so a retry alone does not help. managed_settings_not_delivered: Claude Code was started with --managed-settings-in-initialize and could not use the managed settings in the initialize control request. Stdin ended or failed first, or its first line was too long; the request has no managedSettings object, that object could not be used, or the request's plugins or mcpServers field is malformed; or the launch does not read that request at start-up or also passes --managed-settings. errors says which. Claude Code starts no session without them; the fix is in the host or in a wrapper script between it and Claude Code, not a retry.
|
|
6487
6535
|
*/
|
|
6488
6536
|
export declare type SDKStartupFailureReason = 'org_pin_api_key_conflict' | 'provider_not_allowed' | 'org_verify_failed' | 'org_pin_mismatch' | 'managed_settings_invalid' | 'remote_settings_required_unavailable' | 'gateway_signin_required' | 'gateway_access_denied' | 'proxy_invalid' | 'temp_dir_unusable' | 'cwd_unavailable' | 'shell_tool_missing' | 'session_held_by_background' | 'worktree_resume_refused' | 'worktree_unverified' | 'cli_version_too_old' | 'bypass_root' | 'org_config_required_unavailable' | 'org_config_refused' | 'sandbox_required_unavailable' | 'initialize_not_first' | 'config_file_invalid' | 'managed_settings_not_delivered';
|
|
6489
6537
|
|
|
@@ -6623,6 +6671,7 @@ export declare type SDKTaskNotificationMessage = {
|
|
|
6623
6671
|
reason?: 'worker_restart';
|
|
6624
6672
|
output_file: string;
|
|
6625
6673
|
summary: string;
|
|
6674
|
+
|
|
6626
6675
|
usage?: {
|
|
6627
6676
|
total_tokens: number;
|
|
6628
6677
|
tool_uses: number;
|
|
@@ -6908,6 +6957,7 @@ export declare type SDKUserMessage = {
|
|
|
6908
6957
|
|
|
6909
6958
|
|
|
6910
6959
|
|
|
6960
|
+
|
|
6911
6961
|
|
|
6912
6962
|
|
|
6913
6963
|
/**
|
|
@@ -7011,6 +7061,7 @@ export declare type SDKUserMessageReplay = {
|
|
|
7011
7061
|
|
|
7012
7062
|
|
|
7013
7063
|
|
|
7064
|
+
|
|
7014
7065
|
|
|
7015
7066
|
|
|
7016
7067
|
/**
|
|
@@ -7810,7 +7861,7 @@ export declare interface Settings {
|
|
|
7810
7861
|
*/
|
|
7811
7862
|
onFailure?: 'continue' | 'block';
|
|
7812
7863
|
/**
|
|
7813
|
-
* Additional headers to include in the request. Values may reference environment variables using $VAR_NAME or ${VAR_NAME} syntax (e.g., "Authorization": "Bearer $MY_TOKEN"). Only variables listed in allowedEnvVars will be interpolated.
|
|
7864
|
+
* Additional headers to include in the request. Values may reference environment variables using $VAR_NAME or ${VAR_NAME} syntax (e.g., "Authorization": "Bearer $MY_TOKEN"). Only variables listed in allowedEnvVars will be interpolated. Content-Length and Transfer-Encoding given here are ignored: Claude Code works out the request's length from its body.
|
|
7814
7865
|
*/
|
|
7815
7866
|
headers?: {
|
|
7816
7867
|
[k: string]: string;
|
|
@@ -7912,11 +7963,11 @@ export declare interface Settings {
|
|
|
7912
7963
|
*/
|
|
7913
7964
|
disableWorkflows?: boolean;
|
|
7914
7965
|
/**
|
|
7915
|
-
* Deprecated: use enableArtifact: false. Still honored — true
|
|
7966
|
+
* Deprecated: use enableArtifact: false. Still honored — true turns Artifacts off; false is ignored.
|
|
7916
7967
|
*/
|
|
7917
7968
|
disableArtifact?: boolean;
|
|
7918
7969
|
/**
|
|
7919
|
-
* Turn
|
|
7970
|
+
* Turn Artifacts on or off. Off in any of managed, --settings, or user settings wins; project and local settings can only turn it off. Unset defaults to on once the feature is available.
|
|
7920
7971
|
*/
|
|
7921
7972
|
enableArtifact?: boolean;
|
|
7922
7973
|
/**
|
|
@@ -7964,11 +8015,11 @@ export declare interface Settings {
|
|
|
7964
8015
|
*/
|
|
7965
8016
|
allowManagedHooksOnly?: boolean;
|
|
7966
8017
|
/**
|
|
7967
|
-
* Allowlist of URL patterns that HTTP hooks may target. Supports * as a wildcard (e.g. "https://hooks.example.com/*"). When set, HTTP hooks with non-matching URLs are blocked. If undefined, all URLs are allowed. If empty array, no HTTP hooks are allowed. Arrays merge across settings sources (same semantics as allowedMcpServers).
|
|
8018
|
+
* Allowlist of URL patterns that HTTP hooks may target. Supports * as a wildcard (e.g. "https://hooks.example.com/*"). When set, HTTP hooks with non-matching URLs are blocked. If undefined, all URLs are allowed. If empty array, no HTTP hooks are allowed. Arrays merge across settings sources (same semantics as allowedMcpServers). Where managed settings do not set this list, a list in any other settings file does not apply to hooks that managed settings define, or that come from a plugin they enable from a local folder they name.
|
|
7968
8019
|
*/
|
|
7969
8020
|
allowedHttpHookUrls?: string[];
|
|
7970
8021
|
/**
|
|
7971
|
-
* Allowlist of environment variable names HTTP hooks may interpolate into headers. When set, each hook's effective allowedEnvVars is the intersection with this list. If undefined, no restriction is applied. Arrays merge across settings sources (same semantics as allowedMcpServers).
|
|
8022
|
+
* Allowlist of environment variable names HTTP hooks may interpolate into headers. When set, each hook's effective allowedEnvVars is the intersection with this list. If undefined, no restriction is applied. Arrays merge across settings sources (same semantics as allowedMcpServers). Where managed settings do not set this list, a list in any other settings file does not apply to hooks that managed settings define, or that come from a plugin they enable from a local folder they name.
|
|
7972
8023
|
*/
|
|
7973
8024
|
httpHookAllowedEnvVars?: string[];
|
|
7974
8025
|
/**
|
|
@@ -8040,7 +8091,7 @@ export declare interface Settings {
|
|
|
8040
8091
|
[k: string]: unknown;
|
|
8041
8092
|
})[];
|
|
8042
8093
|
/**
|
|
8043
|
-
* Deprecated:
|
|
8094
|
+
* Deprecated: still works, and will stop working in a future release. Custom per-subagent status line shown in the agent panel; receives row context as JSON on stdin
|
|
8044
8095
|
*/
|
|
8045
8096
|
subagentStatusLine?: {
|
|
8046
8097
|
type: 'command';
|
|
@@ -9585,6 +9636,7 @@ export declare interface Settings {
|
|
|
9585
9636
|
sigv4a?: 'deny' | 'passthrough';
|
|
9586
9637
|
};
|
|
9587
9638
|
};
|
|
9639
|
+
|
|
9588
9640
|
/**
|
|
9589
9641
|
* Sandbox violations to leave unreported: a map of command patterns ("*" for every command) to the filesystem paths whose violations are ignored. Merged across settings sources. When managed settings or a --settings file set allowUnsandboxedCommands: false, or managed settings set network.allowManagedDomainsOnly: true, values from project settings (.claude/settings.json and .claude/settings.local.json) are ignored.
|
|
9590
9642
|
*/
|