stories-update-task
Update task details like description, owners, or completion status within a Shortcut story to track progress and assign responsibilities.
Instructions
Update a task in a story
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| storyPublicId | Yes | The public ID of the story | |
| taskPublicId | Yes | The public ID of the task | |
| taskDescription | No | The description of the task | |
| taskOwnerIds | No | Array of user IDs to assign as owners of the task | |
| isCompleted | No | Whether the task is completed or not |
Implementation Reference
- src/tools/stories.ts:692-727 (handler)Handler function for the 'stories-update-task' tool. Updates a story task's description, owners, or completion status via the ShortcutClientWrapper.
async updateTask({ storyPublicId, taskPublicId, taskDescription, taskOwnerIds, isCompleted, }: { storyPublicId: number; taskPublicId: number; taskDescription?: string; taskOwnerIds?: string[]; isCompleted?: boolean; }) { if (!storyPublicId) throw new Error("Story public ID is required"); if (!taskPublicId) throw new Error("Task public ID is required"); const story = await this.client.getStory(storyPublicId); if (!story) throw new Error(`Failed to retrieve Shortcut story with public ID: ${storyPublicId}`); const task = await this.client.getTask(storyPublicId, taskPublicId); if (!task) throw new Error(`Failed to retrieve Shortcut task with public ID: ${taskPublicId}`); const updatedTask = await this.client.updateTask(storyPublicId, taskPublicId, { description: taskDescription, ownerIds: taskOwnerIds, isCompleted, }); let message = `Updated task for story sc-${storyPublicId}. Task ID: ${updatedTask.id}.`; if (isCompleted) { message = `Completed task for story sc-${storyPublicId}. Task ID: ${updatedTask.id}.`; } return this.toResult(message); } - src/tools/stories.ts:303-312 (schema)Input schema (Zod) for the 'stories-update-task' tool defining parameters: storyPublicId, taskPublicId, taskDescription, taskOwnerIds, isCompleted.
{ storyPublicId: z.number().positive().describe("The public ID of the story"), taskPublicId: z.number().positive().describe("The public ID of the task"), taskDescription: z.string().optional().describe("The description of the task"), taskOwnerIds: z .array(z.string()) .optional() .describe("Array of user IDs to assign as owners of the task"), isCompleted: z.boolean().optional().describe("Whether the task is completed or not"), }, - src/tools/stories.ts:300-314 (registration)Registration of the 'stories-update-task' tool in StoryTools.create() using server.addToolWithWriteAccess, specifying name, description, schema, and handler.
server.addToolWithWriteAccess( "stories-update-task", "Update a task in a story", { storyPublicId: z.number().positive().describe("The public ID of the story"), taskPublicId: z.number().positive().describe("The public ID of the task"), taskDescription: z.string().optional().describe("The description of the task"), taskOwnerIds: z .array(z.string()) .optional() .describe("Array of user IDs to assign as owners of the task"), isCompleted: z.boolean().optional().describe("Whether the task is completed or not"), }, async (params) => await tools.updateTask(params), );