Skip to content

Commit 5b974cd

Browse files
Docs enhancement
1 parent a4a7ff4 commit 5b974cd

File tree

2 files changed

+31
-7
lines changed

2 files changed

+31
-7
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,37 @@ src/
2424
└── tools.ts # MCP tool definitions
2525
```
2626

27+
## Data Schema and Storage
28+
29+
The task manager stores data in a JSON file:
30+
- **Default location**: `~/Documents/tasks.json` (in user's home directory)
31+
- **Custom location**: Set via `TASK_MANAGER_FILE_PATH` environment variable
32+
33+
```bash
34+
# Example of setting custom storage location
35+
TASK_MANAGER_FILE_PATH=/path/to/custom/tasks.json npm start
36+
```
37+
38+
The data schema is organized as follows:
39+
40+
```
41+
TaskManagerFile
42+
├── requests: RequestEntry[]
43+
├── requestId: string # Format: "req-{number}"
44+
├── originalRequest: string # Original user request text
45+
├── splitDetails: string # Additional request details
46+
├── completed: boolean # Request completion status
47+
└── tasks: Task[] # Array of tasks
48+
├── id: string # Format: "task-{number}"
49+
├── title: string # Short task title
50+
├── description: string # Detailed task description
51+
├── done: boolean # Task completion status
52+
├── approved: boolean # Task approval status
53+
└── completedDetails: string # Completion information
54+
```
55+
56+
The system persists this structure to the JSON file after each operation.
57+
2758
## Installation
2859

2960
```bash

tests/unit/example.test.ts

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)