<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><strong>In this guide we will cover:</strong></p><p data-pasted="true"><strong>- What is the Halo MCP Server Connection?</strong></p><p><strong>- Enabling the MCP Endpoint</strong></p><p><strong>- Creating an API Application</strong></p><p><strong>- Adding the Connector to Claude</strong></p><p><strong>- Using the Connection</strong></p><p><br></p><p><br></p><p><strong>Configuration Settings:</strong></p><ul><li><a href="https://usehalo.com/haloitsm/guides/2328" target="_blank" rel="noopener noreferrer"><strong>AI</strong></a></li></ul><p><strong><br></strong></p><p><strong>Related Guides:</strong></p><ul><li><a href="https://usehalo.com/haloitsm/guides/2597" target="_blank" rel="noopener noreferrer"><strong>Halo MCP Server Connection</strong></a></li></ul><p><br></p><p><strong><em><span style="color: rgb(226, 80, 65);">Note: The endpoint required for this functionality is available as of v2.236+.</span></em></strong></p><p><br></p><p data-pasted="true"><strong><span style="font-size: 14pt;">What is the Halo MCP Server Connection?</span></strong></p><p data-pasted="true">The Model Context Protocol (MCP) HTTP endpoint allows AI assistants such as Claude to connect and dynamically invoke tools in the Halo API such as knowledge search, ticket logging and updating/executing runbooks. Essentially, using AI to trigger a function similar to virtual agents.</p><p><br></p><p data-pasted="true">The Halo MCP connection to Claude can be used to provide data insights and perform actions from a chatbot external to Halo.</p><p><br></p><p><strong><span style="font-size: 14pt;">Enabling the MCP Endpoint</span></strong></p><p>In Configuration, ensure the AI module is enabled, and you have chosen either the default Halo AI connection or connected your own credentials.</p><p><br></p><p>Scroll down to "Enable the MCP Endpoint". This will give you a server URL for your instance, as well as the ability to customise which tools the MCP can use. For more information on this, check out the general "<a href="https://usehalo.com/haloitsm/guides/2597" target="_blank" rel="noopener noreferrer"><strong>Halo MCP Server Connection</strong></a>" guide.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImRjOTQxYzczLTU1YTEtNDE0Ni1hODhjLWMyMTEwYTRhMGQxNiJ9.CUmZ7qNncaBsZD1v_fiJxNzUIfh22SqebTDX2Jq9Ms4" class="fr-fic fr-fil fr-dib" width="1521" style="width: 1523px; height: 606.631px;" height="607"></p><p><strong><span style="font-size: 10pt;">Fig 1. Enabling the MCP server</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Creating an API Application</span></strong></p><p>Once enabled, we need to create an API application for Claude to authenticate with. In Configuration > Integrations > Halo API, click the "View Applications" button, and create a new application.</p><p><br></p><p>Set the authentication method to "Authorisation Code (Native Application)". This will display a Client ID; make note of this.</p><p><br></p><p>The option to use a Client Secret will then show. Set this dropdown to "Use a client secret for the token request". A Client Secret will then show, only once, so be sure to copy it somewhere. If you forget it, you will need to generate a new one.</p><p><br></p><p>Finally, in "Login Redirect URL" and "Logout Redirect URL", add the following URLs to both fields.</p><p><br></p><ul><li>https://claude.ai/api/mcp/auth_callback</li><li>https://claude.com/api/mcp/auth_callback</li></ul><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjU4ZWRjYzE1LWYyZjYtNDUxMC04NjVlLTcwNDhlZGMwMDc3ZiJ9.970UTPgeLZ7RpBuLlH-WjL76ERA6fWlMiQwRsk4qCNg" class="fr-fic fr-fil fr-dib" width="1521" style="width: 1523px; height: 695.913px;" height="696"></p><p><strong><span style="font-size: 10pt;">Fig 2. Creating the application credentials</span></strong></p><p><br></p><p>Switch to the "Permissions" tab, and set "all:standard" as the scope of the application.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImNmNDE3NWNjLWM0OTAtNDdiNy05MzdlLTA1YzliOTg3YmFlOSJ9.YYx3IDEBRjPRK18zM9wPLcrIIBG9o050NSjYZtjzFtM" class="fr-fic fr-fil fr-dib" width="1039" height="498"></p><p><strong><span style="font-size: 10pt;">Fig 3. Giving the application permissions</span></strong></p><p><br></p><p>In the "Security" tab, add the following URLs to the "CORS Whitelist" field.</p><p><br></p><ul><li data-pasted="true">claude.ai</li><li>claude.com</li><li>www.anthropic.com</li><li>api.anthropic.com</li></ul><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjA2MDNjZWI1LTc1MjQtNDE3YS1iODkxLTE3YWY4ZDJlNjM3OSJ9.bJ7QXsSJQtNgWSCwnS4iD60kWgddlqjFXU8FpdEIyBQ" class="fr-fic fr-fil fr-dib" width="944" height="257"></p><p><strong><span style="font-size: 10pt;">Fig 4. Whitelisting Claude URLs</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Adding the Connector to Claude</span></strong></p><p>Once the application is created, we will use these credentials to connect in Claude. This is found in a few different places, dependant on if you are using the Claude desktop app or website, and can be accessed via "Settings" or "Customize".</p><p><br></p><p><strong><span style="font-size: 12pt;">Via Settings</span></strong></p><p>If on the website, go to the bottom left, click the arrow symbol > Settings > Connectors.</p><p><br></p><p><img data-fr-image-pasted="true" src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImM5OTViOTg1LWE2NDctNGY3NS04ZTU5LWY3OTcyNDdhZDg2YSJ9.G0KWyRqPlKAYoUfJwjb4-Dgk_wg7PgRpWcuokwmRu58" style="box-sizing: inherit; border-style: none; cursor: pointer; padding: 0px 1px; user-select: none; text-align: left; color: rgb(0, 0, 0); font-family: sans-serif; font-size: 14px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; white-space: normal; background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial; max-width: none !important;" data-pasted="true" class="fr-fil fr-dib"></p><p><strong><span style="font-size: 10pt;">Fig 5. Connector via settings (Website)</span></strong></p><p><br></p><p data-pasted="true">If using Claude desktop, go to the top left corner, click the three lines, then File > Settings > Connectors.</p><p><br></p><p><img data-fr-image-pasted="true" src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjljNzM4ODE1LTM5NzUtNDExYi04NzRjLWQ0OTE0NGM2MDJmOSJ9.6I2s8cQqBn8tKt2sfcVHMpUwQ1e2lyxF3TcypBe4T5w" width="564" height="353" style="box-sizing: inherit; border-style: none; cursor: pointer; padding: 0px 1px; user-select: none; text-align: left; color: rgb(0, 0, 0); font-family: sans-serif; font-size: 14px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; white-space: normal; background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial; max-width: none !important;" data-pasted="true" class="fr-fic fr-fil fr-dib"></p><p><strong><span style="font-size: 10pt;">Fig 6. Connector via settings (App)</span></strong></p><p><br></p><p><strong><span style="font-size: 12pt;">Via Customize</span></strong></p><p data-pasted="true">If on the website, click the "Customize" icon.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjllZWIyOGE1LWRmMjctNGUxNS1hYmI5LTI2Y2M5YTY4NzgwMCJ9.htpIwyp58AiEz5-pBJqN-nytq68sNlF6R4tRr026k6I" width="1064" height="562" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 7. Connector via customize (Website)</span></strong></p><p><br></p><p>Choose "Connectors", then click the plus icon and select "Add custom connector".</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImNkOTJhYjk1LWU4NTAtNDMxYi04NjUxLTgyZjY2MTA2MGVlZCJ9.WlSq9uBZwSzxYpeIF9yPjxTSpzG5ZeOjBTuBF3NiDLY" width="730" height="301" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 8. Connector via customize (Website)</span></strong></p><p><br></p><p>If on the desktop app, click "Customize".</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjRjMWFkY2IyLTVlZWItNDJiYS1hNzkzLTU5MGNjMzIyOWU3OSJ9.Dw8QA37lZXyYltgUiD9i0Dx9kGhro59ix56HlO7BAiw" class="fr-fic fr-fil fr-dib" width="1503" style="width: 1505px; height: 760.54px;" height="761"></p><p><strong><span style="font-size: 10pt;">Fig 9. <strong data-pasted="true"><span style="font-size: 10pt;">Connector via customize</span></strong> (App)</span></strong></p><p><br></p><p>Choose "Connectors", the click the plus icon and select "Add custom connector".</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijk2NWY0YWRlLTZkZjEtNDVmMy05ODZkLTc0OTQ1NjQ1OTU2MiJ9.MmurBlXKNNUA9EZA0UXnXabs__qCCx210S5dFH9EmmA" class="fr-fic fr-fil fr-dib" width="970" height="294"></p><p><strong><span style="font-size: 10pt;">Fig 10. <strong data-pasted="true"><span style="font-size: 10pt;">Connector via customize </span></strong>(App)</span></strong></p><p><br></p><p>A popup will show to add the connection details.</p><p><br></p><ul><li><strong>Name: </strong>Give the connector a relevant name for reference.</li><li><strong>Remote MCP server URL: </strong>Add the URL from Configuration > AI, which will be <strong>[YOURHALOURL].com/api/mcp</strong>.</li><li><strong>OAuth Client ID: </strong>Add the Client ID from the API application.</li><li><strong>OAuth Client Secret: </strong>Add the Client Secret from the API application.</li></ul><p><br></p><p>Click the "Add" button to save and form the connection.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjMyN2NkOGVmLTU0NmQtNGZkZC1hZWJmLTI4NzNkZjhlYjdjMiJ9.MyniT-aibMPW1NYW65YFEu5fuIhBnDWtY6zcflHa0jk" class="fr-fic fr-fil fr-dib" width="593" style="width: 595px; height: 577.117px;" height="577"></p><p><strong><span style="font-size: 10pt;">Fig 11. Adding the API credentials to the connector</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Using the Connection</span></strong></p><p>Once connected, you will then be able to use any of the allowed system or custom tools to action Halo via Claude. These are listed in Configuration > AI.</p><p><br></p><p>For example, you could prompt: <em>"Get me the open tickets report. Assign the ticket that has been open the longest for Acorn Construction to me"</em></p><p><br></p><p>This would use the custom function "CF_get_open_tickets" to view that report, then the system function of "Assign to me".</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImY4ZmJiZjQyLTYwYzYtNDE3YS1hMmVhLTVjODYwMDY1YjIyOSJ9.lsWrGZRrM3seOhz4lLqpqsXmh7Hy-jGFSV3omRSdZr8" class="fr-fic fr-fil fr-dib" width="1516" style="width: 1518px; height: 463.495px;" height="463"></p><p><strong><span style="font-size: 10pt;">Fig 12. Available MCP functions</span></strong></p><p><br></p>
