fetch_rule_design_notes
Retrieve or create design notes for a compliance rule, with options to modify or regenerate after reviewing existing content.
Instructions
Fetch and manage design notes for a rule.
WORKFLOW:
CHECK EXISTING NOTES:
Always check if design notes exist for the rule first (whether user wants to create or view)
If found: Present complete notebook to user in readable format
If not found: Offer to create new ones
IF NOTES EXIST:
Show complete notebook with all sections (this serves as the VIEW)
Ask: "Here are your design notes. Modify or regenerate?"
USER OPTIONS:
MODIFY:
Ask "Do you need any changes to the design notes?"
If no changes needed: Get user confirmation, then call create_design_notes() to update
If changes needed: Collect modifications, show preview, get confirmation, then call create_design_notes() to update
REGENERATE:
Generate the design notes using generate_design_notes_preview()
Show preview to user
Get user confirmation
If confirmed: Call create_design_notes() to save the regenerated design notes
CANCEL: End workflow
IF NO NOTES EXIST:
Inform user no design notes found
Ask: "Create comprehensive design notes for this rule?"
If yes: Generate the design notes using generate_design_notes_preview()
Show preview to user
Get user confirmation
If confirmed: Call create_design_notes() to generate
KEY RULES:
MUST follow this workflow explicitly step by step
Always check for existing notes first whenever user asks about design notes (create or view)
ALWAYS get user confirmation before calling create_design_notes()
If any updates needed, explicitly call create_design_notes() tool to save changes
Present notes in Python notebook format
Use create_design_notes() for creation and updates
Args: rule_name: Name of the rule
Returns: Dict with success status, rule name, design notes content, and error details
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rule_name | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||