HaloPSA MCP Server
A Model Context Protocol (MCP) server for interacting with HaloPSA, featuring a decision tree architecture for efficient tool loading.
One-Click Deployment
IMPORTANT
Before you click: this server depends on @wyre-technology/node-halopsa,
which is hosted on the GitHub Packages npm registry. GitHub Packages has no
anonymous access — even though the package is public, every npm install needs a
token. The cloud builder runs npm install for you, so you must give it one, or
the build fails with npm error 401 Unauthorized ... npm.pkg.github.com.
- Create a GitHub Personal Access Token with the
read:packages scope
(classic token).
Any GitHub account works — you do not need to be a member of the
wyre-technology org to read its public packages.
- Add it as a build variable when prompted by the deploy flow:
- Cloudflare Workers → set a build variable named
NODE_AUTH_TOKEN to your PAT
(Workers → Settings → Build → Variables and Secrets).
- DigitalOcean App Platform → set an encrypted env var named
GITHUB_TOKEN
with scope Build Time to your PAT (the .do/app.yaml already declares it).
NOTE
The DigitalOcean target builds the full Docker image and runs the complete MCP
server over HTTP — this is the recommended path for operators. The Cloudflare
Workers target is currently a thin entrypoint (the /mcp route returns 501 until
the Workers transport adapter lands) and is best suited to gateway-style
deployments; for a full self-hosted server prefer DigitalOcean or the prebuilt
container image (ghcr.io/wyre-ai/halopsa-mcp).
Architecture
This MCP server uses a hierarchical tool loading approach instead of exposing all tools upfront:
- Navigation Phase: Initially exposes only a navigation tool (
halopsa_navigate)
- Domain Selection: User selects a domain (tickets, clients, assets, agents, invoices)
- Domain Tools: Server exposes domain-specific tools after selection
- Lazy Loading: Domain handlers and the HaloPSA client are loaded on-demand
This architecture provides:
- Reduced cognitive load (fewer tools to choose from)
- Faster initial load times
- Better organization of related operations
- Clear navigation state
Interactive Ticket Card (MCP Apps)
halopsa_tickets_get renders as an interactive card in MCP Apps hosts
(Claude Desktop/web) with an in-card "Add note" round-trip via
halopsa_tickets_add_action; plain-JSON behavior is unchanged in other hosts.
The card is neutral by default and brandable via window.__BRAND__ injection
or MCP_BRAND_* env vars (MCP_BRAND_NAME, MCP_BRAND_LOGO_URL,
MCP_BRAND_PRIMARY_COLOR, MCP_BRAND_ACCENT_COLOR, MCP_BRAND_BG,
MCP_BRAND_TEXT) — no rebuild needed.
Installation
This package is published to the GitHub Packages npm registry, which requires a
token even for public packages. Authenticate once, then install:
export NODE_AUTH_TOKEN=$(gh auth token)
npm install @wyre-ai/halopsa-mcp
The repo's .npmrc already points the @wyre-technology scope at GitHub Packages and
reads the token from NODE_AUTH_TOKEN, so no further config is needed.
Configuration
Set the following environment variables:
| Variable | Required | Description |
|---|
HALOPSA_CLIENT_ID | Yes | OAuth 2.0 Client ID |
HALOPSA_CLIENT_SECRET | Yes | OAuth 2.0 Client Secret |
HALOPSA_TENANT | One of | Tenant name (e.g., yourcompany) |
HALOPSA_BASE_URL | these | Explicit base URL (e.g., https://yourcompany.halopsa.com) |
Usage
Running Standalone
export HALOPSA_CLIENT_ID="your-client-id"
export HALOPSA_CLIENT_SECRET="your-client-secret"
export HALOPSA_TENANT="yourcompany"
npx @wyre-ai/halopsa-mcp
Claude Desktop Configuration
Add to your Claude Desktop claude_desktop_config.json:
{
"mcpServers": {
"halopsa": {
"command": "npx",
"args": ["@wyre-ai/halopsa-mcp"],
"env": {
"HALOPSA_CLIENT_ID": "your-client-id",
"HALOPSA_CLIENT_SECRET": "your-client-secret",
"HALOPSA_TENANT": "yourcompany"
}
}
}
}
Docker
docker build -t halopsa-mcp .
docker run -e HALOPSA_CLIENT_ID=xxx -e HALOPSA_CLIENT_SECRET=xxx -e HALOPSA_TENANT=yourcompany halopsa-mcp
Available Domains
Tickets
Manage support tickets, create new tickets, update status, add actions/notes.
Tools:
halopsa_tickets_list - List tickets with filtershalopsa_tickets_get - Get ticket detailshalopsa_tickets_create - Create a new tickethalopsa_tickets_update - Update an existing tickethalopsa_tickets_add_action - Add a note/action to a ticket
Clients
Manage companies/clients in HaloPSA.
Tools:
halopsa_clients_list - List clientshalopsa_clients_get - Get client detailshalopsa_clients_create - Create a new clienthalopsa_clients_search - Search clients by name
Assets
Manage configuration items/assets.
Tools:
halopsa_assets_list - List assets with filtershalopsa_assets_get - Get asset detailshalopsa_assets_search - Search assetshalopsa_assets_list_types - List available asset types
Agents
View technicians and teams.
Tools:
halopsa_agents_list - List agents/technicianshalopsa_agents_get - Get agent detailshalopsa_teams_list - List teams
Invoices
View billing and invoices.
Tools:
halopsa_invoices_list - List invoices with filtershalopsa_invoices_get - Get invoice details
Always available:
halopsa_navigate - Select a domain to work withhalopsa_status - Show current state and credential statushalopsa_back - Return to main menu (when in a domain)
Example Workflow
User: Check my tickets
Claude: [calls halopsa_navigate with domain="tickets"]
-> Navigated to tickets domain. Available tools: ...
User: List open tickets
Claude: [calls halopsa_tickets_list with open_only=true]
-> [ticket list results]
User: Now show me clients
Claude: [calls halopsa_back]
-> Navigated back to main menu.
[calls halopsa_navigate with domain="clients"]
-> Navigated to clients domain.
Rate Limiting
HaloPSA has a rate limit of 500 requests per 3-minute window. The underlying @asachs01/node-halopsa client handles this automatically with request throttling.
License
Apache-2.0