piyaz_get
Read one task or one project.
Pass exactly one of task ('QFN-42' or UUID) or project ('QFN' or UUID). ALWAYS fetch before reasoning about a task; pick the lightest shape that answers the question. Task lenses: summary=header+description+counts+1-hop edges with notes (lightest with edges). working=criteria with ids, decisions with ids, links with ids, 1-hop edges, the edit-address read. agent=multi-hop deps + upstream execution records + related tasks (~4-8K tokens); fetch BEFORE coding; terminal tasks return the retrospective record instead. planning=project description, prereqs, work-so-far, downstream specs, abandoned approaches; fetch BEFORE writing a plan. review=implementationPlan beside executionRecord + PR link + review-lens prompts (for in_review tasks). record=retrospective for done/cancelled tasks. fields=[...]: raw single-field read (lens ignored); the cheapest way to fetch one field's exact text before a piyaz_edit str_replace, or collection ids before by-id ops; response includes updatedAt for ifUpdatedAt preconditions. Project: view='meta' (categories, tag vocabulary, progress, check before setting category or coining tags) or view='overview' (every task + edge; HEAVY, at most once per session; truncated groups name the piyaz_search filter to narrow with).
Lenses
| Lens | Purpose |
|---|---|
summary | header + description + counts + 1-hop edges with notes (lightest with edges) |
working | criteria/decisions/links WITH their ids (the edit-address read) + 1-hop edges |
agent | multi-hop deps + upstream execution records + related (non-blocking) tasks; fetch BEFORE coding; done/cancelled tasks return the retrospective record instead |
planning | project description, prereqs, work-so-far, downstream specs, abandoned approaches; fetch BEFORE writing the implementation plan |
review | implementationPlan alongside executionRecord, PR link, AC evaluation, review-lens prompts; for in_review tasks |
record | retrospective bundle (outcome, decisions, PR link) for done/cancelled tasks |
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
lens | "summary" | "working" | "agent" | "planning" | "review" | "record" | No | Task reads only; default 'working'. summary=header + description + counts + 1-hop edges with notes (lightest with edges). working=criteria/decisions/links WITH their ids (the edit-address read) + 1-hop edges. agent=multi-hop deps + upstream execution records + related (non-blocking) tasks; fetch BEFORE coding; done/cancelled tasks return the retrospective record instead. planning=project description, prereqs, work-so-far, downstream specs, abandoned approaches; fetch BEFORE writing the implementation plan. review=implementationPlan alongside executionRecord, PR link, AC evaluation, review-lens prompts; for in_review tasks. record=retrospective bundle (outcome, decisions, PR link) for done/cancelled tasks. |
detail | "concise" | "detailed" | No | Project overview only. concise (default) drops the tag vocabulary and per-task tags; detailed includes them. |
fields | ("title" | "description" | "status" | "category" | "priority" | "estimate" | "tags" | "files" | "implementationPlan" | "executionRecord" | "acceptanceCriteria" | "decisions" | "links" | "assignees")[] | No | Task reads only. Raw field read: returns exactly these fields' current values (lens ignored) plus updatedAt for ifUpdatedAt preconditions. Collection fields include item ids for piyaz_edit by-id ops. The cheapest read before a surgical edit, fetch ['implementationPlan'] to copy exact text for str_replace. |
limit | integer | No | Project overview only: per-status task-group cap (default 30). Truncated groups name the piyaz_search filter to fetch the rest. |
project | string | No | Project identifier ('QFN') or project UUID. Pass exactly one of task or project. |
task | string | No | taskRef ('QFN-42') or task UUID. Pass exactly one of task or project. |
view | "meta" | "overview" | No | Project reads only; default 'meta'. meta=header, description, status, categories, tag vocabulary with counts, progress; the cheap lookup before setting a category or coining tags. overview=every task grouped by status plus every edge; HEAVY, at most once per session; over-limit groups are truncated with the narrowing piyaz_search filter named inline. |
Last updated