task_digest
- Category: tasks
- Access: read
- Audience: ordinary (an ordinary user normally calls this directly)
Purpose
Renders the session-start digest: status counts plus the active today, inbox, and next sections, with past-due items highlighted first. A quick orientation read before choosing what to work on.
Arguments
Optional: include_overdue, limit.
-
include_overdue. Note: When true (default), up to 10 past-due items lead the digest. -
limit. Note: Caps the active section listing.
Result
JSON object with digest (markdown text starting with ## Task Digest), active_count, and overdue_count. An empty or out-of-scope view returns the bare header with both counts zero.
Boundaries
Only tasks inside the caller's project grants are counted and listed; notes are never part of the digest. No grants at all reads as an empty digest, never a denial.
Lifecycle / side effects
Pure read; rendering the digest changes nothing.
Errors
Unknown arguments and bad types are rejected (strict validator).
Example
{
"include_overdue": true,
"limit": 20
}
Result shape:
{
"active_count": 3,
"digest": "## Task Digest",
"overdue_count": 1
}
See also
query_tasks, ready_context, find_by_title, bump_overdue_priority.