All Tools
Lifecycle, discovery, collaboration. Filter by category, search by keyword, click any card to expand its full schema.
Create a new ticket. Always lands in backlog (s=bk).
Parameters
Name Type Default Notes title*string — Non-empty typeenum tsk bug · ft · tsk · ep · chr priorityenum m cr · h · m · l descriptionstring — labelsstring[] [] parent_idstring — Parent ticket ID exec_modeenum par par · seq exec_orderinteger — Required for seq children; UNIQUE(parent_id, exec_order) Returns
T{...}Example
TOON/1 T{id:myapp-011,t:Fix login bug,s:bk,p:h,typ:bug,ca:2024-01-15,ua:2024-01-15T10:00:00Z}Fetch a single ticket with full relations (comments, links, child IDs).
Parameters
Name Type Default Notes id*string — Returns
T{...} including cmt, lnk, ch arraysErrors
not_foundAtomically take ownership. Moves bk/td/bl → ip.
Parameters
Name Type Default Notes id*string — Returns
T{s:ip,...} — save ua as your etagErrors
conflictseq_blockednot_foundUpdate any field. Always supply etag when working with concurrent agents.
Parameters
Name Type Default Notes id*string — etagstring — ua from last read; stale → conflict titlestring — statusenum — bk · td · ip · dn · bl · cl priorityenum — typeenum — descriptionstring — assigneestring — labelsstring[] — Replaces entire array exec_modeenum — exec_orderinteger — Returns
T{...}Errors
conflictnot_foundinvalidSoft-delete. Sets archived_at. Excluded from all queries.
Parameters
Name Type Default Notes id*string — Returns
{ok:true}Filter tickets across any combination of fields. Ordered by created_at DESC.
Parameters
Name Type Default Notes statusenum — priorityenum — typeenum — labelsstring[] — AND filter limitinteger 50 max 200 include_archivedboolean false Returns
[T{...}]Priority-ordered view of bk tickets. Use this to decide what to do next.
Parameters
Name Type Default Notes priorityenum — typeenum — labelsstring[] — limitinteger 50 Returns
[T{...}] ordered cr → h → m → l, oldest-first within priorityKanban snapshot grouped by status.
Parameters
Name Type Default Notes typeenum — labelsstring[] — Returns
BOARD{bk:[...],td:[...],ip:[...],dn:[...],bl:[...],cl:[...]}Full-text search across title, description, labels via SQLite FTS5.
Parameters
Name Type Default Notes query*string — FTS5-ranked; supports phrase search include_archivedboolean false Returns
[T{...}] ranked by relevanceList children of a ticket, sorted by exec_order.
Parameters
Name Type Default Notes id*string — recursiveboolean false depthinteger 3 1-10; only when recursive=true Returns
[T{...}]Mermaid flowchart of ticket hierarchy with status colors.
Parameters
Name Type Default Notes id*string — Root of the diagram depthinteger 3 1-10 Returns
Mermaid flowchart TDAppend a note to a ticket.
Parameters
Name Type Default Notes id*string — body*string — authorstring llm Returns
Updated T{...} with new entry in cmtCreate a directional relationship between two tickets.
Parameters
Name Type Default Notes from_id*string — to_id*string — link_type*enum — blk · rel · dup Returns
{ok:true} (idempotent)
At a glance
Section titled “At a glance”flowchart TB
subgraph "Lifecycle"
A[ticket_create]
B[ticket_get]
C[ticket_claim]
D[ticket_update]
E[ticket_archive]
end
subgraph "Discovery"
F[ticket_list]
G[ticket_backlog]
H[ticket_board]
I[ticket_search]
J[ticket_children]
K[ticket_diagram]
end
subgraph "Collaboration"
L[ticket_comment]
M[ticket_link]
end
Lifecycle
Section titled “Lifecycle”| Tool | Required | Returns | When |
|---|---|---|---|
ticket_create | title | T{...} | Adding new work |
ticket_get | id | T{...} (with cmt, lnk, ch) | Reading a single ticket |
ticket_claim | id | T{s:ip,...} (atomic) | Taking ownership |
ticket_update | id | T{...} | Changing any field (always send etag) |
ticket_archive | id | {ok:true} | Hiding finished work |
Discovery
Section titled “Discovery”| Tool | Returns | Best for |
|---|---|---|
ticket_list | [T{...}] | Filtered queries (status, type, labels) |
ticket_backlog | [T{...}] priority-ordered | Start here. “What should I work on?” |
ticket_board | BOARD{bk:[],ip:[],...} | Kanban snapshot |
ticket_search | [T{...}] ranked | FTS5 keyword search |
ticket_children | [T{...}] | Listing subtasks of a parent |
ticket_diagram | Mermaid flowchart | Visualizing a hierarchy |
Collaboration
Section titled “Collaboration”| Tool | Required | Returns |
|---|---|---|
ticket_comment | id, body | T{...} (updated ticket) |
ticket_link | from_id, to_id, link_type | {ok:true} |
link_type is blk (blocks), rel (relates), or dup (duplicates).
Deeper reference
Section titled “Deeper reference”- API Guide — every parameter, every default
- Examples — annotated end-to-end workflows
- Troubleshooting — error code recovery playbook