Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| HALOPSA_URL | Yes | The URL of your HaloPSA instance (e.g., https://your-instance.halopsa.com) | |
| HALOPSA_TENANT | Yes | Your HaloPSA tenant identifier | |
| HALOPSA_CLIENT_ID | Yes | Your HaloPSA OAuth2 client ID | |
| HALOPSA_CLIENT_SECRET | Yes | Your HaloPSA OAuth2 client secret |
Schema
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| halopsa_list_tables | List all available tables in the HaloPSA database by querying sys.tables. Returns a complete list of all tables that can be queried. Use this to discover what data is available before writing queries. |
| halopsa_list_columns | List columns for a specific table in the HaloPSA database using information_schema.columns. Returns detailed column information including data types, max length, and nullable status. |
| halopsa_query | Execute a SQL query against HaloPSA reporting API. Use this to retrieve data from any HaloPSA table including tickets (FAULTS), users (USERS), sites (SITE), actions (ACTIONS), request types (REQUESTTYPE), and more. Returns the full report response with data rows, column metadata, and available filters. |
| halopsa_table_info | Get detailed information about a specific HaloPSA table including all columns, data types, nullable fields, and relationship suggestions. Use this to understand table structure before writing queries. |
| halopsa_build_query | Build a basic SQL query for HaloPSA with a helper that ensures proper syntax. Useful for constructing simple SELECT queries with WHERE conditions, ORDER BY, and LIMIT clauses without writing raw SQL. |
| halopsa_list_api_endpoints | List all API endpoints with their paths, methods, and summaries. Use this first to discover available endpoints, then use halopsa_get_api_endpoint_details for full details. Supports pagination. |
| halopsa_get_api_endpoint_details | Get complete details for specific API endpoints including parameters, request/response schemas, and examples. Use after finding endpoints with halopsa_list_api_endpoints. |
| halopsa_search_api_endpoints | Search for API endpoints by keywords. Returns matching endpoints with basic info. Use halopsa_get_api_endpoint_details for full details of specific endpoints. Supports pagination. |
| halopsa_get_api_schemas | Get API schemas/models from the swagger definition. Shows the structure of request/response objects used by the API endpoints. Supports pagination. |
| halopsa_api_call | Make authenticated API calls to any HaloPSA endpoint. Use this after finding the right endpoint with schema tools. |