Skip to content

Commit 48d5b36

Browse files
README update
1 parent 8b9627b commit 48d5b36

File tree

1 file changed

+26
-7
lines changed

1 file changed

+26
-7
lines changed

README.md

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,24 @@ TaskManagerFile
5757
├── description: string # Detailed task description
5858
├── status: string # Task status: "not started", "in progress", or "done"
5959
├── approved: boolean # Task approval status
60-
└── completedDetails: string # Completion information (required when status is "done")
60+
├── completedDetails: string # Completion information (required when status is "done")
61+
├── toolRecommendations: string # Suggested tools that might be helpful for this task
62+
└── ruleRecommendations: string # Suggested rules/guidelines to follow for this task
6163
```
6264

6365
The system persists this structure to the JSON file after each operation.
6466

67+
**Explanation of Task Properties:**
68+
69+
- `id`: A unique identifier for the task
70+
- `title`: A short, descriptive title for the task
71+
- `description`: A more detailed explanation of the task
72+
- `status`: The current status of the task (`not started`, `in progress`, or `done`)
73+
- `approved`: Indicates whether the task has been approved by the user
74+
- `completedDetails`: Provides details about the task completion (required when `status` is `done`)
75+
- `toolRecommendations`: A string containing suggested tools (by name or identifier) that might be helpful for completing this task. The LLM can use this to prioritize which tools to consider.
76+
- `ruleRecommendations`: A string containing suggested rules or guidelines that should be followed while working on this task. This can include things like "ensure all code is commented," "follow accessibility guidelines," or "use the company style guide". The LLM uses these to improve the quality of its work.
77+
6578
## Installation
6679

6780
```bash
@@ -289,15 +302,21 @@ This command displays information about all projects in the system or a specific
289302
'tasks': [
290303
{
291304
'title': "Set up project structure",
292-
'description': "Create repository and initialize with basic HTML/CSS/JS files"
305+
'description': "Create repository and initialize with basic HTML/CSS/JS files",
306+
'toolRecommendations': "create_directory, create_file, git_init",
307+
'ruleRecommendations': "Use consistent file naming, Initialize git repository"
293308
},
294309
{
295310
'title': "Design homepage",
296-
'description': "Create responsive homepage with navigation and hero section"
311+
'description': "Create responsive homepage with navigation and hero section",
312+
'toolRecommendations': "html_editor, css_editor, image_optimizer",
313+
'ruleRecommendations': "Follow accessibility guidelines (WCAG), Optimize for mobile-first"
297314
},
298315
{
299316
'title': "Implement about page",
300-
'description': "Create about page with company history and team section"
317+
'description': "Create about page with company history and team section",
318+
'toolRecommendations': "html_editor, css_editor",
319+
'ruleRecommendations': "Use clear and concise language, Include team member photos"
301320
}
302321
]
303322
}
@@ -309,9 +328,9 @@ This command displays information about all projects in the system or a specific
309328
// projectId: "proj-1234",
310329
// totalTasks: 3,
311330
// tasks: [
312-
// { id: "task-1", title: "Set up project structure", ... },
313-
// { id: "task-2", title: "Design homepage", ... },
314-
// { id: "task-3", title: "Implement about page", ... }
331+
// { id: "task-1", title: "Set up structure", ..., toolRecommendations: "...", ruleRecommendations: "..." },
332+
// { id: "task-2", title: "Design homepage", ..., toolRecommendations: "...", ruleRecommendations: "..." },
333+
// { id: "task-3", title: "Implement about page", ..., toolRecommendations: "...", ruleRecommendations: "..." }
315334
// ],
316335
// message: "Project created with 3 tasks"
317336
// }

0 commit comments

Comments
 (0)