Skip to main content
Glama
WHMCS MCP Server
by Yadley

WHMCS MCP Server

CI Docker License: MIT TypeScript MCP Node.js

A Model Context Protocol (MCP) server for managing WHMCS (Web Host Manager Complete Solution) installations. This server provides comprehensive tools for managing clients, products, billing, support tickets, domains, and more through the WHMCS API.

๐Ÿ“š Documentation

Related MCP server: whmcs-mcp-server

โœจ Features

๐Ÿค– AI-Powered Prompts

Pre-built prompt templates for common WHMCS workflows:

  • Client Onboarding - Guided new client setup

  • Ticket Response - Generate professional support responses

  • Revenue Report - Comprehensive financial analysis

  • Client Health Check - Account status assessment

  • Bulk Invoice Reminder - Automated payment follow-up

  • Domain Expiry Audit - Proactive domain management

  • New Product Setup - Product configuration guidance

  • Fraud Investigation - Security analysis workflow

๐Ÿ“Š Live Resources

Real-time data endpoints for instant access:

  • System statistics (whmcs://stats)

  • Products catalog (whmcs://products)

  • Support departments (whmcs://support/departments)

  • Payment methods (whmcs://payment-methods)

  • Currencies (whmcs://currencies)

  • Servers (whmcs://servers)

  • TLD pricing (whmcs://tld-pricing)

  • Promotions (whmcs://promotions)

  • Ticket statuses (whmcs://support/statuses)

  • Admin to-do items (whmcs://admin/todo)

Client Management

  • List, search, and filter clients

  • Get detailed client information

  • Create, update, and delete clients

  • View client products and services

  • View client domains

Product Management

  • List available products

  • Get product groups

  • View product pricing

Billing & Invoices

  • List and filter invoices

  • Create and update invoices

  • Add payments to invoices

  • Apply credits

  • View transactions

Support Tickets

  • List and filter tickets

  • View ticket details and replies

  • Create new tickets

  • Reply to tickets

  • Update ticket status

  • Get support departments and statuses

Domain Management

  • Register, transfer, and renew domains

  • Manage nameservers

  • Lock/unlock domains

  • Get TLD pricing

  • View WHOIS information

Order Management

  • List and filter orders

  • Accept, cancel, or delete orders

  • Mark orders as fraudulent

  • Set orders to pending

Server & Module Management

  • List configured servers

  • Create/provision services

  • Suspend/unsuspend services

  • Terminate services

  • Change service passwords

System Tools

  • Get system statistics

  • View admin users

  • Get payment methods and currencies

  • Activity logging

  • Email templates

  • To-do items

Additional Features

  • Affiliate management

  • Promotion/coupon management

  • Quote management

๐Ÿ”ง Installation

docker run -it --rm \
  -e WHMCS_API_URL="https://billing.example.com/" \
  -e WHMCS_API_IDENTIFIER="your-identifier" \
  -e WHMCS_API_SECRET="your-secret" \
  ghcr.io/scarecr0w12/whmcs-mcp-tool:latest

See Docker Guide for detailed Docker deployment instructions.

Option 2: From Source

  1. Clone this repository:

    git clone https://github.com/scarecr0w12/whmcs-mcp-tool.git
    cd whmcs-mcp-tool
  2. Install dependencies:

    npm install
  3. Build the project:

    npm run build
  4. Configure your WHMCS credentials:

    cp .env.example .env
    # Edit .env with your WHMCS API credentials

โš™๏ธ Configuration

For detailed configuration instructions, see the Configuration Guide.

Quick Start

  1. Create API credentials in WHMCS: Setup โ†’ Staff Management โ†’ API Credentials

  2. Copy the environment template: cp .env.example .env

  3. Edit .env with your WHMCS credentials

Environment Variables

Set the following environment variables:

Variable

Required

Description

WHMCS_API_URL

Yes

Your WHMCS installation URL (e.g., https://billing.example.com/)

WHMCS_API_IDENTIFIER

Yes

API credential identifier

WHMCS_API_SECRET

Yes

API credential secret

WHMCS_ACCESS_KEY

No

Optional API access key for additional security

API Access Key (Optional)

For additional security, you can configure an API Access Key:

  1. In WHMCS admin, go to Setup > General Settings > Security

  2. Set the API Access Key field

  3. Add this key to your WHMCS_ACCESS_KEY environment variable

๐Ÿš€ Usage

With VS Code

The server can be used directly with VS Code's MCP support. The configuration is already set up in .vscode/mcp.json.

  1. Set your environment variables

  2. Build the project: npm run build

  3. The MCP server will be available in VS Code

Running Manually

# Development mode with auto-reload
npm run dev

# Production mode
npm run build
npm start

๐Ÿ› ๏ธ Available Tools

For complete parameter documentation, see the API Reference.

Client Tools

  • whmcs_get_clients - Get list of clients

  • whmcs_get_client_details - Get detailed client information

  • whmcs_add_client - Create a new client

  • whmcs_update_client - Update an existing client

  • whmcs_delete_client - Delete a client

  • whmcs_get_client_products - Get client's products/services

  • whmcs_get_client_domains - Get client's domains

Product Tools

  • whmcs_get_products - Get available products

  • whmcs_get_product_groups - Get product groups

Invoice Tools

  • whmcs_get_invoices - Get invoices

  • whmcs_get_invoice - Get invoice details

  • whmcs_create_invoice - Create an invoice

  • whmcs_update_invoice - Update an invoice

  • whmcs_add_payment - Add payment to invoice

  • whmcs_apply_credit - Apply credit to invoice

  • whmcs_get_transactions - Get transactions

Ticket Tools

  • whmcs_get_tickets - Get support tickets

  • whmcs_get_ticket - Get ticket details

  • whmcs_open_ticket - Create a new ticket

  • whmcs_add_ticket_reply - Reply to a ticket

  • whmcs_update_ticket - Update ticket properties

  • whmcs_delete_ticket - Delete a ticket

  • whmcs_get_support_departments - Get support departments

  • whmcs_get_support_statuses - Get ticket statuses

Domain Tools

  • whmcs_register_domain - Register a domain

  • whmcs_transfer_domain - Transfer a domain

  • whmcs_renew_domain - Renew a domain

  • whmcs_get_domain_whois - Get WHOIS information

  • whmcs_get_domain_nameservers - Get nameservers

  • whmcs_update_domain_nameservers - Update nameservers

  • whmcs_get_domain_lock_status - Get lock status

  • whmcs_update_domain_lock_status - Update lock status

  • whmcs_get_tld_pricing - Get TLD pricing

Order Tools

  • whmcs_get_orders - Get orders

  • whmcs_accept_order - Accept an order

  • whmcs_cancel_order - Cancel an order

  • whmcs_delete_order - Delete an order

  • whmcs_fraud_order - Mark as fraudulent

  • whmcs_pending_order - Set to pending

Server & Module Tools

  • whmcs_get_servers - Get configured servers

  • whmcs_module_create - Create/provision service

  • whmcs_module_suspend - Suspend service

  • whmcs_module_unsuspend - Unsuspend service

  • whmcs_module_terminate - Terminate service

  • whmcs_module_change_password - Change service password

System Tools

  • whmcs_get_stats - Get system statistics

  • whmcs_get_admin_users - Get admin users

  • whmcs_get_payment_methods - Get payment methods

  • whmcs_get_currencies - Get currencies

  • whmcs_get_activity_log - Get activity log

  • whmcs_log_activity - Log an activity

  • whmcs_get_email_templates - Get email templates

  • whmcs_send_email - Send an email

  • whmcs_get_todo_items - Get to-do items

Affiliate Tools

  • whmcs_get_affiliates - Get affiliates

  • whmcs_activate_affiliate - Activate an affiliate

Promotion Tools

  • whmcs_get_promotions - Get promotions/coupons

Quote Tools

  • whmcs_get_quotes - Get quotes

  • whmcs_create_quote - Create a quote

  • whmcs_accept_quote - Accept a quote

  • whmcs_delete_quote - Delete a quote

๐Ÿ”’ Security Considerations

  1. Never commit your .env file - It contains sensitive API credentials

  2. Use API Access Keys - For additional security layer

  3. IP Restrictions - Configure IP restrictions in WHMCS for API access

  4. Minimal Permissions - Only enable the API functions you need

  5. HTTPS Only - Always use HTTPS for your WHMCS installation

๐Ÿงช Testing

Run the test script to verify your WHMCS connection:

npx tsx src/test.ts

๐Ÿ’ป Development

See CONTRIBUTING.md for development guidelines.

# Install dependencies
npm install

# Run in development mode
npm run dev

# Build for production
npm run build

# Watch mode for development
npm run watch

๐Ÿ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

Available Tools

62 tools
whmcs_accept_orderAccept OrderC

Accept and process a pending order

Inputs: orderid (required), serverid, autosetup, registrar, +3 more.

whmcs_accept_quoteAccept QuoteB

Accept a quote and convert to invoice

Inputs: quoteid (required).

whmcs_activate_affiliateActivate AffiliateB

Activate a client as an affiliate

Inputs: userid (required).

whmcs_add_clientAdd ClientB

Create a new client in WHMCS

Inputs: city (required), email (required), state (required), country (required), +13 more.

whmcs_add_paymentAdd PaymentC

Record a payment on an invoice

Inputs: gateway (required), transid (required), invoiceid (required), date, +3 more.

whmcs_add_ticket_noteAdd Ticket NoteA

Add an admin-only internal note to a ticket. Notes are not visible to the client and do not trigger email notifications.

Inputs: message (required), ticketid (required), markdown.

whmcs_add_ticket_replyAdd Ticket ReplyB

Reply to an existing support ticket

Inputs: message (required), ticketid (required), name, email, +6 more.

whmcs_apply_creditApply CreditB

Apply credit to an invoice

Inputs: amount (required), invoiceid (required), noemail.

whmcs_cancel_orderCancel OrderC

Cancel an order

Inputs: orderid (required), noemail, cancelsub.

whmcs_create_invoiceCreate InvoiceB

Create a new invoice for a client

Inputs: userid (required), date, notes, status, +8 more.

whmcs_create_quoteCreate QuoteC

Create a new quote

Inputs: stage (required), subject (required), validuntil (required), email, +7 more.

whmcs_delete_clientDelete ClientB

Delete a client from WHMCS (use with caution)

Inputs: clientid (required).

whmcs_delete_orderDelete OrderC

Delete an order (use with caution)

Inputs: orderid (required).

whmcs_delete_quoteDelete QuoteC

Delete a quote

Inputs: quoteid (required).

whmcs_delete_ticketDelete TicketC

Delete a support ticket (use with caution)

Inputs: ticketid (required).

whmcs_fraud_orderMark Order as FraudB

Mark an order as fraudulent

Inputs: orderid (required), cancelsub.

whmcs_get_activity_logGet Activity LogC

Get system activity log

Inputs: date, user, userid, limitnum, +3 more.

whmcs_get_admin_usersGet Admin UsersB

Get list of admin users

Inputs: no named parameters.

whmcs_get_affiliatesGet AffiliatesC

Get list of affiliates

Inputs: limitnum, limitstart.

whmcs_get_client_detailsGet Client DetailsC

Get detailed information about a specific client

Inputs: email, stats, clientid.

whmcs_get_client_domainsGet Client DomainsC

Get domains owned by a client

Inputs: domain, clientid, domainid, limitnum, +1 more.

whmcs_get_client_productsGet Client ProductsC

Get products/services owned by a client

Inputs: pid, domain, clientid, limitnum, +2 more.

whmcs_get_clientsGet ClientsC

Get a list of clients from WHMCS with optional filtering and pagination

Inputs: search, status, orderby, sorting, +2 more.

whmcs_get_currenciesGet CurrenciesA

Get configured currencies

Inputs: no named parameters.

whmcs_get_domain_lock_statusGet Domain Lock StatusB

Get lock/unlock status for a domain

Inputs: domainid (required).

whmcs_get_domain_nameserversGet Domain NameserversC

Get nameservers for a domain

Inputs: domainid (required).

whmcs_get_domain_whoisGet Domain WHOISC

Get WHOIS information for a domain

Inputs: domainid (required).

whmcs_get_email_templatesGet Email TemplatesB

Get list of email templates

Inputs: type, language.

whmcs_get_invoiceGet Invoice DetailsB

Get detailed information about a specific invoice

Inputs: invoiceid (required).

whmcs_get_invoicesGet InvoicesC

Get invoices with optional filtering

Inputs: order, status, userid, orderby, +2 more.

whmcs_get_ordersGet OrdersB

Get orders with optional filtering

Inputs: id, status, userid, limitnum, +1 more.

whmcs_get_payment_methodsGet Payment MethodsC

Get available payment methods

Inputs: no named parameters.

whmcs_get_product_groupsGet Product GroupsB

Get all product groups from WHMCS

Inputs: no named parameters.

whmcs_get_productsGet ProductsC

Get available products/services from WHMCS

Inputs: gid, pid, module.

whmcs_get_promotionsGet PromotionsC

Get list of promotions/coupons

Inputs: code.

whmcs_get_quotesGet QuotesC

Get list of quotes

Inputs: stage, userid, quoteid, subject, +2 more.

whmcs_get_serversGet ServersB

Get list of configured servers

Inputs: fetchStatus.

whmcs_get_statsGet System StatsB

Get WHMCS system statistics including income and order counts

Inputs: no named parameters.

whmcs_get_support_departmentsGet Support DepartmentsB

Get list of support departments

Inputs: ignore_dept_assignments.

whmcs_get_support_statusesGet Support StatusesB

Get ticket statuses with counts

Inputs: deptid.

whmcs_get_ticketGet Ticket DetailsB

Get detailed information about a specific ticket including replies

Inputs: ticketid (required).

whmcs_get_ticketsGet TicketsB

Get support tickets with optional filtering

Inputs: email, deptid, status, subject, +3 more.

whmcs_get_tld_pricingGet TLD PricingC

Get domain TLD pricing information

Inputs: currencyid.

whmcs_get_todo_itemsGet To-Do ItemsC

Get admin to-do items

Inputs: status, limitnum, limitstart.

whmcs_get_transactionsGet TransactionsC

Get payment transactions

Inputs: transid, clientid, invoiceid.

whmcs_log_activityLog ActivityC

Add an entry to the activity log

Inputs: description (required), userid.

whmcs_module_change_passwordModule Change PasswordC

Change password for a service account

Inputs: accountid (required), servicepassword.

whmcs_module_createModule CreateC

Create/provision a service account

Inputs: accountid (required).

whmcs_module_suspendModule SuspendC

Suspend a service account

Inputs: accountid (required), suspendreason.

whmcs_module_terminateModule TerminateC

Terminate a service account

Inputs: accountid (required).

whmcs_module_unsuspendModule UnsuspendB

Unsuspend a service account

Inputs: accountid (required).

whmcs_open_ticketOpen TicketB

Create a new support ticket

Inputs: deptid (required), message (required), subject (required), name, +8 more.

whmcs_pending_orderSet Order to PendingB

Set an order status to pending

Inputs: orderid (required).

whmcs_register_domainRegister DomainC

Send domain registration command to registrar

Inputs: domain, domainid.

whmcs_renew_domainRenew DomainB

Send domain renewal command to registrar

Inputs: domainid (required).

whmcs_send_emailSend EmailC

Send an email to a client

Inputs: id, customtype, messagename, custommessage, +1 more.

whmcs_transfer_domainTransfer DomainB

Send domain transfer command to registrar

Inputs: domainid (required).

whmcs_update_clientUpdate ClientC

Update an existing client in WHMCS

Inputs: clientid (required), city, email, notes, +13 more.

whmcs_update_domain_lock_statusUpdate Domain Lock StatusC

Lock or unlock a domain

Inputs: domainid (required), lockstatus.

whmcs_update_domain_nameserversUpdate Domain NameserversC

Update nameservers for a domain

Inputs: domainid (required), ns1, ns2, ns3, +2 more.

whmcs_update_invoiceUpdate InvoiceC

Update an existing invoice

Inputs: invoiceid (required), date, notes, status, +4 more.

whmcs_update_ticketUpdate TicketC

Update ticket properties

Inputs: ticketid (required), flag, name, email, +5 more.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelogโ€ฆ

    TDQS

    B3.1/5.0

    Scored across 62 tools

    Disambiguation5/5

    Each tool maps to a distinct resource-action pair, and even similar-sounding tools such as whmcs_get_invoices vs. whmcs_get_invoice clearly separate list from detail operations. Naming is explicit enough that an agent can reliably select the correct tool without confusion.

    Naming Consistency4/5

    All tools follow the whmcs_ verb_noun pattern, but there is minor inconsistency in verb choice: 'add_client' vs. 'create_invoice' and 'module_create' vs. 'create_quote' deviate from a single convention. Overall readability remains high.

    Tool Count2/5

    With 62 tools, the surface is very large and exceeds the 25+ threshold where selection overhead becomes a real concern. Even though WHMCS is a broad platform, this many tools may overwhelm agents and would be better split into smaller domain-focused servers.

    Completeness5/5

    The tool set covers the full lifecycle of clients, invoices, tickets, domains, orders, and module provisioning, along with supporting admin functions like stats, activity logs, affiliates, and quotes. There are no obvious dead-end workflows within the exposed domains.

    Related MCP Connectors

    Related MCP Servers

    • F
      license
      Not graded
      quality
      D
      maintenance
      Provides a unified API gateway for managing cPanel and WHM hosting environments through secure server-level and user-level operations. Enables automation of account management, domain/DNS configuration, email services, and database operations without exposing credentials.
      -
    • A
      license
      C
      quality
      D
      maintenance
      Provides a comprehensive suite of 56 tools for the management and automation of WordPress sites via the Pressable API. It enables users to handle site lifecycles, backups, DNS, and server operations through 13 specialized modules.
      56
      MIT
    • A
      license
      Not graded
      quality
      C
      maintenance
      Enables AI assistants to manage WHM hosting accounts and server administration tasks including account management, server stats, updates, SSL, backups, and email through a secure API.
      13
      ISC