agent-sdk / Exports / IAgentToolDeps
Interface: IAgentToolDeps
Dependencies injected at creation time via createAgentTool factory
Table of contents
Properties
- config
- context
- tools
- terminal
- permissionMode
- permissionHandler
- hooks
- hookTypeExecutors
- onTextDelta
- onToolExecution
- customAgentRegistry
Properties
config
• config: IResolvedConfig
Defined in
agent-sdk/src/tools/agent-tool.ts:43
context
• context: ILoadedContext
Defined in
agent-sdk/src/tools/agent-tool.ts:44
tools
• tools: IToolWithEventService<TToolParameters, IToolResult>[]
Defined in
agent-sdk/src/tools/agent-tool.ts:45
terminal
• terminal: ITerminalOutput
Defined in
agent-sdk/src/tools/agent-tool.ts:46
permissionMode
• Optional permissionMode: TPermissionMode
Permission mode from parent session (bypassPermissions, acceptEdits, etc.).
Defined in
agent-sdk/src/tools/agent-tool.ts:48
permissionHandler
• Optional permissionHandler: TPermissionHandler
Defined in
agent-sdk/src/tools/agent-tool.ts:49
hooks
• Optional hooks: Record<string, unknown>
Plugin hooks configuration from parent session.
Defined in
agent-sdk/src/tools/agent-tool.ts:51
hookTypeExecutors
• Optional hookTypeExecutors: IHookTypeExecutor[]
Hook type executors from parent session (prompt, agent, etc.).
Defined in
agent-sdk/src/tools/agent-tool.ts:53
onTextDelta
• Optional onTextDelta: (delta: string) => void
Type declaration
▸ (delta): void
Parameters
| Name | Type |
|---|---|
delta | string |
Returns
void
Defined in
agent-sdk/src/tools/agent-tool.ts:54
onToolExecution
• Optional onToolExecution: (event: { type: "start" | "end" ; toolName: string ; toolArgs?: TToolArgs ; success?: boolean }) => void
Type declaration
▸ (event): void
Parameters
| Name | Type |
|---|---|
event | Object |
event.type | "start" | "end" |
event.toolName | string |
event.toolArgs? | TToolArgs |
event.success? | boolean |
Returns
void
Defined in
agent-sdk/src/tools/agent-tool.ts:55
customAgentRegistry
• Optional customAgentRegistry: (name: string) => undefined | IAgentDefinition
Optional custom agent registry for resolving non-built-in agent types.
Type declaration
▸ (name): undefined | IAgentDefinition
Parameters
| Name | Type |
|---|---|
name | string |
Returns
undefined | IAgentDefinition