Skip to content

Commit cb410a2

Browse files
authored
feat: Clarify content vs description usage and Markdown support (#139)
1 parent 3339029 commit cb410a2

File tree

2 files changed

+24
-4
lines changed

2 files changed

+24
-4
lines changed

src/tools/add-tasks.ts

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,18 @@ import {
1414
import { ToolNames } from '../utils/tool-names.js'
1515

1616
const TaskSchema = z.object({
17-
content: z.string().min(1).describe('The content of the task to create.'),
18-
description: z.string().optional().describe('The description of the task.'),
17+
content: z
18+
.string()
19+
.min(1)
20+
.describe(
21+
'The task name/title. Should be concise and actionable (e.g., "Review PR #123", "Call dentist"). For longer content, use the description field instead. Supports Markdown.',
22+
),
23+
description: z
24+
.string()
25+
.optional()
26+
.describe(
27+
'Additional details, notes, or context for the task. Use this for longer content rather than putting it in the task name. Supports Markdown.',
28+
),
1929
priority: PrioritySchema.optional().describe(
2030
'The priority of the task: p1 (highest), p2 (high), p3 (medium), p4 (lowest/default).',
2131
),

src/tools/update-tasks.ts

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,18 @@ const { FIND_TASKS_BY_DATE, GET_OVERVIEW } = ToolNames
1313

1414
const TasksUpdateSchema = z.object({
1515
id: z.string().min(1).describe('The ID of the task to update.'),
16-
content: z.string().optional().describe('The new content of the task.'),
17-
description: z.string().optional().describe('The new description of the task.'),
16+
content: z
17+
.string()
18+
.optional()
19+
.describe(
20+
'The new task name/title. Should be concise and actionable (e.g., "Review PR #123", "Call dentist"). For longer content, use the description field instead. Supports Markdown.',
21+
),
22+
description: z
23+
.string()
24+
.optional()
25+
.describe(
26+
'New additional details, notes, or context for the task. Use this for longer content rather than putting it in the task name. Supports Markdown.',
27+
),
1828
projectId: z.string().optional().describe('The new project ID for the task.'),
1929
sectionId: z.string().optional().describe('The new section ID for the task.'),
2030
parentId: z.string().optional().describe('The new parent task ID (for subtasks).'),

0 commit comments

Comments
 (0)