# BorealHost (remote · borealhost.ai)

Agent-native web hosting — deploy sites, manage DNS, register domains, scale infrastructure

- Trust score: 65/100 (medium)
- Change this week: +5
- Registry status: active
- Liveness: live
- Owner verified: no
- Last scored: 2026-08-03

## Components

- remote · `borealhost.ai`: 65/100 (this document), [markdown](https://verifymcp.io/servers/ai-borealhost-mcp/borealhost.md), [page](https://verifymcp.io/servers/ai-borealhost-mcp/borealhost)
- pypi · `borealhost-mcp`: 36/100, [markdown](https://verifymcp.io/servers/ai-borealhost-mcp/borealhost-mcp.md), [page](https://verifymcp.io/servers/ai-borealhost-mcp/borealhost-mcp)

## Channel facts

- Endpoint: `https://borealhost.ai/mcp/`
- Transports: `streamable-http`
- Auth: `none`
- Version: `0.2.0`

## Trust breakdown

How this component scores in each security and reliability category. Every signal is checked automatically against the live server, and we only credit what we can confirm. Scores are 0–100 per category. Scoring method: https://verifymcp.io/docs/scoring (what has changed: https://verifymcp.io/docs/scoring/changelog)

Scored 2026-08-03.

- **Endpoint Security**: 57/100
  - The endpoint's TLS certificate is valid, in date, and uses a strong key.
  - Authorisation not fully verified: no authorisation is required to call this server, and 113 tool(s) never declared a destructiveHint. The MCP spec treats an absent hint as destructive by default, so we cannot call this surface safe.
  - HTTPS is enforced; there's no plaintext access path.
  - HSTS check failed: the Strict-Transport-Security header is absent.
  - DNSSEC check failed: this domain isn't protected by DNSSEC.
- **Transport & Reachability**: 100/100
  - Verified streamable-http transport via a live MCP handshake.
- **Schema Quality & AI Usability**: 82/100
  - 100% of prompts and resources have a non-trivial description (not blank, and not just the item's name).
  - AI-judged instruction clarity (excellent).
  - Context-footprint check failed: tool/resource definitions use about 18211 tokens (~154/item across 118 items; 113 tools + 5 resources), over budget; trim descriptions and params.
  - Usage-examples check failed: none of the tools include examples.
- **Stability & Change Management**: 27/100
  - Stability observed for 8 of 30 days with no destabilising changes; credit accrues until the full window elapses.
- **Tool Coverage**: 67/100
  - 100% of tools have a non-trivial description (not blank, and not just the tool's name).
  - 0% of tool parameters carry a description.
- **Capabilities**: 100/100
  - Implements a supported MCP spec version (2025-11-25); the latest is 2026-07-28.

## Install

### Claude

```bash
claude mcp add --transport http ai-borealhost-mcp https://borealhost.ai/mcp/
```

### Codex

```toml
[mcp_servers.ai-borealhost-mcp]
url = "https://borealhost.ai/mcp/"
```

### opencode

```json
{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "ai-borealhost-mcp": {
      "type": "remote",
      "url": "https://borealhost.ai/mcp/",
      "enabled": true
    }
  }
}
```

### OpenClaw

```bash
openclaw mcp add ai-borealhost-mcp --url https://borealhost.ai/mcp/ --transport streamable-http
```

### Hermes

```yaml
mcp_servers:
  ai-borealhost-mcp:
    url: "https://borealhost.ai/mcp/"
```

### Other

```json
{
  "mcpServers": {
    "ai-borealhost-mcp": {
      "type": "http",
      "url": "https://borealhost.ai/mcp/"
    }
  }
}
```

The mcpServers block is a cross-client convention. Remote transports vary, so check your client's docs.

## Changelog

Every change recorded for this component, newest first. Days that predate change tracking, or that we cannot explain, say so: "we were watching and nothing happened" and "we were not watching" are different claims.

### 2026-08-03 (score 65, +1)

No change was recorded against any check on this day. Stability & Change Management went from 23 to 27. That category is still filling its 30-day observation window: 7 days of observed history at the previous scan, 8 at this one. The score rises as the window fills, whether or not the server changes.

### 2026-08-01 (score 64, +1)

No change was recorded against any check on this day. Stability & Change Management went from 17 to 20. That category is still filling its 30-day observation window: 5 days of observed history at the previous scan, 6 at this one. The score rises as the window fills, whether or not the server changes.

### 2026-07-31 (score 63, +1)

- [functional] We updated how we score, so this day's move reflects our rubric, not a change to the server

### 2026-07-30 (score 62, +1)

- [functional] We updated how we score, so this day's move reflects our rubric, not a change to the server

### 2026-07-29 (score 61, 0)

- [security] Tool “register_domain” rewrote its description, which is the text the model reads
- [security] Tool “list_ftp_accounts” rewrote its description, which is the text the model reads
- [security] Tool “remove_ftp_account” rewrote its description, which is the text the model reads
- [security] Tool “create_ftp_account” rewrote its description, which is the text the model reads
- [functional] New tool “set_domain_usage”
- [cosmetic] “register_domain” added an optional parameter “forward_include_path”
- [cosmetic] “register_domain” added an optional parameter “forward_type”
- [cosmetic] “register_domain” added an optional parameter “forward_url”
- [cosmetic] “register_domain” added an optional parameter “nameservers”
- [cosmetic] “register_domain” added an optional parameter “usage_mode”

### 2026-07-28 (score 61, +1)

No change was recorded against any check on this day. Stability & Change Management went from 3 to 7. That category is still filling its 30-day observation window: 1 days of observed history at the previous scan, 2 at this one. The score rises as the window fills, whether or not the server changes.

### 2026-07-27 (score 60, 0)

- [functional] We updated how we score, so this day's move reflects our rubric, not a change to the server

### 2026-07-26 (score 60)

First indexed and scored.

## MCP tools (113)

### `register` (~241 tokens)

Register a new agent account and get an API key.

No authentication needed. The returned API key grants read+write access
to all BorealHost API endpoints. Store it securely — it cannot be
retrieved again.

The key is automatically activated for this session — all subsequent
tool calls will use it. No extra configuration needed.

If no email is provided, a synthetic agent identity is created
(agent-{uuid}@api.borealhost.ai). If an email is provided, it links
to an existing or new human account.

Args:
    name: Human-readable name for this API key (default: "Agent Key")
    email: Optional email to link to a human account

Returns:
    {"api_key": "bh_...", "key_id": "uuid", "prefix": "bh_...",
     "scopes": ["read", "write"], "account_id": "uuid",
     "message": "Store this API key securely..."}

Errors:
    RATE_LIMITED: Max 5 registrations per IP per hour
    VALIDATION_ERROR: Invalid email format

Input parameters:

- `email` (string)
- `name` (string)

### `set_api_key` (~131 tokens)

Set your BorealHost API key for this session.

Call this if you already have an API key (from a previous registration,
checkout completion, or the BorealHost panel). All subsequent tool calls
will use this key for authentication.

No need to call this after register() — the key is set automatically.

Args:
    api_key: Your BorealHost API key (format: bh_<48 hex chars>)

Returns:
    {"success": true, "message": "API key set for this session",
     "key_prefix": "bh_..."}

Input parameters:

- `api_key` (string, required)

### `whoami` (~137 tokens)

Check the current API key's account info, scopes, and site count.

Requires: BOREALHOST_API_KEY env var (read scope).

Returns:
    {"user": {"id": "uuid", "email": "...", "date_joined": "iso8601"},
     "api_key": {"id": "uuid", "name": "...", "prefix": "bh_...",
                 "scopes": ["read", "write"], "created_at": "iso8601"},
     "account": {"sites": 2, "active_subscriptions": 1}}

Errors:
    UNAUTHORIZED: Missing or invalid API key

### `request_api_key` (~235 tokens)

Request an API key for a site you are running on (challenge-response).

This starts a two-step verification flow:
1\. A claim token is written to your container at ~/.borealhost/.claim_token
   (mode 600, owner admin — only readable if you're on the container)
2\. Read that file and call claim_api_key(token) within 1 hour

This proves you have access to the container without storing any secrets
on disk permanently. The claim token is single-use and ephemeral.

No authentication needed — the proof is reading the file from the container.

Args:
    site_slug: The site identifier (your BorealHost site slug)

Returns:
    {"status": "pending", "site_slug": "my-site",
     "expires_in_seconds": 3600, "claim_path": "~/.borealhost/.claim_token",
     "instructions": "Read the claim token and call claim_api_key()..."}

Errors:
    VALIDATION_ERROR: Unknown site slug or no active subscription
    RATE_LIMITED: Too many pending claim tokens

Input parameters:

- `site_slug` (string, required)

### `claim_api_key` (~167 tokens)

Claim an API key using a claim token from the container.

After calling request_api_key(), read the claim token from
\~/.borealhost/.claim_token on your container and pass it here.

The token is single-use — once claimed, it cannot be used again.
The API key is automatically activated for this MCP session.

Args:
    claim_token: The claim token string read from the container file

Returns:
    {"api_key": "bh_...", "key_prefix": "bh_...",
     "site_slug": "my-site", "scopes": ["read", "write"],
     "message": "API key created and activated..."}

Errors:
    VALIDATION_ERROR: Invalid, expired, or already-claimed token

Input parameters:

- `claim_token` (string, required)

### `list_plans` (~169 tokens)

List available hosting plans with pricing and resources.

No authentication needed.

Args:
    track: Filter by plan track. Valid values: "single_site", "agency".
           Leave empty to list all tracks.
    include_deprecated: Include deprecated plans (default: false)

Returns:
    [{"slug": "site_starter", "name": "Starter", "track": "single_site",
      "hosting_type": "shared", "price": {"monthly": 5, "annual": 2, "currency": "CAD"},
      "resources": null, "features": {"max_sites": 1, "ai_modules": [...],
      "ai_agents": [], "free_domain_annual": false}}, ...]

Input parameters:

- `include_deprecated` (boolean)
- `track` (string)

### `create_checkout` (~217 tokens)

Start a new checkout session to purchase a hosting plan.

No authentication needed. After creating, call update_checkout to set
buyer info, then complete_checkout to pay.

Args:
    sku: Plan SKU in format bh_{plan_slug}_{monthly|annual}.
         Examples: "bh_site_starter_monthly", "bh_site_pro_annual",
         "bh_site_managed_monthly", "bh_site_business_annual".
         Call list_plans() to discover all available plan slugs.

Returns:
    {"id": "uuid", "sku": "bh_site_starter_monthly",
     "plan_slug": "site_starter", "billing_period": "monthly",
     "status": "not_ready", "buyer_email": "", "requested_slug": "",
     "created_at": "iso8601", "checkout_secret": "base64-token"}

Errors:
    VALIDATION_ERROR: Invalid SKU format or unknown plan
    RATE_LIMITED: Max 10 checkouts per IP per hour

Input parameters:

- `sku` (string, required)

### `update_checkout` (~247 tokens)

Set buyer email and desired site slug on a checkout session.

The checkout must be in "not_ready" status. Setting requested_slug
transitions status to "ready" (required before completing).

Args:
    checkout_id: Checkout session ID from create_checkout
    buyer_email: Optional email — if omitted, a synthetic agent identity
                 (agent-{uuid}@api.borealhost.ai) is created at completion
    requested_slug: Desired site identifier. Must be 3-50 chars, lowercase
                    alphanumeric + hyphens, cannot start/end with hyphen.
                    Must be globally unique.

Returns:
    {"id": "uuid", "sku": "...", "plan_slug": "...",
     "billing_period": "monthly", "status": "ready",
     "buyer_email": "...", "requested_slug": "my-site",
     "created_at": "iso8601"}

Errors:
    VALIDATION_ERROR: Invalid slug format or slug already taken
    FORBIDDEN: Missing checkout_secret
    NOT_FOUND: Unknown checkout_id

Input parameters:

- `buyer_email` (string)
- `checkout_id` (string, required)
- `requested_slug` (string)

### `complete_checkout` (~416 tokens)

Complete checkout with payment and start site provisioning.

The checkout must be in "ready" status.

Two payment methods:
\- "stripe_checkout" (default): Returns a short, chat-safe payment URL.
  \**Present `payment_url` to the human — NOT `stripe_checkout_url`.**
  The raw Stripe URL has a required `#fragment` that chat UIs routinely
  strip when rendering markdown links, which causes Stripe to show
  "page not found". `payment_url` is a short BorealHost redirect that
  preserves the fragment via HTTP 302. Then poll get_checkout_status()
  until status becomes "completed". The API key appears in the first
  poll after payment (shown once, then cleared).
\- "stripe_payment_method": Charges a Stripe PaymentMethod directly.
  Requires payment_method_id. On success, returns the API key immediately.

Args:
    checkout_id: Checkout session ID
    payment_method: "stripe_checkout" or "stripe_payment_method"
    payment_method_id: Stripe PaymentMethod ID (pm_...). Required only
                       for "stripe_payment_method".

Returns (stripe_checkout):
    {"id": "uuid", "status": "awaiting_payment",
     "payment_url": "https://borealhost.ai/pay/<id>/?s=<secret>",
     "stripe_checkout_url": "https://checkout.stripe.com/c/pay/...",
     "message": "Present payment_url to the human..."}

Returns (stripe_payment_method):
    {"id": "uuid", "status": "completed", "api_key": "bh_...",
     "api_key_message": "Store this API key securely...",
     "subscription_id": "uuid", "provisioning_job_id": "uuid"}

Errors:
    VALIDATION_ERROR: Missing payment_method_id for stripe_payment_method
    FORBIDDEN: Checkout not in "ready" status

Input parameters:

- `checkout_id` (string, required)
- `payment_method` (string)
- `payment_method_id` (string)

### `get_checkout_status` (~266 tokens)

Poll a checkout session for status updates.

Call this after complete_checkout to track payment and provisioning.

Polling strategy:
\- First 60 seconds: every 5 seconds
\- After 60 seconds: every 15 seconds
\- Stop after 10 minutes if not completed

Checkout statuses (in order):
\- "not_ready": Missing required fields (slug)
\- "ready": All fields set, awaiting payment
\- "awaiting_payment": Stripe checkout page opened, waiting for human
\- "in_progress": Payment received, site being provisioned
\- "completed": Site ready — API key included (shown once, then cleared)
\- "canceled": Checkout was abandoned
\- "failed": Payment or provisioning failed

Terminal statuses: "completed", "canceled", "failed".

Args:
    checkout_id: Checkout session ID

Returns (when completed):
    {"id": "uuid", "status": "completed", "api_key": "bh_...",
     "api_key_message": "Store this API key securely...",
     "subscription_id": "uuid", "completed_at": "iso8601"}

Note: The api_key field appears ONCE in the first poll after completion,
then is permanently cleared. Store it immediately.

Input parameters:

- `checkout_id` (string, required)

### `get_site_status` (~147 tokens)

Get detailed status of a hosted site including resources, domains, and modules.

Requires: API key with read scope.

Args:
    slug: Site identifier (the slug chosen during checkout)

Returns:
    {"slug": "my-site", "plan": "site_starter", "status": "active",
     "domains": ["my-site.borealhost.ai"], "modules": {...},
     "resources": {"memory_mb": 512, "cpu_cores": 1, "disk_gb": 10},
     "created_at": "iso8601"}

Errors:
    NOT_FOUND: Unknown slug or not owned by this account

Input parameters:

- `slug` (string, required)

### `manage_dns` (~276 tokens)

Create or delete DNS records for a site.

Requires: API key with write scope.

Args:
    slug: Site identifier
    action: "create" or "delete"
    record_type: "A", "AAAA", "CNAME", "MX", "TXT", or "SRV"
    subdomain: Subdomain part (e.g. "www", "mail"). Leave empty for
               the apex/root domain.
    value: Record value. Required for "create". Examples:
           A: "1.2.3.4", CNAME: "example.com", MX: "mail.example.com",
           TXT: "v=spf1 include:_spf.google.com ~all"
    ttl: Time to live in seconds (default: 3600)

Returns:
    {"success": true, "record": {"type": "A", "subdomain": "www",
     "value": "1.2.3.4", "ttl": 3600}}

Errors:
    VALIDATION_ERROR: Missing value for create, invalid record type
    NOT_FOUND: Unknown slug

Input parameters:

- `action` (string, required)
- `record_type` (string, required)
- `slug` (string, required)
- `subdomain` (string)
- `ttl` (integer)
- `value` (string)

### `deploy` (~70 tokens)

Trigger a deployment for a site.

Requires: API key with write scope. This may take up to 60 seconds.

Args:
    slug: Site identifier

Returns:
    {"success": true, "message": "Deployment triggered"}

Errors:
    NOT_FOUND: Unknown slug

Input parameters:

- `slug` (string, required)

### `install_app` (~286 tokens)

Install an app template on a VPS/Cloud site.

Starts a background installation. Poll get_app_status() for progress.

Requires: API key with write scope. VPS or Cloud plan only.

Args:
    slug: Site identifier
    template: App template slug. Available: django, laravel, nextjs, nodejs,
              nuxtjs, rails, static
    app_name: Short name for the app (2-50 chars, lowercase alphanumeric + hyphens).
              Used as subdomain: {app_name}.{site_domain}
    db_type: Database type. "none", "mysql", or "postgresql" (depends on template)
    domain: Custom domain override (default: {app_name}.{site_domain})
    display_name: Human-friendly name (default: derived from app_name)

Returns:
    {"id": "uuid", "app_name": "myapp", "status": "installing",
     "message": "Installation started. Poll for progress."}

Errors:
    FORBIDDEN: Plan does not support apps (shared plans)
    VALIDATION_ERROR: Invalid template, app_name, or duplicate name

Input parameters:

- `app_name` (string, required)
- `db_type` (string)
- `display_name` (string)
- `domain` (string)
- `slug` (string, required)
- `template` (string, required)

### `get_app_status` (~127 tokens)

Get app installation status and log.

Poll this after install_app() to track progress.

Requires: API key with read scope.

Args:
    slug: Site identifier
    app_id: App ID from install_app() response

Returns:
    {"id": "uuid", "app_name": "myapp", "status": "running"|"installing"|"failed",
     "install_log": "..."}

Statuses: "installing", "running", "stopped", "failed", "uninstalled"

Input parameters:

- `app_id` (string, required)
- `slug` (string, required)

### `list_apps` (~89 tokens)

List installed apps on a site.

Requires: API key with read scope.

Args:
    slug: Site identifier

Returns:
    {"apps": [{"id": "uuid", "app_name": "myapp", "template_slug": "django",
     "status": "running", "domain": "myapp.mysite.borealhost.ai"}]}

Input parameters:

- `slug` (string, required)

### `list_snapshots` (~114 tokens)

List all snapshots and scheduled snapshots for a site.

Requires: API key with read scope.

Args:
    slug: Site identifier

Returns:
    {"snapshots": [{"id": "uuid", "name": "snap-...", "status": "completed",
     "storage_type": "local"|"b2", "size_bytes": 1234, "size_display": "1.2 Mo",
     "created_at": "iso8601"}], "scheduled": [...]}

Input parameters:

- `slug` (string, required)

### `create_snapshot` (~182 tokens)

Create a local container snapshot (async).

Runs in background — returns immediately with status "creating".
Poll list_snapshots() to check when status becomes "completed" or "failed".

Available for VPS, dedicated, and cloud plans (any plan with max_snapshots > 0).
Local snapshots are stored on the host disk and count against disk quota.

Requires: API key with write scope.

Args:
    slug: Site identifier
    description: Optional description (max 200 chars)

Returns:
    {"id": "uuid", "name": "snap-...", "status": "creating",
     "storage_type": "local",
     "message": "Snapshot started. Poll list_snapshots() to check status."}

Errors:
    VALIDATION_ERROR: Max snapshots reached or insufficient disk quota

Input parameters:

- `description` (string)
- `slug` (string, required)

### `create_b2_snapshot` (~184 tokens)

Create a B2 cloud-backed snapshot (zero local disk, async).

Streams container data directly to Backblaze B2 via restic.
No local disk impact — billed separately at cost+5%.
Runs in background — returns immediately with status "creating".
Poll list_snapshots() to check when status becomes "completed".
Only available for VPS plans.

Requires: API key with write scope.

Args:
    slug: Site identifier
    description: Optional description (max 200 chars)

Returns:
    {"id": "uuid", "name": "...", "status": "creating",
     "storage_type": "b2",
     "message": "B2 cloud snapshot started. Poll list_snapshots()..."}

Errors:
    VALIDATION_ERROR: Not a VPS plan or max snapshots reached

Input parameters:

- `description` (string)
- `slug` (string, required)

### `delete_snapshot` (~84 tokens)

Delete a snapshot (local or B2).

Requires: API key with write scope.

Args:
    slug: Site identifier
    snapshot_id: UUID of the snapshot to delete

Returns:
    {"success": true, "message": "Snapshot deleted"}

Errors:
    NOT_FOUND: Snapshot not found

Input parameters:

- `slug` (string, required)
- `snapshot_id` (string, required)

### `rollback_snapshot` (~116 tokens)

Rollback a site to a previous snapshot.

WARNING: This is destructive. The current state of the container will be
replaced with the snapshot contents.

Requires: API key with admin scope.

Args:
    slug: Site identifier
    snapshot_id: UUID of the snapshot to rollback to

Returns:
    {"success": true, "message": "Rolled back to snapshot ..."}

Errors:
    NOT_FOUND: Snapshot not found or not in completed state

Input parameters:

- `slug` (string, required)
- `snapshot_id` (string, required)

### `get_snapshot_usage` (~98 tokens)

Get snapshot disk usage and quota info for a site.

Requires: API key with read scope.

Args:
    slug: Site identifier

Returns:
    {"disk_quota_gb": 200, "max_snapshots": 5, "snapshot_count": 2,
     "local_snapshot_bytes": 1234, "b2_snapshot_bytes": 5678,
     "can_create": true}

Input parameters:

- `slug` (string, required)

### `schedule_snapshot` (~131 tokens)

Schedule a snapshot for future execution.

Requires: API key with write scope. Max 3 pending schedules per site.

Args:
    slug: Site identifier
    scheduled_at: ISO 8601 datetime (must be in the future)
    description: Optional description (max 200 chars)

Returns:
    {"id": "uuid", "scheduled_at": "iso8601", "status": "scheduled"}

Errors:
    VALIDATION_ERROR: Invalid datetime, not in future, or too many pending

Input parameters:

- `description` (string)
- `scheduled_at` (string, required)
- `slug` (string, required)

### `cancel_scheduled_snapshot` (~87 tokens)

Cancel a scheduled snapshot.

Requires: API key with write scope.

Args:
    slug: Site identifier
    schedule_id: UUID of the scheduled snapshot to cancel

Returns:
    {"success": true, "message": "Scheduled snapshot cancelled"}

Errors:
    NOT_FOUND: Schedule not found or already executed

Input parameters:

- `schedule_id` (string, required)
- `slug` (string, required)

### `list_backups` (~102 tokens)

List all backups for a site (automatic and manual).

Requires: API key with read scope.

Args:
    slug: Site identifier

Returns:
    [{"id": "uuid", "backup_type": "auto"|"manual", "status": "completed",
     "size_bytes": 1234, "size_display": "1.2 Mo",
     "timestamp": "iso8601", "notes": "..."}]

Input parameters:

- `slug` (string, required)

### `create_backup` (~88 tokens)

Create a manual backup (runs asynchronously).

The backup starts in the background. Poll list_backups() to check status.

Requires: API key with write scope.

Args:
    slug: Site identifier

Returns:
    {"id": "uuid", "status": "pending",
     "message": "Backup started. Poll list_backups() to check status."}

Input parameters:

- `slug` (string, required)

### `restore_backup` (~116 tokens)

Restore a site from a backup.

WARNING: This is destructive. The current state of the site will be
replaced. Runs asynchronously — may take several minutes.

Requires: API key with admin scope.

Args:
    slug: Site identifier
    backup_id: UUID of the backup to restore from

Returns:
    {"success": true, "message": "Restore started..."}

Errors:
    VALIDATION_ERROR: Backup not found or not in completed state

Input parameters:

- `backup_id` (string, required)
- `slug` (string, required)

### `get_metrics` (~124 tokens)

Get traffic and performance metrics for a site.

Requires: API key with read scope.

Args:
    slug: Site identifier
    days: Number of days of history (1–90, default: 7)

Returns:
    {"requests": [...], "bandwidth": [...], "errors": [...],
     "period": {"start": "iso8601", "end": "iso8601"}}

Errors:
    NOT_FOUND: Unknown slug
    VALIDATION_ERROR: days out of range

Input parameters:

- `days` (integer)
- `slug` (string, required)

### `scale` (~146 tokens)

Change a site's hosting plan (upgrade or downgrade).

Requires: API key with admin scope. Best practice: create a snapshot
before downgrading.

Args:
    slug: Site identifier
    new_plan: Target plan slug (e.g. "site_pro", "site_managed").
              Call list_plans() to see available plans.

Returns:
    {"success": true, "old_plan": "site_starter", "new_plan": "site_pro",
     "message": "Plan changed successfully"}

Errors:
    NOT_FOUND: Unknown slug
    VALIDATION_ERROR: Invalid plan slug or same plan

Input parameters:

- `new_plan` (string, required)
- `slug` (string, required)

### `decommission` (~116 tokens)

Delete a site and schedule resource cleanup (7-day grace period).

WARNING: This is destructive. The site will be inaccessible immediately
but data is retained for 7 days before permanent deletion.

Best practice: create a snapshot before decommissioning.

Requires: API key with admin scope.

Args:
    slug: Site identifier

Returns:
    {"success": true, "message": "Site scheduled for deletion",
     "grace_period_days": 7}

Errors:
    NOT_FOUND: Unknown slug

Input parameters:

- `slug` (string, required)

### `update_account` (~159 tokens)

Update account profile fields (email, language, name).

Requires: API key with write scope.
Only provided (non-empty) fields are updated.

Args:
    email: New email address
    language: Language preference — "fr" (French) or "en" (English)
    first_name: First name
    last_name: Last name

Returns:
    {"success": true, "account": {"email": "...", "language": "fr",
     "first_name": "...", "last_name": "..."}}

Errors:
    VALIDATION_ERROR: Invalid email format or language code

Input parameters:

- `email` (string)
- `first_name` (string)
- `language` (string)
- `last_name` (string)

### `delete_account` (~77 tokens)

Permanently anonymize the account. Cancels subscriptions, deactivates keys.

WARNING: This is irreversible. The account will be soft-deleted and all
personal data anonymized. All sites will be decommissioned.

Requires: API key with admin scope.

Returns:
    {"success": true, "message": "Account anonymized"}

### `list_subscriptions` (~106 tokens)

List all subscriptions with plan details, pricing, status, and site slug.

Requires: API key with read scope.

Returns:
    [{"id": "uuid", "plan_slug": "site_starter", "plan_name": "Starter",
      "status": "active", "billing_period": "monthly",
      "price": {"amount": 500, "currency": "cad"},
      "site_slug": "my-site", "created_at": "iso8601"}]

### `get_billing_portal` (~100 tokens)

Get a Stripe billing portal URL for managing payment methods and invoices.

Returns a URL (not a redirect) that the human can open in a browser.

Requires: API key with read scope.

Args:
    flow: Optional. Set to "payment_method_update" to go directly
          to the payment method update page.

Returns:
    {"url": "https://billing.stripe.com/p/session/..."}

Input parameters:

- `flow` (string)

### `rotate_key` (~150 tokens)

Atomically rotate an API key. Old key is immediately invalidated.

Creates a new key with the same name, scopes, and rate limits.
The new key is returned once — store it immediately.

Requires: API key with write scope.

Args:
    key_id: UUID of the API key to rotate (get from whoami())

Returns:
    {"api_key": "bh_...", "key_id": "uuid", "prefix": "bh_...",
     "scopes": ["read", "write"], "message": "Key rotated. Store securely."}

Note: The old key stops working immediately. Update BOREALHOST_API_KEY
right away.

Input parameters:

- `key_id` (string, required)

### `create_api_key` (~236 tokens)

Create a new API key with specified scopes.

Cannot create keys with higher scopes than the current key.
Site-scoped keys restrict access to a single site.

Requires: API key with write scope.

Args:
    name: Human-readable name for the key (1-100 chars)
    scopes: Comma-separated scopes. Options: "read", "read,write",
            "read,write,admin". Default: "read"
    site_slug: Optional — restrict the key to a single site.
               Omit for account-wide access.

Returns:
    {"api_key": "bh_...", "key_id": "uuid", "prefix": "bh_...",
     "name": "My Key", "scopes": ["read", "write"],
     "message": "Store this API key securely — it will not be shown again."}

Errors:
    VALIDATION_ERROR: Invalid name, scopes, or max 25 active keys
    FORBIDDEN: Cannot create keys with higher scopes than current key

Input parameters:

- `name` (string, required)
- `scopes` (string)
- `site_slug` (string)

### `list_api_keys` (~120 tokens)

List all API keys for the account.

Shows key metadata (name, prefix, scopes, last used) but never the
full key value.

Requires: API key with read scope.

Returns:
    [{"id": "uuid", "name": "My Key", "prefix": "bh_a2...",
      "scopes": ["read", "write"], "is_active": true,
      "created_at": "iso8601", "last_used_at": "iso8601"|null,
      "site_slug": null|"my-site"}]

### `revoke_api_key` (~91 tokens)

Revoke (deactivate) an API key. The key stops working immediately.

Requires: API key with write scope.

Args:
    key_id: UUID of the key to revoke (from list_api_keys or whoami)

Returns:
    {"success": true, "message": "API key revoked"}

Errors:
    NOT_FOUND: Key not found or already revoked

Input parameters:

- `key_id` (string, required)

### `get_ssh_info` (~121 tokens)

Get SSH connection info for a VPS/dedicated site.

Only available for VPS/dedicated plans (not shared hosting).

Requires: API key with read scope.

Args:
    slug: Site identifier

Returns:
    {"host": "184.107.x.x", "port": 22, "username": "admin",
     "ssh_command": "ssh admin@184.107.x.x"}

Errors:
    NOT_FOUND: Unknown slug
    FORBIDDEN: Plan does not support SSH (shared plans)

Input parameters:

- `slug` (string, required)

### `add_ssh_key` (~170 tokens)

Inject your SSH public key into a site's container for direct SSH access.

The key is appended to /home/admin/.ssh/authorized_keys.
Only available for VPS/dedicated plans.

Requires: API key with write scope.

Args:
    slug: Site identifier
    public_key: SSH public key string. Supported types:
                ssh-ed25519, ssh-rsa, ecdsa-sha2-nistp256/384/521

Returns:
    {"success": true, "message": "SSH key added",
     "ssh_command": "ssh admin@184.107.x.x"}

Errors:
    VALIDATION_ERROR: Invalid or unsupported key format
    FORBIDDEN: Plan does not support SSH

Input parameters:

- `public_key` (string, required)
- `slug` (string, required)

### `list_files` (~171 tokens)

List files and directories in a site's container.

Path scoping depends on the plan:
\- Shared plans: rooted at wp-content/ (WordPress content directory)
\- VPS/dedicated plans: full filesystem access

Requires: API key with read scope.

Args:
    slug: Site identifier
    path: Relative path to list (empty for root of accessible area)

Returns:
    {"path": "/", "entries": [{"name": "index.php", "type": "file",
     "size": 1234, "modified": "iso8601"}, {"name": "uploads",
     "type": "directory", "modified": "iso8601"}]}

Errors:
    NOT_FOUND: Unknown slug or path doesn't exist

Input parameters:

- `path` (string)
- `slug` (string, required)

### `read_file` (~141 tokens)

Read the contents of a file from a site's container.

Max file size: 512KB. Binary files are rejected — use the site's
file manager or SSH for binary files.

Requires: API key with read scope.

Args:
    slug: Site identifier
    path: Relative path to the file

Returns:
    {"path": "wp-config.php", "content": "<?php ...",
     "size": 1234, "encoding": "utf-8"}

Errors:
    NOT_FOUND: File doesn't exist
    VALIDATION_ERROR: File is binary or exceeds 512KB

Input parameters:

- `path` (string, required)
- `slug` (string, required)

### `write_file` (~123 tokens)

Write or overwrite a text file in a site's container.

Creates parent directories if they don't exist.

Requires: API key with write scope.

Args:
    slug: Site identifier
    path: Relative path to the file
    content: File content as a UTF-8 string

Returns:
    {"success": true, "path": "...", "size": 1234}

Errors:
    NOT_FOUND: Unknown slug
    FORBIDDEN: Protected system path

Input parameters:

- `content` (string, required)
- `path` (string, required)
- `slug` (string, required)

### `upload_file` (~154 tokens)

Upload a base64-encoded file to a site's container.

Use this for binary files (images, archives, fonts, etc.).
For text files, prefer write_file().

Requires: API key with write scope.

Args:
    slug: Site identifier
    path: Relative path including filename (e.g. "images/logo.png")
    content_b64: Base64-encoded file content

Returns:
    {"success": true, "path": "images/logo.png", "size": 45678}

Errors:
    VALIDATION_ERROR: Invalid base64 encoding
    FORBIDDEN: Protected system path

Input parameters:

- `content_b64` (string, required)
- `path` (string, required)
- `slug` (string, required)

### `delete_file` (~116 tokens)

Delete a file or directory from a site's container.

Directories are deleted recursively. Protected system paths
(e.g. /etc, /usr) cannot be deleted.

Requires: API key with write scope.

Args:
    slug: Site identifier
    path: Relative path to delete

Returns:
    {"success": true, "path": "...", "message": "Deleted"}

Errors:
    NOT_FOUND: Path doesn't exist
    FORBIDDEN: Protected system path

Input parameters:

- `path` (string, required)
- `slug` (string, required)

### `create_directory` (~107 tokens)

Create a directory in a site's container.

Creates parent directories if they don't exist.

Requires: API key with write scope.

Args:
    slug: Site identifier
    path: Relative path of the directory to create

Returns:
    {"success": true, "path": "uploads/2024", "message": "Directory created"}

Errors:
    NOT_FOUND: Unknown slug
    FORBIDDEN: Protected system path

Input parameters:

- `path` (string, required)
- `slug` (string, required)

### `list_plugins` (~81 tokens)

List installed WordPress plugins with status.

Requires: API key with read scope. WordPress sites only.

Args:
    slug: Site identifier

Returns:
    {"plugins": [{"name": "akismet", "status": "active", "version": "5.3",
     "update_available": false}, ...]}

Input parameters:

- `slug` (string, required)

### `list_themes` (~86 tokens)

List installed WordPress themes with status.

Requires: API key with read scope. WordPress sites only.

Args:
    slug: Site identifier

Returns:
    {"themes": [{"name": "twentytwentyfour", "status": "active",
     "version": "1.0", "update_available": false}, ...]}

Input parameters:

- `slug` (string, required)

### `manage_plugin` (~116 tokens)

Install, activate, deactivate, or delete a WordPress plugin.

Requires: API key with write scope.

Args:
    slug: Site identifier
    action: "install", "activate", "deactivate", or "delete"
    plugin: Plugin slug (e.g. "akismet", "jetpack", "woocommerce")

Returns:
    {"action": "install", "plugin": "jetpack", "result": {...}}

Input parameters:

- `action` (string, required)
- `plugin` (string, required)
- `slug` (string, required)

### `manage_theme` (~109 tokens)

Install, activate, or delete a WordPress theme.

Requires: API key with write scope.

Args:
    slug: Site identifier
    action: "install", "activate", or "delete"
    theme: Theme slug (e.g. "twentytwentyfour", "astra")

Returns:
    {"action": "install", "theme": "astra", "result": {...}}

Input parameters:

- `action` (string, required)
- `slug` (string, required)
- `theme` (string, required)

### `wp_check_updates` (~99 tokens)

Check for available WordPress core, plugin, and theme updates.

Requires: API key with read scope.

Args:
    slug: Site identifier

Returns:
    {"core": {"current": "6.5", "update": "6.6"},
     "plugins": [{"name": "...", "current": "1.0", "new": "1.1"}],
     "themes": [...]}

Input parameters:

- `slug` (string, required)

### `wp_update_all` (~76 tokens)

Update WordPress core, all plugins, and all themes.

Runs all updates in sequence. May take up to 2 minutes.

Requires: API key with write scope.

Args:
    slug: Site identifier

Returns:
    {"core": {...}, "plugins": [...], "themes": [...]}

Input parameters:

- `slug` (string, required)

### `list_cron` (~82 tokens)

List cron jobs on a site.

Requires: API key with read scope.

Args:
    slug: Site identifier

Returns:
    {"jobs": [{"line": 1, "schedule": "*/5 * * * *",
     "command": "/usr/bin/php /var/www/html/wp-cron.php"}, ...]}

Input parameters:

- `slug` (string, required)

### `add_cron` (~99 tokens)

Add a cron job to a site.

Requires: API key with write scope.

Args:
    slug: Site identifier
    schedule: Cron schedule (e.g. "*/5 * * * *", "0 2 * * *")
    command: Command to execute

Returns:
    {"added": true, "result": {...}}

Input parameters:

- `command` (string, required)
- `schedule` (string, required)
- `slug` (string, required)

### `delete_cron` (~78 tokens)

Delete a cron job by line number.

Get line numbers from list_cron().

Requires: API key with write scope.

Args:
    slug: Site identifier
    line_number: Line number of the cron entry to delete

Returns:
    {"deleted": true}

Input parameters:

- `line_number` (integer, required)
- `slug` (string, required)

### `ssl_info` (~90 tokens)

Get SSL certificate information for a site.

Returns certificate details, expiry date, and issuer.

Requires: API key with read scope.

Args:
    slug: Site identifier

Returns:
    {"issuer": "Let's Encrypt", "domain": "example.com",
     "expires_at": "iso8601", "days_remaining": 60,
     "force_https": true}

Input parameters:

- `slug` (string, required)

### `ssl_renew` (~58 tokens)

Force SSL certificate renewal via certbot.

Requires: API key with write scope.

Args:
    slug: Site identifier

Returns:
    {"renewed": true, "expires_at": "iso8601"}

Input parameters:

- `slug` (string, required)

### `list_php_versions` (~90 tokens)

List available PHP versions and the currently active one.

Requires: API key with read scope.

Args:
    slug: Site identifier

Returns:
    {"versions": [{"version": "8.1", "active": false},
     {"version": "8.2", "active": false},
     {"version": "8.3", "active": true}]}

Input parameters:

- `slug` (string, required)

### `switch_php` (~88 tokens)

Switch the active PHP version for a site.

Requires: API key with write scope.

Args:
    slug: Site identifier
    version: Target PHP version (e.g. "8.3", "8.2", "8.1")

Returns:
    {"version": "8.3", "result": {...}}

Input parameters:

- `slug` (string, required)
- `version` (string, required)

### `cache_status` (~78 tokens)

Get cache status (Redis, WP object cache, hit rates).

Requires: API key with read scope.

Args:
    slug: Site identifier

Returns:
    {"redis_running": true, "object_cache_enabled": true,
     "hit_rate": 0.95, "memory_used_mb": 12}

Input parameters:

- `slug` (string, required)

### `cache_flush` (~50 tokens)

Flush all caches (Redis + WP object cache).

Requires: API key with write scope.

Args:
    slug: Site identifier

Returns:
    {"flushed": true}

Input parameters:

- `slug` (string, required)

### `cache_toggle` (~66 tokens)

Enable or disable the WordPress object cache.

Requires: API key with write scope.

Args:
    slug: Site identifier
    enable: true to enable, false to disable

Returns:
    {"enabled": true}

Input parameters:

- `enable` (boolean, required)
- `slug` (string, required)

### `get_database_info` (~86 tokens)

Get WordPress database information (size, tables, row counts).

Requires: API key with read scope. WordPress sites only.

Args:
    slug: Site identifier

Returns:
    {"database": "wp_mysite", "size_mb": 45.2,
     "tables": 12, "total_rows": 15432}

Input parameters:

- `slug` (string, required)

### `optimize_database` (~58 tokens)

Optimize WordPress database tables (reduces bloat).

Requires: API key with write scope.

Args:
    slug: Site identifier

Returns:
    {"optimized": true, "tables_optimized": 12}

Input parameters:

- `slug` (string, required)

### `database_search_replace` (~154 tokens)

Search and replace in WordPress database (e.g. URL migration).

Handles serialized data safely. Use dry_run=true first to preview changes.

Requires: API key with write scope.

Args:
    slug: Site identifier
    old: String to search for (e.g. "http://old-domain.com")
    new: Replacement string (e.g. "https://new-domain.com")
    dry_run: Preview only without making changes (default: true)

Returns:
    {"replacements": 42, "tables_affected": 5, "dry_run": true}

Input parameters:

- `dry_run` (boolean)
- `new` (string, required)
- `old` (string, required)
- `slug` (string, required)

### `list_databases` (~57 tokens)

List all databases on a site's container.

Requires: API key with read scope.

Args:
    slug: Site identifier

Returns:
    {"databases": ["wordpress", "app_db", ...]}

Input parameters:

- `slug` (string, required)

### `list_tables` (~82 tokens)

List tables in a database.

Requires: API key with read scope.

Args:
    slug: Site identifier
    database: Database name

Returns:
    {"tables": [{"name": "wp_posts", "rows": 1234, "size_mb": 5.2}, ...]}

Input parameters:

- `database` (string, required)
- `slug` (string, required)

### `execute_query` (~132 tokens)

Execute a SQL query on a site's database.

Supports SELECT, INSERT, UPDATE, DELETE, and DDL statements.
Results are limited to 1000 rows for SELECT queries.

Requires: API key with write scope.

Args:
    slug: Site identifier
    database: Database name
    query: SQL query string

Returns:
    {"columns": ["id", "title"], "rows": [[1, "Hello"], ...],
     "affected_rows": 0, "query_time_ms": 12}

Input parameters:

- `database` (string, required)
- `query` (string, required)
- `slug` (string, required)

### `get_stack_info` (~114 tokens)

Get detailed system stack information (OS, PHP, DB, web server versions).

Requires: API key with read scope.

Args:
    slug: Site identifier

Returns:
    {"os": "Debian 12", "kernel": "6.1.0",
     "php": "8.3.4", "mysql": "10.11.6-MariaDB",
     "nginx": "1.24.0", "wordpress": "6.5"}

Input parameters:

- `slug` (string, required)

### `get_resource_snapshot` (~128 tokens)

Get current resource usage (CPU, memory, disk, load average).

Requires: API key with read scope.

Args:
    slug: Site identifier

Returns:
    {"cpu_percent": 12.5, "memory_mb": 384, "memory_total_mb": 512,
     "disk_used_gb": 3.2, "disk_total_gb": 10,
     "load_1m": 0.5, "load_5m": 0.3, "load_15m": 0.2}

Input parameters:

- `slug` (string, required)

### `cloudflare_proxy_status` (~112 tokens)

Get Cloudflare proxy (CDN) status for a site.

Shows whether traffic is routed through Cloudflare's CDN (orange cloud)
or goes direct to origin (grey cloud / DNS-only).

Requires: API key with read scope.

Args:
    slug: Site identifier

Returns:
    {"domain": "my-site.borealhost.ai", "has_record": true,
     "proxied": true, "ip": "1.2.3.4"}

Input parameters:

- `slug` (string, required)

### `cloudflare_set_proxy` (~141 tokens)

Enable or disable Cloudflare CDN proxy for a site.

When enabled (orange cloud): traffic goes through Cloudflare's CDN,
gets caching, DDoS protection, and SSL termination at the edge.
When disabled (grey cloud): traffic goes directly to origin server.

Requires: API key with write scope.

Args:
    slug: Site identifier
    proxied: true to enable CDN proxy, false to disable

Returns:
    {"domain": "my-site.borealhost.ai", "proxied": true, "ip": "1.2.3.4"}

Input parameters:

- `proxied` (boolean, required)
- `slug` (string, required)

### `cloudflare_purge_cache` (~137 tokens)

Purge Cloudflare CDN cache for a site.

Without urls: purges all cached content for the site's subdomain.
With urls: purges only the specified URLs (max 30 per call).

Requires: API key with write scope.

Args:
    slug: Site identifier
    urls: Optional list of specific URLs to purge
          (e.g. ["https://my-site.borealhost.ai/style.css"])

Returns:
    {"purged": true, "scope": "host", "domain": "my-site.borealhost.ai"}

Input parameters:

- `slug` (string, required)
- `urls` (array)

### `list_ftp_accounts` (~139 tokens)

List SFTP accounts on a site.

Also returns the host and port to connect to. Do not use the site's domain
for SFTP: it is Cloudflare-proxied and only carries HTTP(S).

Requires: API key with read scope.

Args:
    slug: Site identifier

Returns:
    {"accounts": [{"username": "sftpuser", "home": "/wordpress", "uid": 1001}],
     "configured": true,
     "connection": {"host": "1.2.3.4", "port": 9312, "protocol": "SFTP"}}

Input parameters:

- `slug` (string, required)

### `create_ftp_account` (~182 tokens)

Create an SFTP account on a site.

The account is chrooted to /var/www and lands in home_dir. Password must be
at least 8 characters. Username must be lowercase alphanumeric.

Requires: API key with write scope.

Args:
    slug: Site identifier
    username: SFTP username (lowercase, max 32 chars)
    password: Password (min 8 chars)
    home_dir: Landing directory inside /var/www. Leave empty to land at
        /var/www itself, which lists every site directory.

Returns:
    {"success": true, "username": "sftpuser", "home_dir": "/wordpress",
     "protocol": "sftp"}

Input parameters:

- `home_dir` (string)
- `password` (string, required)
- `slug` (string, required)
- `username` (string, required)

### `remove_ftp_account` (~74 tokens)

Remove an SFTP account from a site.

Requires: API key with write scope.

Args:
    slug: Site identifier
    username: SFTP username to remove

Returns:
    {"removed": true, "username": "sftpuser"}

Input parameters:

- `slug` (string, required)
- `username` (string, required)

### `list_alert_rules` (~97 tokens)

List user-configurable alert rules for a site.

Requires: API key with read scope.

Args:
    slug: Site identifier

Returns:
    [{"id": "uuid", "metric": "disk", "operator": "gt",
      "threshold": 90, "severity": "warning", "enabled": true,
      "cooldown_minutes": 30, "notify_email": true}]

Input parameters:

- `slug` (string, required)

### `create_alert_rule` (~260 tokens)

Create an alert rule to monitor CPU, memory, or disk usage.

When the metric crosses the threshold, a notification is sent via
email and/or webhook. Max 10 rules per site.

Requires: API key with write scope.

Args:
    slug: Site identifier
    metric: "cpu", "memory", or "disk" (percentage-based)
    threshold: Threshold value 0-100 (e.g. 90 for 90%)
    operator: "gt" (greater than) or "lt" (less than). Default: "gt"
    severity: "warning" or "critical". Default: "warning"
    cooldown_minutes: Min minutes between repeated alerts. Default: 30
    notify_email: Send email notification. Default: true
    notify_webhook: Optional webhook URL for POST notifications

Returns:
    {"id": "uuid", "metric": "disk", "threshold": 90, ...}

Input parameters:

- `cooldown_minutes` (integer)
- `metric` (string, required)
- `notify_email` (boolean)
- `notify_webhook` (string)
- `operator` (string)
- `severity` (string)
- `slug` (string, required)
- `threshold` (number, required)

### `delete_alert_rule` (~71 tokens)

Delete an alert rule.

Requires: API key with write scope.

Args:
    slug: Site identifier
    rule_id: UUID of the alert rule to delete

Returns:
    {"deleted": true, "id": "uuid"}

Input parameters:

- `rule_id` (string, required)
- `slug` (string, required)

### `run_malware_scan` (~180 tokens)

Run a ClamAV malware scan on a site's container.

Scans the web root (or specified path) for malware, viruses, and trojans.
ClamAV is installed automatically if not present. Excludes node_modules,
vendor, .git, and cache directories.

May take up to 5 minutes for large sites.

Requires: API key with write scope.

Args:
    slug: Site identifier
    path: Directory to scan (default: /var/www/html)

Returns:
    {"infected_files": [{"path": "/var/www/html/shell.php", "threat": "Php.Malware.Agent"}],
     "scanned_count": 1234, "infected_count": 1, "scan_time_s": 45.2}

Input parameters:

- `path` (string)
- `slug` (string, required)

### `list_firewall_rules` (~105 tokens)

List IP allow/deny firewall rules for a site.

Rules are implemented as Nginx allow/deny directives per container.

Requires: API key with read scope.

Args:
    slug: Site identifier

Returns:
    {"rules": [{"ip": "1.2.3.4", "action": "deny"},
     {"ip": "10.0.0.0/8", "action": "allow"}]}

Input parameters:

- `slug` (string, required)

### `add_firewall_rule` (~186 tokens)

Add an IP firewall rule (allow or deny) and reload Nginx.

Supports IPv4, IPv6, and CIDR notation. Max 100 rules per site.
If a rule already exists for the IP, the action is updated.

Requires: API key with write scope.

Args:
    slug: Site identifier
    ip: IP address or CIDR (e.g. "1.2.3.4", "10.0.0.0/8", "2001:db8::/32")
    action: "deny" (block) or "allow" (whitelist). Default: "deny"

Returns:
    {"added": true, "ip": "1.2.3.4", "action": "deny"}

Input parameters:

- `action` (string)
- `ip` (string, required)
- `slug` (string, required)

### `remove_firewall_rule` (~86 tokens)

Remove an IP firewall rule and reload Nginx.

Requires: API key with write scope.

Args:
    slug: Site identifier
    ip: IP address or CIDR to remove (must match exactly)

Returns:
    {"removed": true, "ip": "1.2.3.4"}

Input parameters:

- `ip` (string, required)
- `slug` (string, required)

### `get_logs` (~196 tokens)

Retrieve container logs (error, access, or PHP).

Requires: API key with read scope.

Args:
    slug: Site identifier
    log_type: "error" (Nginx/Apache errors), "access" (HTTP request log),
              or "php" (PHP-FPM errors, WordPress sites only)
    lines: Number of lines to retrieve (1–500, default: 100)
    search: Optional keyword filter — only lines containing this string

Returns:
    {"log_type": "error", "lines": ["2024-01-15 ... error ...", ...],
     "count": 42, "truncated": false}

Errors:
    NOT_FOUND: Unknown slug
    VALIDATION_ERROR: Invalid log_type or lines out of range

Input parameters:

- `lines` (integer)
- `log_type` (string)
- `search` (string)
- `slug` (string, required)

### `list_domains` (~68 tokens)

List all domains owned by the authenticated user.

Requires: API key with read scope.

Returns:
    [{"domain": "example.com", "status": "active",
      "expires_at": "iso8601", "auto_renew": true,
      "linked_site": "my-site"}]

### `search_domain` (~110 tokens)

Check domain availability and get pricing.

Requires: API key with read scope.

Args:
    domain: Full domain name (e.g. "example.com", "mybiz.ca")

Returns:
    {"domain": "example.com", "available": true,
     "price": {"amount": 15.99, "currency": "CAD", "period": "1 year"},
     "premium": false}

Note: .ca domains require ca_legal_type when registering.

Input parameters:

- `domain` (string, required)

### `register_domain` (~778 tokens)

Register a new domain with WHOIS contact info and Stripe billing.

The domain cost is charged to the user's active subscription.
Free domain if plan includes free_domain_annual + annual billing + first domain.

Requires: API key with write scope.

Args:
    domain: Full domain name (e.g. "example.ca", "mybusiness.com")
    first_name: Registrant first name
    last_name: Registrant last name
    email: Registrant email address
    phone: Phone number in E.164 format: "+1.5145551234"
    address1: Street address (e.g. "123 Rue Principale")
    city: City (e.g. "Montreal")
    state: Province/state code (e.g. "QC", "ON", "BC")
    postal_code: Postal/ZIP code (e.g. "H2X 1Y4")
    country: ISO 3166-1 alpha-2 country code (default: "CA")
    period: Registration period in years (1–10, default: 1)
    usage_mode: What the domain points at.
                "site" (default) links it to the billing subscription's
                site with automatic DNS + Nginx + SSL.
                "external_ns" delegates it to `nameservers` — the domain is
                registered here but hosted elsewhere; we manage no DNS.
                "dns_only" keeps it on our DNS with no site behind it.
                "forward" redirects visitors to `forward_url`.
    nameservers: Ordered list of 2–6 nameserver hostnames. Required when
                 usage_mode="external_ns" (e.g. ["ns1.other.com", "ns2.other.com"])
    forward_url: Redirect target, required when usage_mode="forward"
                 (e.g. "https://example.org")
    forward_type: "301" permanent (default) or "302" temporary
    forward_include_path: Append the visitor's path to the target (default: True)
    ca_legal_type: Required for .ca domains. CIRA legal types:
                   "CCO" (Canadian citizen), "RES" (permanent resident),
                   "CCT" (corporation), "GOV" (government), "EDU" (education),
                   "ASS" (association), "HOP" (hospital), "PRT" (partnership),
                   "TDM" (tradem…

Input parameters:

- `address1` (string, required)
- `ca_legal_type` (string)
- `city` (string, required)
- `country` (string)
- `domain` (string, required)
- `email` (string, required)
- `first_name` (string, required)
- `forward_include_path` (boolean)
- `forward_type` (string)
- `forward_url` (string)
- `last_name` (string, required)
- `nameservers` (array)
- `period` (integer)
- `phone` (string, required)
- `postal_code` (string, required)
- `state` (string, required)
- `usage_mode` (string)

### `domain_detail` (~135 tokens)

Get full domain details including DNS and infrastructure status.

Requires: API key with read scope.

Args:
    domain_name: Full domain name (e.g. "example.com")

Returns:
    {"domain": "example.com", "status": "active",
     "expires_at": "iso8601", "auto_renew": true,
     "nameservers": ["ns1.borealhost.ai", "ns2.borealhost.ai"],
     "dns_records": [...], "linked_site": "my-site"}

Errors:
    NOT_FOUND: Domain not owned by this account

Input parameters:

- `domain_name` (string, required)

### `link_domain` (~142 tokens)

Link a domain to a hosted site.

Attaches the domain to the specified site and triggers automatic
DNS configuration and SSL provisioning.

Requires: API key with write scope.

Args:
    domain_name: Full domain name (e.g. "example.com")
    site_slug: Site identifier to link the domain to

Returns:
    {"success": true, "domain": "example.com",
     "linked_site": "my-site", "message": "Domain linked"}

Errors:
    NOT_FOUND: Domain or site not found
    VALIDATION_ERROR: Domain already linked to another site

Input parameters:

- `domain_name` (string, required)
- `site_slug` (string, required)

### `set_domain_usage` (~461 tokens)

Set what a registered domain points at — a site, someone else's
nameservers, our DNS with no site, or a redirect to another URL.

Use this to park a domain, hand it to an external host, or forward it.
Switching modes tears down the previous one (a forwarded domain that
becomes a site domain loses its redirect, and vice versa).

Requires: API key with write scope.

Args:
    domain_name: Full domain name (e.g. "example.com")
    usage_mode: "site" — link it to a hosted site (needs site_slug);
                "external_ns" — delegate to the customer's own nameservers
                (needs nameservers), we stop managing its DNS entirely;
                "dns_only" — our nameservers, records edited by hand,
                nothing served;
                "forward" — our nameservers plus an HTTP redirect to
                forward_url (needs forward_url)
    site_slug: Site to link to, when usage_mode="site"
    nameservers: Ordered list of 2–6 nameserver hostnames, when
                 usage_mode="external_ns"
    forward_url: Redirect target, when usage_mode="forward"
    forward_type: "301" permanent (default) or "302" temporary
    forward_include_path: Append the visitor's path to the target (default: True)

Returns:
    {"domain": "example.com", "usage_mode": "forward",
     "forward_url": "https://example.org",
     "configuration": {"dns": true, "nginx": true, "ssl": false, ...}}

    For forward mode, ssl=false usually just means DNS has not propagated
    yet — call this tool again a few minutes later to finish the cert.

Errors:
    NOT_FOUND: Domain or site not found
    VALIDATION_ERROR: Bad nameserver hostname, bad redirect URL,
                      missing site_slug, or a self-referential redirect

Input parameters:

- `domain_name` (string, required)
- `forward_include_path` (boolean)
- `forward_type` (string)
- `forward_url` (string)
- `nameservers` (array)
- `site_slug` (string)
- `usage_mode` (string, required)

### `domain_settings` (~183 tokens)

Update domain settings (auto-renew, WHOIS privacy, registrar lock).

Only provided (non-None) fields are updated.

Requires: API key with write scope.

Args:
    domain_name: Full domain name (e.g. "example.com")
    auto_renew: Enable/disable automatic renewal
    whois_privacy: Enable/disable WHOIS privacy protection
    locked: Enable/disable registrar lock (prevents unauthorized transfers)

Returns:
    {"success": true, "domain": "example.com",
     "auto_renew": true, "whois_privacy": true, "locked": true}

Errors:
    NOT_FOUND: Domain not found or not owned by account

Input parameters:

- `auto_renew` (boolean)
- `domain_name` (string, required)
- `locked` (boolean)
- `whois_privacy` (boolean)

### `list_domain_dns` (~139 tokens)

List all DNS records for a domain.

Returns DNS records at the domain level (independent of site-level
manage_dns). Use this for domains that may not be linked to a site.

Requires: API key with read scope.

Args:
    domain_name: Full domain name (e.g. "example.com")

Returns:
    [{"id": "record-id", "type": "A", "subdomain": "www",
      "value": "1.2.3.4", "ttl": 3600}]

Errors:
    NOT_FOUND: Domain not found or not owned by account

Input parameters:

- `domain_name` (string, required)

### `add_domain_dns` (~260 tokens)

Add a DNS record to a domain.

Requires: API key with write scope.

Args:
    domain_name: Full domain name (e.g. "example.com")
    record_type: "A", "AAAA", "CNAME", "MX", "TXT", or "SRV"
    value: Record value (e.g. "1.2.3.4" for A, "mail.example.com" for MX)
    subdomain: Subdomain part (e.g. "www", "mail"). Empty for apex domain.
    ttl: Time to live in seconds (default: 3600)
    priority: MX priority (required for MX records)

Returns:
    {"success": true, "record": {"id": "...", "type": "A",
     "subdomain": "www", "value": "1.2.3.4", "ttl": 3600}}

Errors:
    VALIDATION_ERROR: Missing value, invalid record type
    NOT_FOUND: Domain not found

Input parameters:

- `domain_name` (string, required)
- `priority` (integer)
- `record_type` (string, required)
- `subdomain` (string)
- `ttl` (integer)
- `value` (string, required)

### `delete_domain_dns` (~103 tokens)

Delete a DNS record from a domain.

Requires: API key with write scope.

Args:
    domain_name: Full domain name (e.g. "example.com")
    record_id: ID of the DNS record to delete (from list_domain_dns)

Returns:
    {"success": true, "message": "DNS record deleted"}

Errors:
    NOT_FOUND: Domain or record not found

Input parameters:

- `domain_name` (string, required)
- `record_id` (string, required)

### `list_modules` (~110 tokens)

List AI modules and their enabled/disabled state for a site.

Also returns the list of modules available for the site's plan.

Requires: API key with read scope.

Args:
    slug: Site identifier

Returns:
    {"modules": {"chatbot": true, "seo": false, "translation": false,
     "content": false}, "available": ["chatbot", "seo", "translation", "content"]}

Errors:
    NOT_FOUND: Unknown slug

Input parameters:

- `slug` (string, required)

### `toggle_module` (~150 tokens)

Enable or disable an AI module on a site.

The module must be in the plan's available module list.

Requires: API key with write scope.

Args:
    slug: Site identifier
    module_name: Module to toggle. Available modules:
                 "chatbot" (AI chat widget), "seo" (SEO optimization),
                 "translation" (content translation), "content" (AI content generation)

Returns:
    {"module": "chatbot", "enabled": true, "message": "Module enabled"}

Errors:
    NOT_FOUND: Unknown slug or module not in plan
    VALIDATION_ERROR: Invalid module name

Input parameters:

- `module_name` (string, required)
- `slug` (string, required)

### `list_compute_types` (~184 tokens)

List on-demand compute instance types with hourly CAD prices.

On-demand instances are real cloud VMs in Canada (Montreal region),
billed per minute (1-hour minimum) post-paid onto your existing
BorealHost subscription. Use them for short-lived extra compute
(builds, batch jobs, experiments).

Requires: API key with read scope.

Returns:
    {"region": "ca-central-1", "currency": "CAD",
     "billing": "hourly, post-paid; billing runs until the instance is terminated",
     "types": [{"type": "lsw.c3.large", "vcpu": 2, "memory_gb": 3,
                "hourly_price_cad": 0.08, "min_disk_gb": 5,
                "storage_types": ["CENTRAL", "LOCAL"]}, ...]}

### `list_compute_images` (~82 tokens)

List OS images available for on-demand compute instances.

Requires: API key with read scope.

Returns:
    {"images": [{"id": "UBUNTU_24_04_64BIT", "name": "Ubuntu 24.04 LTS (x86_64)",
                 "family": "linux", "flavour": "ubuntu"}, ...]}

### `launch_compute_instance` (~466 tokens)

Launch an on-demand hourly compute instance (Canada, CAD).

Billing starts at launch (per minute, 1-hour minimum) and runs until
terminate_compute_instance — stopping does NOT stop the charge. Every
instance has a hard TTL
(max_lifetime_hours, default 72h) after which it is auto-terminated.
Usage is metered onto your existing BorealHost subscription; an active
subscription is required.

Requires: API key with write scope.

Args:
    instance_type: From list_compute_types, e.g. "lsw.c3.large"
    image_id: From list_compute_images, e.g. "UBUNTU_24_04_64BIT"
    name: Optional label for the instance
    ssh_public_key: Public key installed as root access. Mutually exclusive
                    with user_data (provider limitation) — provide exactly one.
    user_data: cloud-init config (plain text #cloud-config). Use
               ssh_authorized_keys inside it if you need a key AND user data.
    root_disk_size: GB (default max(min_disk, 25))
    storage_type: "CENTRAL" (redundant) or "LOCAL" (faster I/O)
    max_lifetime_hours: Hard TTL, 1-336 (default 72)

Returns:
    Instance dict: {"id", "state": "launching", "public_ip", "instance_type",
    "hourly_price_cad", "terminate_after", ...}. Poll get_compute_instance
    until state is "running" and public_ip is set (~1-3 min).

Errors:
    PAYMENT_REQUIRED: No active subscription to bill against
    LIMIT_EXCEEDED: Concurrent instance cap reached
    SPEND_CAP_EXCEEDED: Monthly compute spend cap reached
    VALIDATION_ERROR: Bad type/image/disk/TTL, or both/neither of
                      ssh_public_key and user_data

Input parameters:

- `image_id` (string, required)
- `instance_type` (string, required)
- `max_lifetime_hours` (integer)
- `name` (string)
- `root_disk_size` (integer)
- `ssh_public_key` (string)
- `storage_type` (string)
- `user_data` (string)

### `list_compute_instances` (~74 tokens)

List your on-demand compute instances with month-to-date spend.

Requires: API key with read scope.

Returns:
    {"instances": [...], "month_to_date_spend_cad": 12.34,
     "monthly_spend_cap_cad": 500.0}

Input parameters:

- `include_terminated` (boolean)

### `get_compute_instance` (~117 tokens)

Get live details for a compute instance (state, public IP, accrued cost).

State is synced from the cloud provider on each call. SSH as root once
state is "running" and public_ip is set.

Requires: API key with read scope.

Args:
    instance_id: Instance UUID from launch_compute_instance / list

Returns:
    {"id", "state", "public_ip", "hourly_price_cad", "accrued_cad",
     "terminate_after", ...}

Input parameters:

- `instance_id` (string, required)

### `start_compute_instance` (~31 tokens)

Start a stopped compute instance.

Requires: API key with write scope.

Input parameters:

- `instance_id` (string, required)

### `stop_compute_instance` (~48 tokens)

Stop a compute instance. WARNING: hourly billing continues while stopped.

Use terminate_compute_instance to stop the charges permanently.

Requires: API key with write scope.

Input parameters:

- `instance_id` (string, required)

### `reboot_compute_instance` (~32 tokens)

Reboot a running compute instance.

Requires: API key with write scope.

Input parameters:

- `instance_id` (string, required)

### `terminate_compute_instance` (~76 tokens)

Permanently terminate a compute instance — this stops hourly billing.

The instance and its disk are destroyed and cannot be recovered. Copy any
results off the instance before terminating.

Requires: API key with write scope.

Returns:
    Final instance dict with state "terminated" and total accrued_cad.

Input parameters:

- `instance_id` (string, required)

### `list_compute_volumes` (~187 tokens)

List your compute volumes — machines that survive instance termination.

A volume is a whole machine (packages, drivers, services, users, data)
stored in Canada. Detaching destroys the instance but keeps the machine;
attaching restores it onto a fresh instance, optionally of a DIFFERENT
type. That is how you move a workload from a small CPU box to a big GPU
box without rebuilding it.

Requires: API key with read scope.

Returns:
    {"volumes": [{"id", "name", "state", "instance_type", "stored_gb",
    "has_snapshot", "instance": {...} or null}, ...],
    "price_cad_per_gb_month": 0.03}

    state is one of: creating, attached, detaching, detached, attaching,
    error. Only "attached" has a running instance you can log into.

### `get_compute_volume` (~89 tokens)

Get a volume's live state, its instance, and its monthly storage cost.

Requires: API key with read scope.

Returns:
    Volume dict plus "monthly_storage_cad". After attach, poll this until
    instance.state is "running" — then allow a few more minutes for the
    restore to finish and the machine to reboot into itself.

Input parameters:

- `volume_id` (string, required)

### `create_compute_volume` (~342 tokens)

Create a persistent machine and boot its first instance.

Start here, then set the machine up however you like (install packages,
drivers, models). Everything you do becomes part of the volume the first
time you detach or snapshot it.

While attached you pay hourly compute; while detached you pay only for
stored bytes (CA$0.03/GB/month). Stopping an instance does NOT save money
on this provider — detaching is what stops the compute charge.

Requires: API key with write scope, and an active subscription.

Args:
    name: Label for the volume, e.g. "trainer"
    image_id: From list_compute_images, e.g. "UBUNTU_24_04_64BIT".
              Cannot change later — restores must land on the same OS.
    instance_type: From list_compute_types, e.g. "lsw.g6.xlarge".
                   CAN change on every later attach.
    ssh_public_key: Required. Volume instances always boot via cloud-init,
                    so this is the only way in.
    root_disk_size: GB. Defaults to the type's minimum (or 25).

Returns:
    Volume dict with state "attached". Poll get_compute_volume until
    instance.state is "running" (~1-3 min).

Errors:
    PAYMENT_REQUIRED: No active subscription
    LIMIT_EXCEEDED: Volume cap reached
    NOT_AVAILABLE: Volumes not enabled on this deployment

Input parameters:

- `image_id` (string, required)
- `instance_type` (string, required)
- `name` (string, required)
- `root_disk_size` (integer)
- `ssh_public_key` (string, required)

### `adopt_compute_instance` (~252 tokens)

Turn an instance you are ALREADY running into a persistent volume.

Use this when you launched something, set it up, and then decided you want
to keep it. Nothing reboots and no data moves — the machine you have
becomes the volume, and you can detach it afterwards to stop paying for
compute while keeping the machine. Beats creating a volume and rebuilding.

Only instances launched with an ssh_public_key qualify. One launched with
your own user_data carries only your key, and a key cannot be added to a
machine we cannot already log into — check "managed_ssh" on the instance.

Requires: API key with write scope, and an active subscription.

Args:
    instance_id: A running lsw.* instance you own
    name: Label for the volume (defaults to the instance name)

Returns:
    Volume dict with state "attached", wrapping that same instance. No
    snapshot exists yet — the first one is taken on detach or snapshot.

Errors:
    CONFLICT: Not running, already a volume, BorealHost Metal, or launched
              without BorealHost management access

Input parameters:

- `instance_id` (string, required)
- `name` (string)

### `detach_compute_volume` (~188 tokens)

Queue: snapshot the machine, verify it, then destroy the instance.

This is how you stop paying for compute while keeping your work.

ASYNCHRONOUS. Returns immediately with state "detaching" — it does NOT mean
the detach finished. The capture takes minutes (roughly 1 min per 10 GB plus
verification), so it runs in a background worker. Poll get_compute_volume
until state is "detached" (done) or "error" (failed).

Safety: if the snapshot or its verification fails, the instance is left
RUNNING and the volume goes to state "error". Your data is never traded
for a tidy state machine. Retry the detach once you have fixed the cause.

Requires: API key with write scope.

Returns:
    Volume dict with state "detaching". Poll for the outcome.

Input parameters:

- `volume_id` (string, required)

### `attach_compute_volume` (~270 tokens)

Restore a detached volume onto a fresh instance — optionally a new type.

Pass a different instance_type to move the same machine to different
hardware: this is the closest thing to changing instance type that the
provider allows, since it has no resize API at all.

The restore runs at first boot and the machine reboots into itself, so the
instance answers SSH BEFORE it is ready. Poll get_compute_volume and give
it a few minutes (measured: ~6 min for a 10 GB GPU machine end to end).

The machine keeps its SSH host keys, so your client will not warn about a
changed host identity.

Requires: API key with write scope.

Args:
    volume_id: A volume in state "detached"
    ssh_public_key: Required — installed via cloud-init at boot
    instance_type: Defaults to the type it last ran on
    root_disk_size: GB. May grow, never shrink below the volume's size.

Returns:
    Volume dict with state "attached" and a new instance.

Errors:
    CONFLICT: Volume is not detached, or has no snapshot yet

Input parameters:

- `instance_type` (string)
- `root_disk_size` (integer)
- `ssh_public_key` (string, required)
- `volume_id` (string, required)

### `snapshot_compute_volume` (~186 tokens)

Queue a checkpoint snapshot without detaching — before a risky change.

ASYNCHRONOUS. Returns immediately with state "snapshotting"; poll
get_compute_volume until it is back to "attached" (done) or "error".

Named systemd units are stopped for the capture so the snapshot is
application-consistent (a live database directory copied mid-write is not
reliably restorable). The worker restarts nothing — reboot or start them
yourself afterwards.

Requires: API key with write scope.

Args:
    volume_id: A volume in state "attached"
    quiesce_units: Services to stop during capture,
                   e.g. ["ollama.service", "postgresql.service"]

Returns:
    Volume dict with state "snapshotting". Poll for the outcome.

Input parameters:

- `quiesce_units` (array)
- `volume_id` (string, required)

### `delete_compute_volume` (~107 tokens)

Permanently delete a volume and everything stored in it.

Irreversible: the instance is released AND the stored data is purged from
object storage, so billing genuinely stops. Refuses while an instance is
live unless force=True, so a running machine's only copy cannot be
destroyed by reflex.

Requires: API key with admin scope.

Returns:
    {"id", "state": "deleted"}

Input parameters:

- `force` (boolean)
- `volume_id` (string, required)

## Diagnostics

Captured diagnostic sections: TLS, DNSSEC, Authorisation, Transports. The full working is on the page: https://verifymcp.io/servers/ai-borealhost-mcp/borealhost#diagnostics

## Score history

- 2026-08-03: 65
- 2026-08-02: 64
- 2026-08-01: 64
- 2026-07-31: 63
- 2026-07-30: 62
- 2026-07-29: 61
- 2026-07-28: 61
- 2026-07-27: 60
- 2026-07-26: 60

## Links

- Remote endpoint: https://borealhost.ai/mcp/
- Repository: https://github.com/alainsvrd/borealhost-mcp
- Website: https://borealhost.ai/
- Changelog RSS feed: https://verifymcp.io/servers/ai-borealhost-mcp/borealhost/changelog.xml
- Changelog JSON feed: https://verifymcp.io/servers/ai-borealhost-mcp/borealhost/changelog.json
- HTML version of this page: https://verifymcp.io/servers/ai-borealhost-mcp/borealhost
