Agent SDK reference - TypeScript changedagent-sdk/typescript
Nearest release: v2.1.233, published 10 hours before this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
Recorded here
Lines+22added
Lines−2removed
From line
2,516
where the diff opens
First seen
14 Aug 2026
this site's first read of the page
Recorded edits113to this page, all time
The whole hunk
from line 2516, old and new numbered
/
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
from line 2516
25162516Creates and manages a structured task list for tracking progress.
25172517
25182518<Note>
2519 As of TypeScript Agent SDK 0.3.142, `TodoWrite` is disabled by default. Use `TaskCreate`, `TaskGet`, `TaskUpdate`, and `TaskList` instead. See [Migrate to Task tools](/docs/en/agent-sdk/todo-tracking#migrate-to-task-tools) to update your monitoring code, or set `CLAUDE_CODE_ENABLE_TASKS=0` to revert to `TodoWrite`.
2519 On TypeScript Agent SDK 0.3.233 and later, the following tools aren't available on Opus 4.8, Sonnet 5, Fable 5, Mythos 5, or later versions of those families unless you opt in:
2520
2521 * `TodoWrite`
2522 * `TaskCreate`
2523 * `TaskGet`
2524 * `TaskUpdate`
2525 * `TaskList`
2526
2527 On other models, Claude Code provides the Task tools by default and `TodoWrite` only when you set `CLAUDE_CODE_ENABLE_TASKS=0`.
2528
2529 See [Model availability](/docs/en/agent-sdk/todo-tracking#model-availability) to opt in and [Migrate to Task tools](/docs/en/agent-sdk/todo-tracking#migrate-to-task-tools) to update your monitoring code.
25202530</Note>
25212531
25222532### TaskCreate
from line 3441
34313441Returns the previous and updated task lists.
34323442
34333443<Note>
3434 As of TypeScript Agent SDK 0.3.142, `TodoWrite` is disabled by default. Use `TaskCreate`, `TaskGet`, `TaskUpdate`, and `TaskList` instead. See [Migrate to Task tools](/docs/en/agent-sdk/todo-tracking#migrate-to-task-tools) to update your monitoring code, or set `CLAUDE_CODE_ENABLE_TASKS=0` to revert to `TodoWrite`.
3444 On TypeScript Agent SDK 0.3.233 and later, the following tools aren't available on Opus 4.8, Sonnet 5, Fable 5, Mythos 5, or later versions of those families unless you opt in:
3445
3446 * `TodoWrite`
3447 * `TaskCreate`
3448 * `TaskGet`
3449 * `TaskUpdate`
3450 * `TaskList`
3451
3452 On other models, Claude Code provides the Task tools by default and `TodoWrite` only when you set `CLAUDE_CODE_ENABLE_TASKS=0`.
3453
3454 See [Model availability](/docs/en/agent-sdk/todo-tracking#model-availability) to opt in and [Migrate to Task tools](/docs/en/agent-sdk/todo-tracking#migrate-to-task-tools) to update your monitoring code.
34353455</Note>
34363456
34373457### TaskCreate
from line 4474
44544474
44554475### `SDKTaskStartedMessage`
44564476
4457Emitted when a background task begins. The `task_type` field is `"local_bash"` for background Bash commands and [Monitor](#monitor) watches, `"local_agent"` for subagents, or `"remote_agent"`.
4458
4459```typescript theme={null}
4460type SDKTaskStartedMessage = {
4461 type: "system";
4462 subtype: "task_started";
4463 task_id: string;
4464 tool_use_id?: string;
4465 description: string;
4466 task_type?: string;
4467 uuid: UUID;
4468 session_id: string;
4469};
4470```
4471
4472### `SDKTaskProgressMessage`
4473
4474Emitted periodically while a subagent or background task is running. The `summary` field is populated only when [`agentProgressSummaries`](#option
4477Emitted when a background task begins. The `task_
No line in this hunk matches that.