agent-sdk / Exports / ISubagentOptions
Interface: ISubagentOptions
Options for creating a subagent session.
Table of contents
Properties
- agentDefinition
- parentConfig
- parentContext
- parentTools
- terminal
- isForkWorker
- permissionMode
- permissionHandler
- hooks
- hookTypeExecutors
- onTextDelta
- onToolExecution
Properties
agentDefinition
• agentDefinition: IAgentDefinition
Agent definition (built-in or custom).
Defined in
agent-sdk/src/assembly/create-subagent-session.ts:30
parentConfig
• parentConfig: IResolvedConfig
Parent's resolved config (for provider, permissions, etc.).
Defined in
agent-sdk/src/assembly/create-subagent-session.ts:32
parentContext
• parentContext: ILoadedContext
Parent's loaded context (CLAUDE.md, AGENTS.md).
Defined in
agent-sdk/src/assembly/create-subagent-session.ts:34
parentTools
• parentTools: IToolWithEventService<TToolParameters, IToolResult>[]
Parent session's available tools (to inherit/filter).
Defined in
agent-sdk/src/assembly/create-subagent-session.ts:36
terminal
• terminal: ITerminalOutput
Terminal output interface.
Defined in
agent-sdk/src/assembly/create-subagent-session.ts:38
isForkWorker
• Optional isForkWorker: boolean
Whether this is a fork worker (uses fork suffix instead of standard).
Defined in
agent-sdk/src/assembly/create-subagent-session.ts:40
permissionMode
• Optional permissionMode: TPermissionMode
Permission mode from parent (bypassPermissions, acceptEdits, etc.).
Defined in
agent-sdk/src/assembly/create-subagent-session.ts:42
permissionHandler
• Optional permissionHandler: TPermissionHandler
Permission handler from parent.
Defined in
agent-sdk/src/assembly/create-subagent-session.ts:44
hooks
• Optional hooks: Record<string, unknown>
Plugin hooks configuration from parent session.
Defined in
agent-sdk/src/assembly/create-subagent-session.ts:46
hookTypeExecutors
• Optional hookTypeExecutors: IHookTypeExecutor[]
Hook type executors from parent session (prompt, agent, etc.).
Defined in
agent-sdk/src/assembly/create-subagent-session.ts:48
onTextDelta
• Optional onTextDelta: (delta: string) => void
Streaming callback.
Type declaration
▸ (delta): void
Parameters
| Name | Type |
|---|---|
delta | string |
Returns
void
Defined in
agent-sdk/src/assembly/create-subagent-session.ts:50
onToolExecution
• Optional onToolExecution: (event: { type: "start" | "end" ; toolName: string ; toolArgs?: TToolArgs ; success?: boolean }) => void
Tool execution callback.
Type declaration
▸ (event): void
Parameters
| Name | Type |
|---|---|
event | Object |
event.type | "start" | "end" |
event.toolName | string |
event.toolArgs? | TToolArgs |
event.success? | boolean |
Returns
void