Skip to content

Commit 13480f2

Browse files
author
kiran-garre
committed
Update docs for introspect
1 parent 1f0185e commit 13480f2

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

crates/chat-cli/src/cli/chat/tools/introspect.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,9 @@ impl Introspect {
6262
documentation.push_str("\n\n--- docs/agent-file-locations.md ---\n");
6363
documentation.push_str(include_str!("../../../../../../docs/agent-file-locations.md"));
6464

65+
documentation.push_str("\n\n--- docs/todo-lists.md ---\n");
66+
documentation.push_str(include_str!("../../../../../../docs/todo-lists.md"));
67+
6568
documentation.push_str("\n\n--- CONTRIBUTING.md ---\n");
6669
documentation.push_str(include_str!("../../../../../../CONTRIBUTING.md"));
6770

@@ -93,6 +96,8 @@ impl Introspect {
9396
documentation
9497
.push_str("• Experiments: https://github.com/aws/amazon-q-developer-cli/blob/main/docs/experiments.md\n");
9598
documentation.push_str("• Agent File Locations: https://github.com/aws/amazon-q-developer-cli/blob/main/docs/agent-file-locations.md\n");
99+
documentation
100+
.push_str("• Todo Lists: https://github.com/aws/amazon-q-developer-cli/blob/main/docs/todo-lists.md\n");
96101
documentation
97102
.push_str("• Contributing: https://github.com/aws/amazon-q-developer-cli/blob/main/CONTRIBUTING.md\n");
98103

docs/todo-lists.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,13 @@ If lists exist but won't load:
9292
2. **Verify format**: Lists should be valid JSON files
9393
3. **Check file integrity**: Corrupted files may prevent loading
9494

95+
## `todo_list` vs. `/todos`
96+
The `todo_list` tool is specifically for the model to call. The model is allowed to create TODO lists, mark tasks as complete, add/remove
97+
tasks, load TODO lists with a given ID (which are automatically provided when resuming TODO lists), and search for existing TODO lists.
98+
99+
The `/todos` command is for the user to manage existing TODO lists created by the model. The user can view, resume, and delete TODO lists
100+
by using the appropriate subcommand and selecting the TODO list to perform the action on.
101+
95102
## Examples
96103
#### Asking Q to make a TODO list:
97104
```
@@ -109,7 +116,7 @@ If lists exist but won't load:
109116
● Completed in 0.4s
110117
```
111118

112-
#### Selecting a TODO list to view
119+
#### Selecting a TODO list to view:
113120
```
114121
> /todos view
115122
@@ -118,7 +125,7 @@ If lists exist but won't load:
118125
✔ Completed todo list (3/3)
119126
```
120127

121-
#### Resuming a TODO list (after selecting)
128+
#### Resuming a TODO list (after selecting):
122129
```
123130
> /todos resume
124131

0 commit comments

Comments
 (0)