Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| WHMCS_API_URL | Yes | Your WHMCS installation URL (e.g., https://billing.example.com/) | |
| WHMCS_ACCESS_KEY | No | Optional API access key for additional security | |
| WHMCS_API_SECRET | Yes | API credential secret | |
| WHMCS_API_IDENTIFIER | Yes | API credential identifier |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| whmcs_get_clients | Get a list of clients from WHMCS with optional filtering and pagination |
| whmcs_get_client_details | Get detailed information about a specific client |
| whmcs_add_client | Create a new client in WHMCS |
| whmcs_update_client | Update an existing client in WHMCS |
| whmcs_delete_client | Delete a client from WHMCS (use with caution) |
| whmcs_get_client_products | Get products/services owned by a client |
| whmcs_get_client_domains | Get domains owned by a client |
| whmcs_get_products | Get available products/services from WHMCS |
| whmcs_get_product_groups | Get all product groups from WHMCS |
| whmcs_get_invoices | Get invoices with optional filtering |
| whmcs_get_invoice | Get detailed information about a specific invoice |
| whmcs_create_invoice | Create a new invoice for a client |
| whmcs_update_invoice | Update an existing invoice |
| whmcs_add_payment | Record a payment on an invoice |
| whmcs_apply_credit | Apply credit to an invoice |
| whmcs_get_transactions | Get payment transactions |
| whmcs_get_tickets | Get support tickets with optional filtering |
| whmcs_get_ticket | Get detailed information about a specific ticket including replies |
| whmcs_open_ticket | Create a new support ticket |
| whmcs_add_ticket_reply | Reply to an existing support ticket |
| whmcs_update_ticket | Update ticket properties |
| whmcs_delete_ticket | Delete a support ticket (use with caution) |
| whmcs_get_support_departments | Get list of support departments |
| whmcs_get_support_statuses | Get ticket statuses with counts |
| whmcs_register_domain | Send domain registration command to registrar |
| whmcs_transfer_domain | Send domain transfer command to registrar |
| whmcs_renew_domain | Send domain renewal command to registrar |
| whmcs_get_domain_whois | Get WHOIS information for a domain |
| whmcs_get_domain_nameservers | Get nameservers for a domain |
| whmcs_update_domain_nameservers | Update nameservers for a domain |
| whmcs_get_domain_lock_status | Get lock/unlock status for a domain |
| whmcs_update_domain_lock_status | Lock or unlock a domain |
| whmcs_get_tld_pricing | Get domain TLD pricing information |
| whmcs_get_orders | Get orders with optional filtering |
| whmcs_accept_order | Accept and process a pending order |
| whmcs_cancel_order | Cancel an order |
| whmcs_delete_order | Delete an order (use with caution) |
| whmcs_fraud_order | Mark an order as fraudulent |
| whmcs_pending_order | Set an order status to pending |
| whmcs_get_servers | Get list of configured servers |
| whmcs_module_create | Create/provision a service account |
| whmcs_module_suspend | Suspend a service account |
| whmcs_module_unsuspend | Unsuspend a service account |
| whmcs_module_terminate | Terminate a service account |
| whmcs_module_change_password | Change password for a service account |
| whmcs_get_stats | Get WHMCS system statistics including income and order counts |
| whmcs_get_admin_users | Get list of admin users |
| whmcs_get_payment_methods | Get available payment methods |
| whmcs_get_currencies | Get configured currencies |
| whmcs_get_activity_log | Get system activity log |
| whmcs_log_activity | Add an entry to the activity log |
| whmcs_get_email_templates | Get list of email templates |
| whmcs_send_email | Send an email to a client |
| whmcs_get_todo_items | Get admin to-do items |
| whmcs_get_affiliates | Get list of affiliates |
| whmcs_activate_affiliate | Activate a client as an affiliate |
| whmcs_get_promotions | Get list of promotions/coupons |
| whmcs_get_quotes | Get list of quotes |
| whmcs_create_quote | Create a new quote |
| whmcs_accept_quote | Accept a quote and convert to invoice |
| whmcs_delete_quote | Delete a quote |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
| client-onboarding | Guide through onboarding a new client including account setup, product assignment, and welcome communication |
| ticket-response | Generate a professional response to a support ticket |
| revenue-report | Generate a comprehensive revenue analysis from WHMCS data |
| client-health-check | Perform a comprehensive health check on a client account |
| bulk-invoice-reminder | Send payment reminders to clients with overdue invoices |
| domain-expiry-audit | Audit domains expiring soon and take action |
| new-product-setup | Guide for setting up a new product or service in WHMCS |
| fraud-investigation | Investigate a potentially fraudulent order or client |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
| whmcs-stats | Current WHMCS system statistics including client counts, revenue, and service status |
| whmcs-products | List of all products and services available in WHMCS |
| whmcs-support-departments | List of all support departments configured in WHMCS |
| whmcs-payment-methods | Available payment methods configured in WHMCS |
| whmcs-currencies | Currency configuration in WHMCS |
| whmcs-servers | List of servers configured in WHMCS for service provisioning |
| whmcs-admin-users | List of administrator users in WHMCS |
| whmcs-tld-pricing | Domain TLD pricing information |
| whmcs-promotions | List of promotional codes and discounts |
| whmcs-ticket-statuses | Available support ticket statuses |
| whmcs-todo-items | Administrative to-do items and tasks |