Skip to content

Installation

This is the full walkthrough to get Relyagent live: upload, activate, license, enable connections, and create your first one. Relyagent turns your WHMCS into a self-hosted MCP server (MCP is an open standard that lets AI assistants call external tools), all running on your own server. Before you start, make sure your server meets the requirements.

1. Upload the module

Upload the modules/addons/relyagent/ directory into your WHMCS install so it sits alongside your other addon modules.

2. Activate it in WHMCS

Go to Setup → Addon Modules, find Relyagent in the list, and click Activate.

Relyagent in the Addon Modules list with its Activate buttonSetup → Addon Modules → Relyagent → Activate

Activation does the one-time setup for you: it creates the module's database tables, deploys the hook loader, generates the per-install OAuth signing key that secures every connection, and records the file-integrity baseline used to verify deployed files. When it finishes you'll see:

"Relyagent activated successfully. Configure the module in Addons → Relyagent."

3. Enter your license key

Open Addons → Relyagent → Settings → License and enter your Relyagent license key. The MCP server is license-gated, so this step is required before any AI client can connect. For details on the two license types and what happens when one lapses, see Licensing.

4. Enable AI client connections

Go to Addons → Relyagent → Settings → MCP Settings → AI Client Connections and turn on Allow AI clients to connect. This is the master switch — until it's on, no connection can be used.

While you're here, set the Allowed Scopes ceiling. This is a global cap that applies on top of each connection's own tool selection, and it starts read-only by default — a safe starting point. Only raise it to allow write scopes (and, separately, enable Dangerous Operations) once you deliberately want AI clients to change data.

The AI Client Connections switch and Allowed Scopes ceilingAddons → Relyagent → Settings → MCP Settings

Read-only first

Leaving the scope ceiling at read-only means even a connection that has write tools ticked can only read — a useful safety net while you get comfortable. See Configuration for how per-connection tools and the global caps work together.

5. Create your first connection

Go to Addons → Relyagent → MCP Clients and create a connection: name it (for example, "Claude — Production"), tick exactly the tools it may use, and save. Relyagent issues an OAuth Client ID and Client Secret — the secret is shown once, so copy it right away. You then paste the Endpoint URL, Client ID and Client Secret into your AI client.

The endpoint AI clients connect to is:

https://<your-whmcs>/modules/addons/relyagent/public/mcp/endpoint.php

Next steps

Documentation for the Relyweb app catalogue.