Create a prompt
Create or edit prompts, configure settings, and use them in agents or playbooks.
Creating a prompt turns custom requests into reusable AI prompts. Use prompts in playbooks or as Actions for Agents.
Navigate to Investigation & Response → Automation → AI Prompts.
Click + New Prompt.
Add an identifying name for the prompt.
Save the prompt.
Enter the prompt settings.
Enter the prompt in the Prompt pane.
For help writing effective prompts, see Write effective prompts.
The Prompt Helper also provides a list of prompt writing tips, including:
Add relevant inputs.
Inputs can be set with either context path or specific value. You can choose whether the input is a variable using ${<input name>}.
Add relevant outputs:
Context path: The issue field the task results are saved to. For example, issue.AIseverity. This enables tasks that follow to locate the correct context and use that context as input.
Description (Optional): Description of the output.
Type (Optional): Unknown, String, Number, Date, Boolean.
Use Structured output (Optional) You can choose to Use Structured output to enforce a specific JSON structure by providing a custom JSON schema. This ensures the model's response matches your required format, allowing subsequent playbook tasks to successfully use the output. When you select Use structured output in the Outputs tab you are provided with a JSON template that you can edit or replace entirely. If your JSON includes an invalid type, an error message appears and provides a list of the correct types.
(Optional) Click Optimize to improve the prompt using predefined system guidelines.
The suggested prompt replaces the existing one. You can undo the optimization if needed.
(Recommended) Click Test to validate your prompt.
In the Arguments section, provide values for any inputs your prompt requires. These inputs are used to simulate how the prompt will behave in a live playbook, or how the prompt as an Action for an Agent will run as part of an executed plan.
You can add input values manually.
Click Run.
The tests are executed in a Playground environment. Review the output generated by the AI to validate the prompt's behavior and ensure it produces the expected results. The output is typically a text summary or another structured format that you have defined.
(Optional) Click
and select Register new Action to register the prompt as an Action and make it available for Agents. For more information, see Manage actions.
(Optional) Add the prompt as an AI prompt task to a playbook.
Edit or create a playbook.
In the playbook editor, expand the Task Library and select AI Prompts.
The System tab contains system AI prompt tasks, and the Custom tab contains custom AI prompt tasks.
Select the relevant AI prompt task and drag it onto the playbook editor.
The Task Details pane opens with the prompt appearing in the Prompt field.
Click OK.
The prompt appears in the playbook editor.
Last updated
Was this helpful?
