Move document to review stage
move-document-to-review-stageMoves a document to the review stage.
Use this tool when:
The document's current stage is one of: draft, approved_draft, approved_review, signing or done
You want to share the document for review before moving to a later stage
This stage transition may be blocked by checkpoints on the document, or - when reverting a document that was not created from a template - by an account that only allows signing to start from a template. A refusal here reports just the first problem it runs into; call get-document-info first and read workflow_state.stage_transitions.review.blockers to see everything that is in the way at once.
If the document is in the process of being signed, or has been signed already, moving back to review will cancel the current signing process and invalidate any existing signatures.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"document_uuid": "<document_uuid>"
},
"name": "move-document-to-review-stage"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| document_uuid | Yes | UUID of the document to move to review. If you don't already have the document's UUID, use the list-documents tool to find it. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | URL to open the document in fynk | |
| name | No | Name of the document | |
| uuid | No | Unique identifier for the document. Do not show to the user unless they ask for it | |
| stage | No | What stage the document is in currently | |
| _entity_type | No | Only relevant for tooling. Do not show to the user | |
| document_type | No | If present, indicates what kind of document this is. Absent when the document has no type assigned | |
| workflow_state | No | Gives an indication of which stage transitions, etc are possible to perform on this document. This object is technical state, not display content: when relaying it to the user, always render it as natural-language prose and never echo raw field names or snake_case values (e.g. say 'signing cannot be started yet because not every signature block has been assigned to a signatory' instead of mentioning 'can_start_signing' or 'signature_block_signatory'). |