Skip to content

craft-hub / AgentTaskProviderInput

Interface: AgentTaskProviderInput ​

Defined in: packages/craft-hub/src/agent-tasks.ts:39

Fully resolved input passed to an agent task adapter.

Extends ​

Properties ​

actionId? ​

optional actionId?: "improve-project-config"

Defined in: packages/craft-hub/src/agent-tasks.ts:20

Inherited from ​

StartAgentTaskInput.actionId


capabilityId? ​

optional capabilityId?: string

Defined in: packages/craft-hub/src/agent-tasks.ts:19

Inherited from ​

StartAgentTaskInput.capabilityId


onOutput ​

onOutput: (chunk) => Promise<void>

Defined in: packages/craft-hub/src/agent-tasks.ts:48

Persist one human-readable progress chunk for the local task UI.

Parameters ​

chunk ​

string

Returns ​

Promise<void>


onThread ​

onThread: (threadId) => Promise<void>

Defined in: packages/craft-hub/src/agent-tasks.ts:46

Parameters ​

threadId ​

string

Returns ​

Promise<void>


parentTaskId? ​

optional parentTaskId?: string

Defined in: packages/craft-hub/src/agent-tasks.ts:22

Inherited from ​

StartAgentTaskInput.parentTaskId


primaryProjectId ​

primaryProjectId: string

Defined in: packages/craft-hub/src/agent-tasks.ts:16

Inherited from ​

StartAgentTaskInput.primaryProjectId


primaryProjectPath ​

primaryProjectPath: string

Defined in: packages/craft-hub/src/agent-tasks.ts:43


primaryProjectRelativePath? ​

optional primaryProjectRelativePath?: string

Defined in: packages/craft-hub/src/agent-tasks.ts:18

Project-relative package selected as the task working directory.

Inherited from ​

StartAgentTaskInput.primaryProjectRelativePath


primaryWorkingDirectory ​

primaryWorkingDirectory: string

Defined in: packages/craft-hub/src/agent-tasks.ts:44


projectIds ​

projectIds: string[]

Defined in: packages/craft-hub/src/agent-tasks.ts:15

Inherited from ​

StartAgentTaskInput.projectIds


projectPaths ​

projectPaths: string[]

Defined in: packages/craft-hub/src/agent-tasks.ts:42


prompt ​

prompt: string

Defined in: packages/craft-hub/src/agent-tasks.ts:14

Inherited from ​

StartAgentTaskInput.prompt


resumeThreadId? ​

optional resumeThreadId?: string

Defined in: packages/craft-hub/src/agent-tasks.ts:40


sandboxMode? ​

optional sandboxMode?: "read-only" | "workspace-write"

Defined in: packages/craft-hub/src/agent-tasks.ts:24

Least filesystem access the host adapter should grant to this task.

Inherited from ​

StartAgentTaskInput.sandboxMode


signal ​

signal: AbortSignal

Defined in: packages/craft-hub/src/agent-tasks.ts:45


taskId ​

taskId: string

Defined in: packages/craft-hub/src/agent-tasks.ts:41


workspaceId? ​

optional workspaceId?: string

Defined in: packages/craft-hub/src/agent-tasks.ts:21

Inherited from ​

StartAgentTaskInput.workspaceId

Released under the MIT License.