TaskListTool.ts
tools/TaskListTool/TaskListTool.ts
117
Lines
2803
Bytes
2
Exports
6
Imports
10
Keywords
What this is
This page documents one file from the repository and includes its full source so you can read it without leaving the docs site.
Beginner explanation
This file is part of the tool layer, which means it describes actions the system can perform for the user or model.
How it is used
Start from the exports list and related files. Those are the easiest clues for where this file fits into the system.
Expert explanation
Architecturally, this file intersects with tool-system, tasks-background-jobs. It contains 117 lines, 6 detected imports, and 2 detected exports.
Important relationships
Detected exports
OutputTaskListTool
Keywords
tasktasksinputschemaoutputschemaownerstatusblockedbylazyschemasubjectcontent
Detected imports
zod/v4../../Tool.js../../utils/lazySchema.js../../utils/tasks.js./constants.js./prompt.js
Source notes
This page embeds the full file contents. Small or leaf files are still indexed honestly instead of being over-explained.
Full source
import { z } from 'zod/v4'
import { buildTool, type ToolDef } from '../../Tool.js'
import { lazySchema } from '../../utils/lazySchema.js'
import {
getTaskListId,
isTodoV2Enabled,
listTasks,
TaskStatusSchema,
} from '../../utils/tasks.js'
import { TASK_LIST_TOOL_NAME } from './constants.js'
import { DESCRIPTION, getPrompt } from './prompt.js'
const inputSchema = lazySchema(() => z.strictObject({}))
type InputSchema = ReturnType<typeof inputSchema>
const outputSchema = lazySchema(() =>
z.object({
tasks: z.array(
z.object({
id: z.string(),
subject: z.string(),
status: TaskStatusSchema(),
owner: z.string().optional(),
blockedBy: z.array(z.string()),
}),
),
}),
)
type OutputSchema = ReturnType<typeof outputSchema>
export type Output = z.infer<OutputSchema>
export const TaskListTool = buildTool({
name: TASK_LIST_TOOL_NAME,
searchHint: 'list all tasks',
maxResultSizeChars: 100_000,
async description() {
return DESCRIPTION
},
async prompt() {
return getPrompt()
},
get inputSchema(): InputSchema {
return inputSchema()
},
get outputSchema(): OutputSchema {
return outputSchema()
},
userFacingName() {
return 'TaskList'
},
shouldDefer: true,
isEnabled() {
return isTodoV2Enabled()
},
isConcurrencySafe() {
return true
},
isReadOnly() {
return true
},
renderToolUseMessage() {
return null
},
async call() {
const taskListId = getTaskListId()
const allTasks = (await listTasks(taskListId)).filter(
t => !t.metadata?._internal,
)
// Build a set of resolved task IDs for filtering
const resolvedTaskIds = new Set(
allTasks.filter(t => t.status === 'completed').map(t => t.id),
)
const tasks = allTasks.map(task => ({
id: task.id,
subject: task.subject,
status: task.status,
owner: task.owner,
blockedBy: task.blockedBy.filter(id => !resolvedTaskIds.has(id)),
}))
return {
data: {
tasks,
},
}
},
mapToolResultToToolResultBlockParam(content, toolUseID) {
const { tasks } = content as Output
if (tasks.length === 0) {
return {
tool_use_id: toolUseID,
type: 'tool_result',
content: 'No tasks found',
}
}
const lines = tasks.map(task => {
const owner = task.owner ? ` (${task.owner})` : ''
const blocked =
task.blockedBy.length > 0
? ` [blocked by ${task.blockedBy.map(id => `#${id}`).join(', ')}]`
: ''
return `#${task.id} [${task.status}] ${task.subject}${owner}${blocked}`
})
return {
tool_use_id: toolUseID,
type: 'tool_result',
content: lines.join('\n'),
}
},
} satisfies ToolDef<InputSchema, Output>)