<style> .chartjs-size-monitor { display: none !important; height: 0 !important; overflow: hidden !important; }p { margin: 0; }span.fr-emoticon.fr-emoticon-img { background-repeat: no-repeat !important; font-size: inherit; height: 1em; width: 1em; min-height: 20px; min-width: 20px; display: inline-block; margin: -0.1em 0.1em 0.1em; line-height: 1; vertical-align: middle; } span.fr-emoticon { font-weight: normal; font-family: "Apple Color Emoji", "Segoe UI Emoji", "NotoColorEmoji", "Segoe UI Symbol", "Android Emoji", "EmojiSymbols"; display: inline; line-height: 0; } blockquote { border-left: solid 2px #5e35b1; color: #5e35b1; margin-left:0; padding-left:5px;}blockquote blockquote{ border-color: #00bcd4; color: #00bcd4;}blockquote blockquote blockquote{ border-color: #43a047; color: #43a047;} table.grid{ border-collapse: collapse;} table.grid td, table.grid th { border: 1px solid #ddd;} .fr-fic.fr-dib{ display: block; margin: 5px auto;}.fr-fic.fr-dib.fr-fir{ text-align: right; margin: 5px 0 5px auto;}.fr-fic.fr-dib.fr-fil{ text-align: left; margin: 5px auto 5px 0;}.fr-fic.fr-dii{ float: none; margin: 5px auto;}.fr-fic.fr-dii.fr-fil{ float: left; margin: 5px auto;}.fr-fic.fr-dii.fr-fir{ float: right; margin: 5px auto;}img.fr-dib.fr-fir { margin-right: 0; text-align: right;}img.fr-dib.fr-fil { margin-left: 0; text-align: left;}img.fr-dib { margin: 5px auto; display: block; float: none;}img.fr-bordered { box-sizing: content-box; border: solid 5px #CCC;}img.fr-shadow { box-shadow: 10px 10px 5px 0px #cccccc;}img.fr-rounded { border-radius: 10px; -moz-border-radius: 10px; -webkit-border-radius: 10px; -moz-background-clip: padding; -webkit-background-clip: padding-box; background-clip: padding-box;}</style><style>
.chartjs-size-monitor {
display: none !important; height: 0 !important; overflow: hidden !important;
}
p {
margin: 0;
}
span.fr-emoticon.fr-emoticon-img {
background-repeat: no-repeat !important; font-size: inherit; height: 1em; width: 1em; min-height: 20px; min-width: 20px; display: inline-block; margin: -0.1em 0.1em 0.1em; line-height: 1; vertical-align: middle;
}
span.fr-emoticon {
font-weight: normal; font-family: "Apple Color Emoji", "Segoe UI Emoji", "NotoColorEmoji", "Segoe UI Symbol", "Android Emoji", "EmojiSymbols"; display: inline; line-height: 0;
}
blockquote {
border-left: solid 2px #5e35b1; color: #5e35b1; margin-left: 0; padding-left: 5px;
}
blockquote blockquote {
border-color: #00bcd4; color: #00bcd4;
}
blockquote blockquote blockquote {
border-color: #43a047; color: #43a047;
}
table.grid {
border-collapse: collapse;
}
table.grid td,
table.grid th {
border: 1px solid #ddd;
}
.fr-fic.fr-dib {
display: block; margin: 5px auto;
}
.fr-fic.fr-dib.fr-fir {
text-align: right; margin: 5px 0 5px auto;
}
.fr-fic.fr-dib.fr-fil {
text-align: left; margin: 5px auto 5px 0;
}
.fr-fic.fr-dii {
float: none; margin: 5px auto;
}
.fr-fic.fr-dii.fr-fil {
float: left; margin: 5px auto;
}
.fr-fic.fr-dii.fr-fir {
float: right; margin: 5px auto;
}
img.fr-dib.fr-fir {
margin-right: 0; text-align: right;
}
img.fr-dib.fr-fil {
margin-left: 0; text-align: left;
}
img.fr-dib {
margin: 5px auto; display: block; float: none;
}
img.fr-bordered {
box-sizing: content-box; border: solid 5px #CCC;
}
img.fr-shadow {
box-shadow: 10px 10px 5px 0px #cccccc;
}
img.fr-rounded {
border-radius: 10px; -moz-border-radius: 10px; -webkit-border-radius: 10px; -moz-background-clip: padding; -webkit-background-clip: padding-box; background-clip: padding-box;
}
</style><style>
.chartjs-size-monitor {
display: none !important; height: 0 !important; overflow: hidden !important;
}
p {
margin: 0;
}
span.fr-emoticon.fr-emoticon-img {
background-repeat: no-repeat !important; font-size: inherit; height: 1em; width: 1em; min-height: 20px; min-width: 20px; display: inline-block; margin: -0.1em 0.1em 0.1em; line-height: 1; vertical-align: middle;
}
span.fr-emoticon {
font-weight: normal; font-family: "Apple Color Emoji", "Segoe UI Emoji", "NotoColorEmoji", "Segoe UI Symbol", "Android Emoji", "EmojiSymbols"; display: inline; line-height: 0;
}
blockquote {
border-left: solid 2px #5e35b1; color: #5e35b1; margin-left: 0; padding-left: 5px;
}
blockquote blockquote {
border-color: #00bcd4; color: #00bcd4;
}
blockquote blockquote blockquote {
border-color: #43a047; color: #43a047;
}
table.grid {
border-collapse: collapse;
}
table.grid td,
table.grid th {
border: 1px solid #ddd;
}
.fr-fic.fr-dib {
display: block; margin: 5px auto;
}
.fr-fic.fr-dib.fr-fir {
text-align: right; margin: 5px 0 5px auto;
}
.fr-fic.fr-dib.fr-fil {
text-align: left; margin: 5px auto 5px 0;
}
.fr-fic.fr-dii {
float: none; margin: 5px auto;
}
.fr-fic.fr-dii.fr-fil {
float: left; margin: 5px auto;
}
.fr-fic.fr-dii.fr-fir {
float: right; margin: 5px auto;
}
img.fr-dib.fr-fir {
margin-right: 0; text-align: right;
}
img.fr-dib.fr-fil {
margin-left: 0; text-align: left;
}
img.fr-dib {
margin: 5px auto; display: block; float: none;
}
img.fr-bordered {
box-sizing: content-box; border: solid 5px #CCC;
}
img.fr-shadow {
box-shadow: 10px 10px 5px 0px #cccccc;
}
img.fr-rounded {
border-radius: 10px; -moz-border-radius: 10px; -webkit-border-radius: 10px; -moz-background-clip: padding; -webkit-background-clip: padding-box; background-clip: padding-box;
}
</style><style>
p {
margin: 0;
}
span.fr-emoticon.fr-emoticon-img {
background-repeat: no-repeat !important; font-size: inherit; height: 1em; width: 1em; min-height: 20px; min-width: 20px; display: inline-block; margin: -0.1em 0.1em 0.1em; line-height: 1; vertical-align: middle;
}
span.fr-emoticon {
font-weight: normal; font-family: "Apple Color Emoji", "Segoe UI Emoji", "NotoColorEmoji", "Segoe UI Symbol", "Android Emoji", "EmojiSymbols"; display: inline; line-height: 0;
}
blockquote {
border-left: solid 2px #5e35b1; color: #5e35b1; margin-left: 0; padding-left: 5px;
}
blockquote blockquote {
border-color: #00bcd4; color: #00bcd4;
}
blockquote blockquote blockquote {
border-color: #43a047; color: #43a047;
}
table.grid {
border-collapse: collapse;
}
table.grid td,
table.grid th {
border: 1px solid #ddd;
}
.fr-fic.fr-dib {
display: block; margin: 5px auto;
}
.fr-fic.fr-dib.fr-fir {
text-align: right; margin: 5px 0 5px auto;
}
.fr-fic.fr-dib.fr-fil {
text-align: left; margin: 5px auto 5px 0;
}
.fr-fic.fr-dii {
float: none; margin: 5px auto;
}
.fr-fic.fr-dii.fr-fil {
float: left; margin: 5px auto;
}
.fr-fic.fr-dii.fr-fir {
float: right; margin: 5px auto;
}
img.fr-dib.fr-fir {
margin-right: 0; text-align: right;
}
img.fr-dib.fr-fil {
margin-left: 0; text-align: left;
}
img.fr-dib {
margin: 5px auto; display: block; float: none;
}
img.fr-bordered {
box-sizing: content-box; border: solid 5px #CCC;
}
img.fr-shadow {
box-shadow: 10px 10px 5px 0px #cccccc;
}
img.fr-rounded {
border-radius: 10px; -moz-border-radius: 10px; -webkit-border-radius: 10px; -moz-background-clip: padding; -webkit-background-clip: padding-box; background-clip: padding-box;
}
</style><p><span style="font-size: 11pt;"><strong>In this guide we will cover:</strong></span></p><p><a href="#overview"><span style="font-size: 11pt;"><strong>- Overview</strong></span></a></p><p><a href="#setup-process-for-halo-mcp-ai-agent"><span style="font-size: 11pt;"><strong>- Setup Process For Halo MCP AI Agent</strong></span></a></p><p style="margin-left: 20px;"><a href="#data-sources-report"><span style="font-size: 11pt;"><strong>- Data Sources report</strong></span></a></p><p style="margin-left: 20px;"><a href="#ai-run-report-runbook"><span style="font-size: 11pt;"><strong>- AI Run Report Runbook</strong></span></a></p><p style="margin-left: 20px;"><a href="#operations-agent"><span style="font-size: 11pt;"><strong>- Operations Agent</strong></span></a></p><p style="margin-left: 20px;"><a href="#haloai-agent-chat-profile"><span style="font-size: 11pt;"><strong>- HaloAI Agent Chat Profile</strong></span></a></p><p><a href="#the-chatbot-in-action"><span style="font-size: 11pt;"><strong>- The ChatBot In Action</strong></span></a></p><p><span style="font-size: 11pt;"><strong><br></strong></span></p><p><span style="font-size: 11pt;"><strong>Related Guides:</strong></span></p><ul><li style="font-size: 11pt; font-weight: bold;"><strong><a href="https://www.usehalo.com/guides/2783" target="_blank" rel="noopener noreferrer" style="font-weight: bold; font-size: 11pt;">AI Agents</a></strong></li><li style="font-size: 11pt; font-weight: bold;"><strong><a href="https://www.usehalo.com/guides/1630" target="_blank" rel="noopener noreferrer" style="font-weight: bold; font-size: 11pt;">Custom Integrations/Runbooks</a></strong></li><li style="font-size: 11pt; font-weight: bold;"><a href="https://www.usehalo.com/guides/2335" target="_blank" rel="noopener noreferrer" style="font-weight: bold; font-size: 11pt;"><strong>Chat Bot and Chat Profiles</strong></a></li></ul><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 14pt;"><a id="overview" class="fr-anchor" title="overview"></a><strong>Overview</strong></span></p><p data-pasted="true"><span style="font-size: 11pt;">When using the ChatBot, Halo's MCP server can be leveraged by AI Agents in order to evaluate your data and carry out actions within your Halo environment. As an example, this can be useful for obtaining quick data on your team and checking in on your profit and loss figures, or quickly checking off action points without having to leave your current page. </span></p><p><span style="font-size: 11pt;"><br style="box-sizing: inherit;"></span></p><p><span style="font-size: 11pt;"><strong>This guide is a walk-through for setting up this chat functionality from scratch in environments deployed <u>before</u> September 2026.</strong> If your Halo environment was deployed in September 2026 or later, then this functionality may be largely pre-configured in your environment. If so, you should instead use the following guide for the small amount of setup required: <a href="https://www.usehalo.com/guides/2875" target="_blank" rel="noopener noreferrer" style="font-size: 11pt;">Using the Halo MCP AI Agent Chat</a>.</span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;">As this functionality utilises the <a href="https://www.usehalo.com/guides/2336" target="_blank" rel="noopener noreferrer">Conversational Agent</a> functionality, you do not need to plug in your own AI connection for it to function and you can use the default Halo connection if you wish to do so. </span></p><p><span style="font-size: 11pt;"><br style="box-sizing: inherit;"></span></p><p><span style="font-size: 11pt;"><strong>How does it work?</strong></span></p><p data-pasted="true">Within the "HaloAI Agent" chat profile, there is a singular step to execute a Virtual Agent conversation. When this step is triggered, a pre-configured Operations Agent is prompted to get data or suggest actions relevant to the chat user's request. </p><p><br></p><p>In the event that the chat user requests any information regarding Tickets, the Operations Agent will trigger an additional runbook called "AI Run Report". This allows it to efficiently query the database, using a payload chosen by the Operations Agent, and return accurate Ticketing data to the chat user.</p><p><br></p><p dir="ltr" data-pasted="true"><strong>What can the agent do?</strong></p><p dir="ltr">The Agent lets you check and update your Tickets without leaving the page you are on. Ask for your open or closed Tickets and it will pull them into a table. Ask it to add a note to a Ticket, such as confirming an issue is resolved, and it will do that for you. It works from the Data Sources report in the reporting online repository, so you can ask about any Ticket data those sources cover.</p><p dir="ltr"><br></p><p dir="ltr"><span style="font-size: 11pt;" data-pasted="true"><strong><em>Note: When utilising the MCP endpoint in Halo, it is advisable to enable the logs for this by navigating to Configuration > AI > MCP Server and turning on the setting "Enable MCP request logging". This will aid with any necessary troubleshooting.</em></strong></span></p><p dir="ltr"><br></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 14pt;"><a id="setup-process-for-halo-mcp-ai-agent" class="fr-anchor" title="setup-process-for-halo-mcp-ai-agent"></a><strong>Setup Process For Halo MCP AI Agent</strong></span></p><p><span style="font-size: 12pt;"><a id="data-sources-report" class="fr-anchor" title="data-sources-report"></a><strong>Data Sources Report</strong></span></p><p><span style="font-size: 11pt;">A function that you will see the Operations Agent perform is getting and returning Ticketing data to the chat - this is now achieved by the Operations Agent utilising the reporting endpoint. </span></p><p><span style="font-size: 11pt;">To facilitate this, the Agent needs access to the 'Data Sources' report to gather all relevant data sources for ticketing and decide which is the correct one. This report needs to be downloaded to your Halo environment from the <a href="https://www.usehalo.com/guides/2425" target="_blank" rel="noopener noreferrer">reporting online repository</a>. </span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;">To do this, click into the reporting area in the navigation menu and select 'Online Repository'. </span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;"><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjBkZDAyNjhiLWFmYmEtNDQ2OC1hYzc3LTI2NGVjOGQ4ZTg2ZCJ9.IzkXWF0VDdXwtxR_YBRnFMYkUoKcQ_sry4l_WBZWdY4" class="fr-fic fr-fil fr-dib" width="1021" style="width: 1023px; height: 640.751px;" height="641"></span></p><p><span style="font-size: 10pt;"><strong>Fig 1. Navigating to the reporting online repository</strong></span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;">Search for and select the "Data Sources" report, then select the option to "add this report to my library". </span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;"><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjAyZDEwZmEyLTdiOGMtNGRkZS1iY2E1LWMxYzZlNTZkNGUyZSJ9.8LGEeUOtudKI6oWzmjX6tQVuGlSiTPOXySjHtlUbJgc" class="fr-fic fr-fil fr-dib" width="1008" style="width: 1010px; height: 634.908px;" height="635"></span></p><p><span style="font-size: 10pt;"><strong>Fig 2. Downloading the data sources report to your local Halo environment</strong></span></p><p><br></p><p><span style="font-size: 11pt;"><span style="font-size: 11pt;" data-pasted="true">Once your data sources report has been downloaded into your Halo, you then need to download the runbook which the Agent triggers once it has used its chosen data source to construct its report for the chat user.</span></span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 12pt;"><a id="ai-run-report-runbook" class="fr-anchor" title="ai-run-report-runbook"></a><strong>AI Run Report Runbook</strong></span></p><p><span style="font-size: 11pt;"><strong>Import The Runbook</strong></span></p><p><span style="font-size: 11pt;">To do this, we have attached the JSON for the runbook. Download the "AI Run Report Runbook JSON" attached file <a href="https://support.haloservicedesk.com/portal/kb?btn=46&id=2876" target="_blank" rel="noopener noreferrer">from this article on our Porta</a>l, and copy all of the JSON contained within the file.</span></p><p><span style="font-size: 11pt;">Go to the runbooks area in your Halo by navigating to Configuration > Integrations > Custom Integrations > Integration Runbooks and select the "Import from JSON" button in the top right corner. </span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;"><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImU2MDJlMGU2LTZjMDQtNDQ2NC04NjAxLTJjZGI3MTQ1ODc0YiJ9.419YYRpiywk4bEDBwlRgYK1iCi5PDm_n4lyJAEkH3D8" class="fr-fic fr-fil fr-dib" width="954" style="width: 956px; height: 765.061px;" height="765"></span></p><p><span style="font-size: 10pt;"><strong>Fig 3. The Import from JSON button to import a new runbook</strong></span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;">Selecting this button will bring up a modal screen into which you can paste the JSON that you copied. </span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;"><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVhODY3YjBiLWQ0ODItNDU5MS05YWY2LWJhMjA0YTU2ZThhMSJ9.Ob4AO4O4-VTXIZesePbKkJ64d-IBL0JypgD5hIqgvcw" class="fr-fic fr-fil fr-dib" width="798" style="width: 800px; height: 471.194px;" height="471"></span></p><p><span style="font-size: 10pt;"><strong>Fig 4. Importing the JSON for the AI Run Report runbook</strong></span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;">Paste the entire JSON body into the field and save, the runbook will then automatically appear in the list of runbooks in your Halo. </span></p><p><br></p><p><span style="font-size: 11pt;"><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImEzM2Q4ODhkLTQ1MDMtNDQwMC04MjZhLTNkYjQ4NjliMGZhMyJ9.MyT3cHCll__JKrWkBokT1QV0bEL3B1qJgrwck-Zfkaw" class="fr-fic fr-fil fr-dib" width="684" style="width: 686px; height: 450.252px;" height="450"></span></p><p><strong><span style="font-size: 10pt;">Fig 5. The AI Run Report runbook will appear once successfully imported</span></strong></p><p><br></p><p>Alternatively, you can import the runbook from Halo's runbook online repository. </p><p>To do this, click into the globe icon in the top right of the runbooks area, locate the "AI Run Report" runbook and select "Install to Halo".</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjlhMjg1ZTQ4LTU3YzMtNGY0YS1hZmVmLTIxN2Q0NDVlYjhhMyJ9.BrI_uho0Rf1h2DS1nxnSwxtOU6GBBNXlHWzqChGUJeA" class="fr-fic fr-fil fr-dib" width="567" style="width: 569px; height: 392.235px;" height="392"></p><p><strong><span style="font-size: 10pt;">Fig 6. Importing the AI Run Report runbook from the online repository</span></strong></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;"><strong>Create The Method</strong></span></p><p><span style="font-size: 11pt;">Once your runbook has been imported, you then need to create the the method for this runbook.</span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;">To do this, click into the runbook, press edit at the top left, click into the 'flow chart' tab and then click the icon in the top right of the first step of the runbook's flow chart to edit that step. </span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;"><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImM0MTY2ZjdiLTA3OTUtNDZmMi05YjQ1LTJjYjVkZmExNGQwOSJ9.4K96jSsXj_SGukNFJaSPRrpMrfho6mrCiRydmbloxus" class="fr-fic fr-fil fr-dib" width="702" style="width: 704px; height: 514.065px;" height="514"></span></p><p><span style="font-size: 10pt;"><strong>Fig 7. Editing the first step of the runbook</strong></span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;">Select the "New Method" button below the method field, and create your new method using the example in Figure 8 as reference. </span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;"><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijg4MTczNTAxLWQwZDEtNDE3OC1iMTA0LTk3Njg4NzM4MDhlOCJ9.6zZznPAR4yIAj2ym6mj9JGV9aAwkE8Rxi5D1Rw_bFMs" class="fr-fic fr-fil fr-dib" width="874" style="width: 876px; height: 567.254px;" height="567"></span></p><p><span style="font-size: 10pt;"><strong>Fig 8. Creating a new method for the runbook</strong></span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;">Save the method, the step, and then the runbook, and then we can create it's authentication - to do this, we need to create a custom integration and an API application for that custom integration.</span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;">Navigate to Configuration > Integrations > Halo API, and then select the "View Applications" button in the applications section of the page. </span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;"><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImM5MzEwZDE2LWMzMDQtNDEzZS04MTcyLWQyODc4ODBiNTM3OCJ9.QUSVczjYFOZ_vltzOKgcCx4E7C6vOGIxBVvzqkEvbp8" class="fr-fic fr-fil fr-dib" width="867" style="width: 869px; height: 652.746px;" height="653"></span></p><p><span style="font-size: 10pt;"><strong>Fig 9. Navigating to the API applications area of Halo</strong></span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;">Once in this area, select the "+ New" button in the top right corner to create a new API application. </span></p><p><span style="font-size: 11pt;">Create the application according to Figures 10a and 10b, ensuring that you set the authentication method to "Halo Automation Identity" and the permissions to "all:standard". </span></p><p><span style="font-size: 11pt;">Ensure you choose an Agent to login as that has the correct permissions for what you will want the Agent to be able to do and access, you can use an <a href="https://www.usehalo.com/guides/1670" target="_blank" rel="noopener noreferrer">API only Agent</a> here, or <a href="https://www.usehalo.com/guides/1823" target="_blank" rel="noopener noreferrer">Application Identity</a>. </span></p><p><br></p><p><span style="font-size: 11pt;"><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImViY2YxZTcyLWU1MWYtNDFmZC1hNDI4LTViNzQzNjFmOGExOSJ9.zSLmc9Ol2bAmCLj3gs2n39yjlnuajezVr1ww9N3AU1A" class="fr-fic fr-fil fr-dib" width="648" style="width: 650px; height: 487.5px;" height="488"></span></p><p><span style="font-size: 10pt;"><strong>Fig 10a. Set the authentication method for the application to Halo Automation Identity</strong></span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;"><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjExNjUwZmU0LTBmMzAtNGZhYi1hZjFlLTc1NDdlM2Y2Y2Q4OSJ9.WipbYlhbaHKa8IS3q6Ok7t0Z20XAWsavWVby8kORWD0" class="fr-fic fr-fil fr-dib" width="818" style="width: 820px; height: 482.572px;" height="483"></span></p><p><span style="font-size: 10pt;"><strong>Fig 10b. Set the permissions for the application to all:standard</strong></span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;">Save the application and then navigate to Configuration > Integrations > Custom Integrations > Custom Integrations and select "+ New" in the top right corner to create a new custom integration. </span></p><p><span style="font-size: 11pt;">Create the new custom integration according to Figure 11, ensuring that you keep the system integration as "None", set the connection to "Connect to your Halo", and set the "Run-as Application" to your newly created API application. </span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;"><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImY5NDM2OTBlLTNkYTctNGRlNC05YjI3LWU2OTNmY2FhNjhmYyJ9.49lh_DpwzvuO2irCxV7SE-TK0QjSUudBoQEvmFYQF5s" class="fr-fic fr-fil fr-dib" width="877" style="width: 879px; height: 712.805px;" height="713"></span></p><p><span style="font-size: 10pt;"><strong>Fig 11. Creating a new custom integration</strong></span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;">Save your custom integration, and then navigate back to your AI Run Report runbook via Configuration > Integrations > Custom Integrations > Integration Runbooks. </span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;">Edit your runbook and edit the same step as before where we created the new method. Select the "Edit Method" button underneath the method field on the step. </span></p><p><span style="font-size: 11pt;">In the integration field of your method, set your newly created custom integration, see Figure 12 for reference.</span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;"><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjhhNWMxZjViLTgxMjktNGRhNC1hY2Q4LTMxYWNhOWMyYzY3YSJ9.5rJp2MyNK_WFbc1VApPSaCr3FGrQkCH_u_qafl9Bnpo" class="fr-fic fr-fil fr-dib" width="913" style="width: 915px; height: 528.977px;" height="529"></span></p><p><span style="font-size: 10pt;"><strong>Fig 12. Setting the new custom integration for the AI Run Report runbook method</strong></span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;">Save the method, save the step, and then save the runbook. </span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 12pt;"><a id="operations-agent" class="fr-anchor" title="operations-agent"></a><strong>Operations Agent</strong></span></p><p><span style="font-size: 11pt;">Your next step is to create the <a href="https://www.usehalo.com/guides/2336" target="_blank" rel="noopener noreferrer" style="font-size: 11pt;">Operations Agent</a> that will be used for your Agent chat.</span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;">To do this, navigate to Configuration > AI > AI Agents and select the "Operations Agents" button within the "Conversational Agents" area of the page. Select the "+ New" button in the top right corner to create a new Operations Agent. </span></p><p><br></p><p><span style="font-size: 11pt;"><em><strong>Note: An Operations Agent is used for this process as it is an Agent facing chat. For the difference between the different Conversational AI Agents, see the guide: </strong></em><em><strong><a href="https://www.usehalo.com/guides/2336" target="_blank" rel="noopener noreferrer">Conversational Agents</a></strong></em><strong><em>.</em></strong></span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;">Give your Agent a name and then choose the AI connection of your choice. Halo's built-in OpenAI connection can be used, or you may use your own if you wish to do so. For details on the AI connections, see the guide: <a href="https://www.usehalo.com/guides/2385" target="_blank" rel="noopener noreferrer">Connecting AI to Halo</a>.</span></p><p><span style="font-size: 11pt;"><br></span></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImUwODE0OGQ3LTFmNDItNGRhMi1iMTZiLWRjNDg1MjhjODc4MyJ9.jV8JzDNyrci_xSC3qeJUK9Pr8DFFMnUQT5h8Zc72s-8" class="fr-fic fr-fil fr-dib" width="647" style="width: 649px; height: 521.733px;" height="522"></p><p><span style="font-size: 10pt;"><strong>Fig 13. Configuring the Operations Agent's connection</strong></span></p><p><br></p><p><span style="font-size: 11pt;">In the Assistant Fields section of your Agent you can configure your prompt. </span></p><p><br></p><p><span style="font-size: 11pt;"><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjdlYTI4Y2FmLTAxMDMtNGRhOC05NmU2LWEyMjM5ZTVmZWNhYSJ9.jubX7oNNKXH5mWdf9CTsGj47obaMlKCxkPB8cNkqI5k" class="fr-fic fr-fil fr-dib" width="811" style="width: 813px; height: 406.782px;" height="407"></span></p><p><br></p><p><strong>Fig 14. The Assistant Fields configuration for the Operations Agent</strong></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;">If you would like to use for your Agent the exact instructions used in pre-configured environments, then you can </span><span style="font-size: 11pt;"><a href="https://support.haloservicedesk.com/portal/kb?btn=46&id=3049" target="_blank" rel="noopener noreferrer">download the "Operations Agent Instructions" attached file from this article on our Portal</a></span><span style="font-size: 11pt;"> and copy all the content within the file. Paste this content into the instructions field on the Operations Agent. </span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;">In the functions section, ensure all system functions are included, and then create two new functions using the "+ Add" button:</span></p><ul><li style="font-size: 11pt;">get_data_sources <ul style="font-size: initial;"><li style="font-size: 11pt;">Use: Get Report Data</li><li style="font-size: 11pt;">Report: Data Sources</li></ul></li><li style="font-size: 11pt;">run_report<ul style="font-size: initial;"><li style="font-size: 11pt;">Use: Execute a Runbook</li><li style="font-size: 11pt;">Runbook: AI Run Report</li><li style="font-size: 11pt;">Runbook execution mode: Execute and await completion</li><li style="font-size: 11pt;">Parameters: report_payload (string, not mandatory)<br><br></li></ul></li></ul><p><span style="font-size: 11pt;"><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjllMzg0ZWY1LTJkOGUtNGJkNy1iMTBmLWQzMzg3YTI5ZjMwZiJ9.q8Ku26gG626zQf-94FK4UlFw4DnqM_pMntussiHcoEU" class="fr-fic fr-fil fr-dib" width="626" style="width: 628px; height: 481.195px;" height="481"></span></p><p><span style="font-size: 10pt;"><strong>Fig 15a. The function for running the data sources report</strong></span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;"><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImU1OGUyZjA4LTg1OWMtNDM5Mi1hZDNmLWIzMmRlY2VhYTRhYyJ9.gAn-J5TmyKHIqTGwe6Li0kkFvYnypB-_blhAmqFxpZ0" class="fr-fic fr-fil fr-dib" width="684" style="width: 686px; height: 666.364px;" height="666"></span></p><p><span style="font-size: 10pt;"><strong>Fig 15b. The function for running the AI Run Report runbook</strong></span></p><p><br></p><p><span style="font-size: 11pt;"><strong><em>Note: "CF_" is prepended to the function name by Halo, it should not be included when writing the function's name.</em></strong></span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;">Once your functions are created, save the Operations Agent. </span></p><p><br></p><p><br></p><p><span style="font-size: 12pt;"><a id="haloai-agent-chat-profile" class="fr-anchor" title="haloai-agent-chat-profile"></a><strong><span style="font-size: 12pt;" data-pasted="true"><strong>HaloAI Agent Chat Profile</strong></span></strong></span></p><p><span style="font-size: 11pt;">Now that you have your Operations Agent and its functions configured, the final step is to create the <a href="https://www.usehalo.com/guides/2335" target="_blank" rel="noopener noreferrer">Chat Profile</a> for your ChatBot.</span></p><p><span style="font-size: 11pt;"><br></span></p><p>To create the same chat profile used in pre-configured environments, you can <a href="https://support.haloservicedesk.com/portal/kb?btn=46&id=3049" target="_blank" rel="noopener noreferrer">download the "HaloAI Agent Chat Profile" file from this article on the portal</a> and copy all the JSON within the file. </p><p>Navigate to Configuration > Chat > Chat Profiles and select the "+ New" button in the top right to create a new profile.</p><p><br></p><p>Give the chat profile a name and click save. Then select the "Import from JSON" button on the profile and paste in your copied JSON. </p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjZmYzZiMTE4LWMzZDMtNDlmMi1hYTZjLTU2ZTEyMTVjYjNiNSJ9.n898vxYotnqVVA3KXd0FYx6HSuMVM7TV4ZX4Z1dR3fg" class="fr-fic fr-fil fr-dib" width="651" style="width: 653px; height: 504.378px;" height="504"></p><p><strong><span style="font-size: 10pt;">Fig 16. Importing the chat profile JSON</span></strong></p><p><br></p><p>Once successfully imported, you will see that a singular step has been created in the profile's Bot Flow tab. </p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImI5NTM5MmE1LWMzNTYtNGJjNy04ZTY0LWU5NTk2NWIzYTE0YyJ9.BlyYk64SJtir77Xx8Vuelg1OM62lU8TitBT12p46wAM" class="fr-fic fr-fil fr-dib" width="771" style="width: 773px; height: 473.849px;" height="474"></p><p><strong><span style="font-size: 10pt;">Fig 17. The chat profile consists of one step</span></strong></p><p><br></p><p>This step is a "Virtual Agent Conversation" and triggers the Agent configured earlier. </p><p>To ensure that the Agent is selected, edit the profile and the step, and then select the correct Virtual Agent in the "Virtual Agent" field. </p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjIzMmJlMmVhLWRkMmMtNDZjYi1iNmRmLTM4N2E1ODNhYTljNSJ9.lgk2rRe6hdl1gWNH8k8bZNQCbquzMCT_EUjXCTllqRY" class="fr-fic fr-fil fr-dib" width="748" style="width: 750px; height: 552.835px;" height="553"></p><p><strong><span style="font-size: 10pt;">Fig 18. Select the Virtual Agent in the chat profile step</span></strong></p><p><br></p><p>You can then customise the Agent via the instructions and failure message, if you wish to do so, and you can customise the team to which the Virtual Agent will transfer and the ticket type used if it needs to create a Ticket. </p><p><br></p><p>Once you have finished configuring the chat profile step, save the step. Before saving the profile, ensure the access is set correctly in the "Access Restrictions" section of the Details tab. </p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjIyOGRmNDFjLWMyM2MtNDhkZS04OTgyLWViZjRhZmRiNTdkZiJ9.MIdVpTfhtoa2EvxZNjSJJNohKpC4ZPTgjxLkWeW2ZB4" class="fr-fic fr-fil fr-dib" width="591" style="width: 593px; height: 403.41px;" height="403"></p><p><strong><span style="font-size: 10pt;">Fig 19. Access restrictions for the chat profile</span></strong></p><p><br></p><p>As this process leverages an Operations Agent, you will need to set the "Access" to be "Agent App". In the field below you can then set which Agent roles will have access to this Chat Bot.</p><p>After making any further customisations in the Details tab, save the chat profile. </p><p><br></p><p>Your Chat Bot is now fully configured.</p><p><br></p><p>For more guidance on configuring and customising chat profiles, see the dedicated guide: <a href="https://www.usehalo.com/guides/2335" target="_blank" rel="noopener noreferrer" data-pasted="true">Chat Bot and Chat Profiles</a>. </p><p><br></p><p><br></p><p data-pasted="true"><strong><span style="font-size: 14pt;"><a id="the-chatbot-in-action" class="fr-anchor" title="the-chatbot-in-action"></a>The ChatBot In Action</span></strong></p><p>As shown in Figures 20a and 20b respectively, to start a chat with the Chat Bot in the Agent application you can either select the circular chat symbol in the lower right corner of your screen, or you can enter the chat area in your navigation menu and select the "+ HaloMCP (Beta)" button in the top right corner. </p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3MTBlYjM4LWIyZWYtNGNlZC1iMmU5LTM1NWRiMjJiYWI4OSJ9.cQwQGJ6m54hEHGogrZGogunF8MGs6vwBcv5C_NBtn5c" width="833" style="width: 835px; height: 637.146px;" height="637" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 20a. Starting a HaloMCP chat via the floating chat icon</span></strong></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImNhZmQ0NDkyLTc4MjMtNDc4Zi1iMjYzLTRkZGEzNzBmODVlMyJ9.1QDC1tYVa1LblL7DAFUqj1HPj7XIoOwdDaVEyBzmDG8" width="960" style="width: 962px; height: 604.403px;" height="604" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 20b. Starting a HaloMCP chat via the chat area in Halo</span></strong></p><p><br></p><p>As dictated by the chat profile, when you first start a chat, you will be greeted by the Chat Bot who will ask how it can help. </p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY4NmE0OTc4LTVjZmMtNDFjZS04NDM3LWVhMzZmMTAzNmVmMiJ9.N-EjnZXV9zrH5fLRz8P5OXttblJJ6TAn7dvAGJVpFX4" width="774" style="width: 776px; height: 530.947px;" height="531" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 21. The AI Agent will greet you as soon as you begin the chat with the Chat Bot</span></strong></p><p><br></p><p>You can either select one of the two buttons available - "Check my tickets" or "Log a new ticket", or you can type a message of your choice. Once you submit your question or request, the Operations Agent is prompted to return relevant data according to the request. </p><p><br></p><p>As an example, in Figure 22 you can see that I have asked for a list of current open tickets on the service desk. The Operations Agent has returned a table of all the relevant Tickets and their information.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijg4NmI2ZTY3LTE0NTgtNDBmOS05YWZiLThhMTA5Njc5YzZmZCJ9.SP0kpZq9YpwOUcKA5CM-XnDYhVl-5pYp7_Tto4knhRU" width="725" style="width: 727px; height: 584.176px;" height="584" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 22. Querying the MCP endpoint via the agent ChatBot</span></strong></p><p><br></p><p>In Figure 23, I then tell the Agent to add a note to one of the tickets stating that the issue has now been resolved. </p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImRmNmMxYTFiLTkxMmQtNDQ4ZS04MzMwLWI1MjIyOTk1OGRkNyJ9.QQBvRTQtBEMTVEVsBXJH9euzar7BxLd-DwFfXktb6_E" width="711" style="width: 713px; height: 571.436px;" height="571" class="fr-fic fr-dii"></p><p><span style="font-size: 10pt;"><strong>Fig 23. Instructing the AI Agent to add a note to a ticket</strong></span></p><p><br></p><p>The Operations Agent carried out this task for me using the functions it has access to via the MCP server, demonstrating that I can action my tickets without even having to leave the chat or the page that I am on.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjI5MTY4YmJkLTFjNDUtNDk0NS1hN2Q2LTdkODk0Nzk0NzNhNyJ9.Fxwd9b0tvpA9TLyrmS-LtRd_mu4qJ1kG8nFvdUSpjvk" width="780" style="width: 782px; height: 672.714px;" height="673" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 24. A note added to a Ticket by the AI chat agent</span></strong></p>