// MCP TOOL REFERENCE

BOREALHOST TOOLS

95 tools from the BorealHost MCP Server, categorised by risk level.

View the BorealHost policy → Token cost: 17,722 tokens →
// ALL 95 BOREALHOST TOOLS
READ 38 tools
Read cache_status Get cache status (Redis, WP object cache, hit rates). Requires: API key with read scope. Args: slug: ... Read cloudflare_proxy_status Get Cloudflare proxy (CDN) status for a site. Shows whether traffic is routed through Cloudflare's CDN (or... Read database_search_replace Search and replace in WordPress database (e.g. URL migration). Handles serialized data safely. Use dry_run... Read domain_detail Get full domain details including DNS and infrastructure status. Requires: API key with read scope. Args:... Read get_app_status Get app installation status and log. Poll this after install_app() to track progress. Requires: API key w... Read get_billing_portal Get a Stripe billing portal URL for managing payment methods and invoices. Returns a URL (not a redirect) ... Read get_database_info Get WordPress database information (size, tables, row counts). Requires: API key with read scope. WordPres... Read get_logs Retrieve container logs (error, access, or PHP). Requires: API key with read scope. Args: slug: Site ... Read get_metrics Get traffic and performance metrics for a site. Requires: API key with read scope. Args: slug: Site i... Read get_resource_snapshot Get current resource usage (CPU, memory, disk, load average). Requires: API key with read scope. Args: ... Read get_site_status Get detailed status of a hosted site including resources, domains, and modules. Requires: API key with rea... Read get_snapshot_usage Get snapshot disk usage and quota info for a site. Requires: API key with read scope. Args: slug: Sit... Read get_ssh_info Get SSH connection info for a VPS/dedicated site. Only available for VPS/dedicated plans (not shared hosti... Read get_stack_info Get detailed system stack information (OS, PHP, DB, web server versions). Requires: API key with read scop... Read list_alert_rules List user-configurable alert rules for a site. Requires: API key with read scope. Args: slug: Site id... Read list_api_keys List all API keys for the account. Shows key metadata (name, prefix, scopes, last used) but never the full... Read list_apps List installed apps on a site. Requires: API key with read scope. Args: slug: Site identifier Return... Read list_backups List all backups for a site (automatic and manual). Requires: API key with read scope. Args: slug: Si... Read list_cron List cron jobs on a site. Requires: API key with read scope. Args: slug: Site identifier Returns: ... Read list_databases List all databases on a site's container. Requires: API key with read scope. Args: slug: Site identif... Read list_domain_dns List all DNS records for a domain. Returns DNS records at the domain level (independent of site-level mana... Read list_domains List all domains owned by the authenticated user. Requires: API key with read scope. Returns: [{"doma... Read list_files List files and directories in a site's container. Path scoping depends on the plan: - Shared plans: rooted... Read list_firewall_rules List IP allow/deny firewall rules for a site. Rules are implemented as Nginx allow/deny directives per con... Read list_ftp_accounts List FTP accounts on a site. Requires: API key with read scope. Args: slug: Site identifier Returns:... Read list_modules List AI modules and their enabled/disabled state for a site. Also returns the list of modules available fo... Read list_php_versions List available PHP versions and the currently active one. Requires: API key with read scope. Args: sl... Read list_plans List available hosting plans with pricing and resources. No authentication needed. Args: track: Filte... Read list_plugins List installed WordPress plugins with status. Requires: API key with read scope. WordPress sites only. Ar... Read list_snapshots List all snapshots and scheduled snapshots for a site. Requires: API key with read scope. Args: slug:... Read list_subscriptions List all subscriptions with plan details, pricing, status, and site slug. Requires: API key with read scop... Read list_tables List tables in a database. Requires: API key with read scope. Args: slug: Site identifier databas... Read list_themes List installed WordPress themes with status. Requires: API key with read scope. WordPress sites only. Arg... Read read_file Read the contents of a file from a site's container. Max file size: 512KB. Binary files are rejected — use... Read rollback_snapshot Rollback a site to a previous snapshot. WARNING: This is destructive. The current state of the container w... Read search_domain Check domain availability and get pricing. Requires: API key with read scope. Args: domain: Full doma... Read ssl_info Get SSL certificate information for a site. Returns certificate details, expiry date, and issuer. Require... Read wp_check_updates Check for available WordPress core, plugin, and theme updates. Requires: API key with read scope. Args: ...
WRITE 39 tools
Write add_cron Add a cron job to a site. Requires: API key with write scope. Args: slug: Site identifier schedul... Write add_domain_dns Add a DNS record to a domain. Requires: API key with write scope. Args: domain_name: Full domain name... Write add_firewall_rule Add an IP firewall rule (allow or deny) and reload Nginx. Supports IPv4, IPv6, and CIDR notation. Max 100 ... Write add_ssh_key Inject your SSH public key into a site's container for direct SSH access. The key is appended to /home/adm... Write cache_flush Flush all caches (Redis + WP object cache). Requires: API key with write scope. Args: slug: Site iden... Write cache_toggle Enable or disable the WordPress object cache. Requires: API key with write scope. Args: slug: Site id... Write claim_api_key Claim an API key using a claim token from the container. After calling request_api_key(), read the claim t... Write cloudflare_set_proxy Enable or disable Cloudflare CDN proxy for a site. When enabled (orange cloud): traffic goes through Cloud... Write complete_checkout Complete checkout with payment and start site provisioning. The checkout must be in "ready" status. Two p... Write create_alert_rule Create an alert rule to monitor CPU, memory, or disk usage. When the metric crosses the threshold, a notif... Write create_api_key Create a new API key with specified scopes. Cannot create keys with higher scopes than the current key. Si... Write create_b2_snapshot Create a B2 cloud-backed snapshot (zero local disk, async). Streams container data directly to Backblaze B... Write create_backup Create a manual backup (runs asynchronously). The backup starts in the background. Poll list_backups() to ... Write create_checkout Start a new checkout session to purchase a hosting plan. No authentication needed. After creating, call up... Write create_directory Create a directory in a site's container. Creates parent directories if they don't exist. Requires: API k... Write create_ftp_account Create an FTP account on a site. The user is chrooted to the specified directory. Password must be at leas... Write create_snapshot Create a local container snapshot (async). Runs in background — returns immediately with status "creating"... Write domain_settings Update domain settings (auto-renew, WHOIS privacy, registrar lock). Only provided (non-None) fields are up... Write install_app Install an app template on a VPS/Cloud site. Starts a background installation. Poll get_app_status() for p... Write link_domain Link a domain to a hosted site. Attaches the domain to the specified site and triggers automatic DNS confi... Write manage_dns Create or delete DNS records for a site. Requires: API key with write scope. Args: slug: Site identif... Write manage_plugin Install, activate, deactivate, or delete a WordPress plugin. Requires: API key with write scope. Args: ... Write manage_theme Install, activate, or delete a WordPress theme. Requires: API key with write scope. Args: slug: Site ... Write optimize_database Optimize WordPress database tables (reduces bloat). Requires: API key with write scope. Args: slug: S... Write register Register a new agent account and get an API key. No authentication needed. The returned API key grants rea... Write register_domain Register a new domain with WHOIS contact info and Stripe billing. The domain cost is charged to the user's... Write restore_backup Restore a site from a backup. WARNING: This is destructive. The current state of the site will be replaced... Write rotate_key Atomically rotate an API key. Old key is immediately invalidated. Creates a new key with the same name, sc... Write schedule_snapshot Schedule a snapshot for future execution. Requires: API key with write scope. Max 3 pending schedules per ... Write set_api_key Set your BorealHost API key for this session. Call this if you already have an API key (from a previous re... Write ssl_renew Force SSL certificate renewal via certbot. Requires: API key with write scope. Args: slug: Site ident... Write switch_php Switch the active PHP version for a site. Requires: API key with write scope. Args: slug: Site identi... Write toggle_module Enable or disable an AI module on a site. The module must be in the plan's available module list. Require... Write update_account Update account profile fields (email, language, name). Requires: API key with write scope. Only provided (... Write update_checkout Set buyer email and desired site slug on a checkout session. The checkout must be in "not_ready" status. S... Write upload_file Upload a base64-encoded file to a site's container. Use this for binary files (images, archives, fonts, et... Write whoami Check the current API key's account info, scopes, and site count. Requires: BOREALHOST_API_KEY env var (re... Write wp_update_all Update WordPress core, all plugins, and all themes. Runs all updates in sequence. May take up to 2 minutes... Write write_file Write or overwrite a text file in a site's container. Creates parent directories if they don't exist. Req...
DESTRUCTIVE 14 tools
Destructive cancel_scheduled_snapshot Cancel a scheduled snapshot. Requires: API key with write scope. Args: slug: Site identifier sche... Destructive cloudflare_purge_cache Purge Cloudflare CDN cache for a site. Without urls: purges all cached content for the site's subdomain. W... Destructive decommission Delete a site and schedule resource cleanup (7-day grace period). WARNING: This is destructive. The site w... Destructive delete_account Permanently anonymize the account. Cancels subscriptions, deactivates keys. WARNING: This is irreversible.... Destructive delete_alert_rule Delete an alert rule. Requires: API key with write scope. Args: slug: Site identifier rule_id: UU... Destructive delete_cron Delete a cron job by line number. Get line numbers from list_cron(). Requires: API key with write scope. ... Destructive delete_domain_dns Delete a DNS record from a domain. Requires: API key with write scope. Args: domain_name: Full domain... Destructive delete_file Delete a file or directory from a site's container. Directories are deleted recursively. Protected system ... Destructive delete_snapshot Delete a snapshot (local or B2). Requires: API key with write scope. Args: slug: Site identifier ... Destructive get_checkout_status Poll a checkout session for status updates. Call this after complete_checkout to track payment and provisi... Destructive remove_firewall_rule Remove an IP firewall rule and reload Nginx. Requires: API key with write scope. Args: slug: Site ide... Destructive remove_ftp_account Remove an FTP account from a site. Requires: API key with write scope. Args: slug: Site identifier ... Destructive request_api_key Request an API key for a site you are running on (challenge-response). This starts a two-step verification... Destructive revoke_api_key Revoke (deactivate) an API key. The key stops working immediately. Requires: API key with write scope. Ar...
EXECUTE 4 tools
Execute deploy Trigger a deployment for a site. Requires: API key with write scope. This may take up to 60 seconds. Args... Execute execute_query Execute a SQL query on a site's database. Supports SELECT, INSERT, UPDATE, DELETE, and DDL statements. Res... Execute run_malware_scan Run a ClamAV malware scan on a site's container. Scans the web root (or specified path) for malware, virus... Execute scale Change a site's hosting plan (upgrade or downgrade). Requires: API key with admin scope. Best practice: cr...
// RUNNING THIS SERVER

The managed route: connect BorealHost through the PolicyLayer gateway — every tool call above is checked against your policy before it runs, with a full audit log.

DIRECT INSTALL (UNMANAGED) npx -y pypi:borealhost-mcp
// FAQ
How many tools does the BorealHost MCP server have? +

The BorealHost MCP server exposes 95 tools across 4 categories: Read, Write, Destructive, Execute.

How do I enforce policies on BorealHost tools? +

Route the BorealHost server through the PolicyLayer gateway. Define allow, deny, or approval rules per tool in the dashboard — they are enforced on every call before it reaches the server.

What risk categories do BorealHost tools fall into? +

BorealHost tools are categorised as Read (38), Write (39), Destructive (14), Execute (4). Each category has a recommended default policy.

Let agents act without letting them run wild.

Route your MCP servers through PolicyLayer and every tool call is checked against your policy before it runs — allow, deny, or require approval. Per-identity grants. Full audit log. Live in minutes.

SECURE YOUR MCP →

Free to start. No card required.

4,600+ MCP servers and 31,000+ tools scanned and risk-classified.

// GET IN TOUCH

Have a question or want to learn more? Send us a message.

Message sent.

We'll get back to you soon.