Command · Add Review Note
review.add
A frame-accurate comment on the sequence: at "time" (a frame) or from "start" to "end", optionally pointing at a spot or rectangle of the frame ("mark"), by "author".
- v1
- Capability EditProject
- Tool
review_add
Request
{
"command": "review.add",
"params": {
"author": "Client",
"mark": {
"height": 0.1,
"width": 0.2,
"x": 0.7,
"y": 0.05
},
"text": "The logo is too small",
"time": "00:00:12:05"
}
}Parameters
authorstring- Who wrote it.
endinteger | string- The end of the range (exclusive). Timecode in the sequence's rate ("00:01:02:03") or ticks.
markobject- Where on the frame: a rectangle in frame fractions from the top left (width = height = 0: a point).
mark.heightnumber (0.0..1.0)- Height, 0..1 (default 0).
mark.widthnumber (0.0..1.0)- Width, 0..1 (default 0).
mark.xnumber (0.0..1.0)Required- Left, 0..1.
mark.ynumber (0.0..1.0)Required- Top, 0..1.
sequenceinteger (1..)- Sequence id; only needed when the project has several.
startinteger | string- Or the start of a range. Timecode in the sequence's rate ("00:01:02:03") or ticks.
textstringRequired- The comment (UTF-8).
timeinteger | string- The frame it is about. Timecode in the sequence's rate ("00:01:02:03") or ticks.
Discussion
A frame-accurate comment on the sequence: at "time" (a frame) or from "start" to "end", optionally pointing at a spot or rectangle of the frame ("mark"), by "author". Returns its id.
Run it with wabcut-cli cmd <project> --json, from an MCP client as review_add, or from an extension. See Edit commands for requests, references and results.
See also
review.*
- review.exportPackage
Export Review Package. Writes a review package folder for a client or reviewer: notes.json (the notes with timecodes) and index.html (one self-contained page with a thumbnail per note, its mark drawn on it), plus the thumbnails in frames/.
- review.importPackage
Import Review Package. Reads a review package's notes back (one undo step): replies and status update the matching notes (by id, else by sequence, time and text), new notes are added at their timecodes, and notes that cannot be placed or that changed on both sides are listed as conflicts and left out.
- review.list
Review Notes. The review notes of the sequence ("sequence"; all the project's without it), in time order, with their timecodes, mark, author, status and replies ([author, text, createdAt]).
- review.remove
Delete Review Note. Deletes a note and its replies.
- review.reply
Reply to Review Note. Adds a reply to a note's thread.
- review.resolve
Resolve Review Note. Marks a note resolved (or open again with "resolved": false).
- review.toMarkers
Review Notes to Markers. Turns the sequence's review notes ("notes", or all of them) into sequence markers: named after the note's first line, the comment holding the text, author and replies, red while open, green once resolved.