create_control_note
Create markdown documentation notes attached to compliance controls, with preview and confirmation to prevent unintended changes.
Instructions
Create a documentation note on a control.
This tool creates a markdown documentation note that is attached to a control.
✅ CONFIRMATION-BASED SAFETY FLOW
When confirm=False: → The tool returns a PREVIEW of the generated markdown note. → The user may edit the note before confirming.
When confirm=True: → The note is permanently created and attached to the control.
Args:
controlId (str): The control ID where the note will be attached (required).
assessmentId (str): The assessment ID or asset ID that contains the control (required).
notes (str): The documentation content in MARKDOWN format (required).
topic (str, optional): Topic or subject of the note.
confirm (bool, optional):
- False → Preview only (default, no persistence)
- True → Create and permanently attach the note
Returns: Dict with success status and note data: - success (bool): Whether the request was successful - note (dict, optional): Created note object containing: - id (str): Note ID - topic (str): Note topic - notes (str): Note content in markdown format - controlId (str): Control ID the note is attached to - assessmentId (str): Assessment ID - error (str, optional): Error message if request failed - next_action (str, optional): Recommended next action
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| controlId | Yes | ||
| assessmentId | Yes | ||
| notes | Yes | ||
| topic | Yes | ||
| confirm | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||