Skip to main content
A Playbook is a procedure document that AI Agent uses to handle employee inquiries. Based on registered Playbooks, AI Agent guides requesters through the appropriate procedure. There are two ways to register Playbooks: file upload and inline creation.

Register via file upload

Use file upload to register multiple Playbooks at once.
Supported file formats are Markdown (.md), plain text (.txt), CSV (.csv), Word (.docx), and PDF (.pdf). Each file can be up to 5MB, and you can upload up to 50 files per operation. Each file must start with YAML frontmatter specifying procedure_id, name, description, category, and subcategory.
1

Open the Playbook management screen

From the AI Helpdesk admin screen, select AI Playbook.
2

Select files

Click Upload Procedures and select the files you want to register. You can select multiple files at once.
3

Review and confirm

After upload, each file’s frontmatter and body are parsed, and any errors are shown per file. Review the content and click Upload.
If multiple files share the same procedure_id, only the first one loaded is registered. Review your files before uploading.

Register via inline creation

Create a Playbook directly in the WebUI text editor.
1

Open the Playbook management screen

From the AI Helpdesk admin screen, select AI Playbook.
2

Start creating

Click Add Procedure to open the creation form.
3

Write the Playbook

Enter the Playbook content in the text editor. For step notation, see Playbook step notation below.Screenshot of Playbook add form
4

Save

Click Save. The registered Playbook takes effect from the next triage onward.
Playbook list screenshot

Playbook specifications

General-purpose Playbook

When the Triage Agent cannot match an inquiry to any other Playbook, it falls back to a general-purpose Playbook. This fallback Playbook is stored as procedures/general.md. It appears in the list like any other Playbook and can be edited or deleted.
Keep the general-purpose Playbook’s content updated to provide a reasonable fallback experience. Deleting it removes the fallback response for unmatched inquiries, so proceed with caution.

When changes take effect

Registered or updated Playbook content takes effect from the next triage onward. Sessions already in progress are not affected.

Playbook step notation

Playbook steps contain a natural language description of the action the AI agent should perform. Use the {{tool_name}} syntax in the step body to explicitly reference a tool the AI agent should call.

How to reference tools

Embed {{tool_name}} inline in the step text.
Typing {{ in the text editor opens a tool-name autocomplete menu (typing / opens the full command menu). You can pick a tool from the menu instead of typing it by hand.

Available tools

Knowledge and document search Admina data lookup (MCP)
Admina MCP tools require the Admina MCP integration to be enabled in Settings > Integration. Tool names follow the {{mcp__admina__tool_name}} format. Check with your admin for the full list of available Admina tools.
Core tools
{{investigation}} and {{resolution_planning}} were removed as part of a prompt model refactor. The equivalent judgment is now built into the AI agent’s core instructions, so Playbooks no longer need to call them explicitly.

Contact chip syntax ({{escalation_contact}})

{{escalation_contact}} is a different tool from {{escalation}}. It isn’t an action the AI performs — it’s notation for displaying a contact clearly in the step text. Embedded with no attributes, it resolves to your tenant’s configured contact. Adding an attribute displays a specific contact as an icon-labeled chip.

Example

Tool references are optional. The AI agent selects tools from context even without them, but using {{tool_name}} makes tool selection more reliable and ensures expected behavior.
Last modified on July 10, 2026