update_control_note
Update an existing documentation note on a compliance control. Preview changes before saving, or confirm to permanently update the note.
Instructions
Update an existing documentation note on a control.
✅ PURPOSE This tool updates an existing note that was previously created on a control. It allows modification of the note content, topic, or both.
✅ CONFIRMATION-BASED SAFETY FLOW
When confirm=False: → The tool returns a PREVIEW of the updated markdown note. → The user may edit the note before confirming.
When confirm=True: → The note is permanently updated and saved.
Args:
controlId (str): The control ID where the note exists (required).
noteId (str): The note ID to update (required).
assessmentId (str): The assessment ID or asset ID that contains the control (required).
notes (str): The updated documentation content in MARKDOWN format (required).
topic (str, optional): Updated topic or subject of the note.
confirm (bool, optional):
- False → Preview only (default, no persistence)
- True → Update and permanently save the note
Returns: Dict with success status and note data: - success (bool): Whether the request was successful - message (str, optional): Success or error message - noteId (str, optional): Updated note ID - error (str, optional): Error message if request failed
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| controlId | Yes | ||
| noteId | Yes | ||
| assessmentId | Yes | ||
| notes | Yes | ||
| topic | Yes | ||
| confirm | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||