{
  "markdown": "# HaloPSA MCP Server\n\nA Model Context Protocol (MCP) server for interacting with HaloPSA, featuring a decision tree architecture for efficient tool loading.\n\n## One-Click Deployment\n\n> [!IMPORTANT]\n> **Before you click:** this server depends on `@wyre-technology/node-halopsa`,\n> which is hosted on the **GitHub Packages** npm registry. GitHub Packages has no\n> anonymous access — even though the package is public, every `npm install` needs a\n> token. The cloud builder runs `npm install` for you, so you must give it one, or\n> the build fails with `npm error 401 Unauthorized ... npm.pkg.github.com`.\n>\n> 1. Create a GitHub **Personal Access Token** with the `read:packages` scope\n>    ([classic token](https://github.com/settings/tokens/new?scopes=read:packages&description=halopsa-mcp%20deploy)).\n>    Any GitHub account works — you do **not** need to be a member of the\n>    `wyre-technology` org to read its public packages.\n> 2. Add it as a build variable when prompted by the deploy flow:\n>    - **Cloudflare Workers** → set a build variable named **`NODE_AUTH_TOKEN`** to your PAT\n>      (Workers → Settings → Build → Variables and Secrets).\n>    - **DigitalOcean App Platform** → set an encrypted env var named **`GITHUB_TOKEN`**\n>      with scope **Build Time** to your PAT (the `.do/app.yaml` already declares it).\n\n[![Deploy to DO](https://www.deploytodo.com/do-btn-blue.svg)](https://cloud.digitalocean.com/apps/new?repo=https://github.com/WYRE-AI/halopsa-mcp/tree/main)\n\n[![Deploy to Cloudflare Workers](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/WYRE-AI/halopsa-mcp)\n\n> [!NOTE]\n> The DigitalOcean target builds the full Docker image and runs the complete MCP\n> server over HTTP — this is the recommended path for operators. The Cloudflare\n> Workers target is currently a thin entrypoint (the `/mcp` route returns 501 until\n> the Workers transport adapter lands) and is best suited to gateway-style\n> deployments; for a full self-hosted server prefer DigitalOcean or the prebuilt\n> container image (`ghcr.io/wyre-ai/halopsa-mcp`).\n\n## Architecture\n\nThis MCP server uses a **hierarchical tool loading approach** instead of exposing all tools upfront:\n\n1. **Navigation Phase**: Initially exposes only a navigation tool (`halopsa_navigate`)\n2. **Domain Selection**: User selects a domain (tickets, clients, assets, agents, invoices)\n3. **Domain Tools**: Server exposes domain-specific tools after selection\n4. **Lazy Loading**: Domain handlers and the HaloPSA client are loaded on-demand\n\nThis architecture provides:\n- Reduced cognitive load (fewer tools to choose from)\n- Faster initial load times\n- Better organization of related operations\n- Clear navigation state\n\n### Interactive Ticket Card (MCP Apps)\n\n`halopsa_tickets_get` renders as an interactive card in MCP Apps hosts\n(Claude Desktop/web) with an in-card \"Add note\" round-trip via\n`halopsa_tickets_add_action`; plain-JSON behavior is unchanged in other hosts.\nThe card is neutral by default and brandable via `window.__BRAND__` injection\nor `MCP_BRAND_*` env vars (`MCP_BRAND_NAME`, `MCP_BRAND_LOGO_URL`,\n`MCP_BRAND_PRIMARY_COLOR`, `MCP_BRAND_ACCENT_COLOR`, `MCP_BRAND_BG`,\n`MCP_BRAND_TEXT`) — no rebuild needed.\n\n## Installation\n\nThis package is published to the **GitHub Packages** npm registry, which requires a\ntoken even for public packages. Authenticate once, then install:\n\n```bash\n# Authenticate npm to GitHub Packages (token needs the read:packages scope)\nexport NODE_AUTH_TOKEN=$(gh auth token)   # or a PAT with read:packages\n\nnpm install @wyre-ai/halopsa-mcp\n```\n\nThe repo's `.npmrc` already points the `@wyre-technology` scope at GitHub Packages and\nreads the token from `NODE_AUTH_TOKEN`, so no further config is needed.\n\n## Configuration\n\nSet the following environment variables:\n\n| Variable | Required | Description |\n|----------|----------|-------------|\n| `HALOPSA_CLIENT_ID` | Yes | OAuth 2.0 Client ID |\n| `HALOPSA_CLIENT_SECRET` | Yes | OAuth 2.0 Client Secret |\n| `HALOPSA_TENANT` | One of | Tenant name (e.g., `yourcompany`) |\n| `HALOPSA_BASE_URL` | these | Explicit base URL (e.g., `https://yourcompany.halopsa.com`) |\n\n## Usage\n\n### Running Standalone\n\n```bash\n# Set credentials\nexport HALOPSA_CLIENT_ID=\"your-client-id\"\nexport HALOPSA_CLIENT_SECRET=\"your-client-secret\"\nexport HALOPSA_TENANT=\"yourcompany\"\n\n# Run the server\nnpx @wyre-ai/halopsa-mcp\n```\n\n### Claude Desktop Configuration\n\nAdd to your Claude Desktop `claude_desktop_config.json`:\n\n```json\n{\n  \"mcpServers\": {\n    \"halopsa\": {\n      \"command\": \"npx\",\n      \"args\": [\"@wyre-ai/halopsa-mcp\"],\n      \"env\": {\n        \"HALOPSA_CLIENT_ID\": \"your-client-id\",\n        \"HALOPSA_CLIENT_SECRET\": \"your-client-secret\",\n        \"HALOPSA_TENANT\": \"yourcompany\"\n      }\n    }\n  }\n}\n```\n\n### Docker\n\n```bash\ndocker build -t halopsa-mcp .\ndocker run -e HALOPSA_CLIENT_ID=xxx -e HALOPSA_CLIENT_SECRET=xxx -e HALOPSA_TENANT=yourcompany halopsa-mcp\n```\n\n## Available Domains\n\n### Tickets\nManage support tickets, create new tickets, update status, add actions/notes.\n\nTools:\n- `halopsa_tickets_list` - List tickets with filters\n- `halopsa_tickets_get` - Get ticket details\n- `halopsa_tickets_create` - Create a new ticket\n- `halopsa_tickets_update` - Update an existing ticket\n- `halopsa_tickets_add_action` - Add a note/action to a ticket\n\n### Clients\nManage companies/clients in HaloPSA.\n\nTools:\n- `halopsa_clients_list` - List clients\n- `halopsa_clients_get` - Get client details\n- `halopsa_clients_create` - Create a new client\n- `halopsa_clients_search` - Search clients by name\n\n### Assets\nManage configuration items/assets.\n\nTools:\n- `halopsa_assets_list` - List assets with filters\n- `halopsa_assets_get` - Get asset details\n- `halopsa_assets_search` - Search assets\n- `halopsa_assets_list_types` - List available asset types\n\n### Agents\nView technicians and teams.\n\nTools:\n- `halopsa_agents_list` - List agents/technicians\n- `halopsa_agents_get` - Get agent details\n- `halopsa_teams_list` - List teams\n\n### Invoices\nView billing and invoices.\n\nTools:\n- `halopsa_invoices_list` - List invoices with filters\n- `halopsa_invoices_get` - Get invoice details\n\n## Navigation Tools\n\nAlways available:\n- `halopsa_navigate` - Select a domain to work with\n- `halopsa_status` - Show current state and credential status\n- `halopsa_back` - Return to main menu (when in a domain)\n\n## Example Workflow\n\n```\nUser: Check my tickets\nClaude: [calls halopsa_navigate with domain=\"tickets\"]\n       -> Navigated to tickets domain. Available tools: ...\n\nUser: List open tickets\nClaude: [calls halopsa_tickets_list with open_only=true]\n       -> [ticket list results]\n\nUser: Now show me clients\nClaude: [calls halopsa_back]\n       -> Navigated back to main menu.\n       [calls halopsa_navigate with domain=\"clients\"]\n       -> Navigated to clients domain.\n```\n\n## Rate Limiting\n\nHaloPSA has a rate limit of 500 requests per 3-minute window. The underlying `@asachs01/node-halopsa` client handles this automatically with request throttling.\n\n## License\n\nApache-2.0\n",
  "bytes": 7058,
  "sha": "30c7a9a02eeecb073665278fe42ee6d1916765e0134d782855916ec1e2f51ba9",
  "repo_slug": "wyre-technology/halopsa-mcp",
  "fonte": "repo",
  "truncated": false,
  "api": "https://agentalog.com/api/listings/mcp_io_github_wyre_technology_halopsa_mcp_12c43ad8/readme"
}