Regal Compass

Docs

CLI, the desk, MCP, ChatGPT and Claude

How to run the company desk, connect the theme CLI, what MCP tools the platform actually exposes, and how to attach ChatGPT or Claude — without a fake plugin story.

01

Start here

Open the company desk first. The public site and the CLI sit on the same fleet — you do not need a developer to take the first trip.

  1. 01

    Create the company

    Sign up, pick a plan from the live catalog, and drop in brand colors, logo, and a phone number. The desk is app.regal-compass.com.

  2. 02

    Load the fleet

    Vehicles, packages, drivers, and rates. Quotes and the public Book now form read the same cards.

  3. 03

    Publish the site

    Pick a JSX theme, edit copy and photos in Site Theme, connect payments and WhatsApp. Custom layouts wait until you need them.

  4. 04

    Use the CLI only when you need custom JSX

    Agencies connect with a Theme CLI code. You still approve access and you still own publish. Operators of the platform MCP do not hand tenants a server secret.

02

Theme CLI

The regal binary pulls your company theme into a folder, validates JSX, and uploads drafts. Publish stays with the company owner.

  1. 01

    Install (Node 20+)

    The package name is regal-compass-cli; the command is regal. Build and link from the CLI folder — it is not assumed on the public npm registry.

    cd regal-compass-cli && npm install && npm run build && npm link
  2. 02

    Owner: create a connect code

    In the desk, open Brand → Site Theme → Theme CLI. Create connect code. Copy Company ID and the code. Do not paste the code into a public ticket.

  3. 03

    Developer: connect

    Point the CLI at production, then paste Company ID, connect code, and your name. The owner approves in Theme CLI. The CLI waits up to ten minutes.

    REGAL_API_BASE=https://app.regal-compass.com regal connect
  4. 04

    Pull and work

    regal setup connects if needed and pulls JSX plus agent docs. Edit pages, then sync a draft. Preview the draft URL before anyone publishes.

    regal setup
    regal page new fleet-detail "Fleet detail"
    # edit JSX…
    regal sync pages/fleet-detail.jsx
    regal preview --draft fleet-detail
    regal publish
  5. 05

    Local companyadmin

    When you are developing against a local desk, set the API base to that origin.

    export REGAL_API_BASE=http://127.0.0.1:3000

Auth

regal connect · regal companies (or regal stores) · regal use [id|slug] · regal setup · regal status

Theme files

regal pull · regal docs / regal guide (magic tags + AGENTS.md) · regal sync · regal sync <path> · regal publish · regal discard

Pages & preview

regal pages · regal page new <slug> [title] · regal page rm <slug> · regal preview · regal preview --draft · regal preview [slug]

Assets & catalog

regal asset upload <file> [key] · regal assets upload-public · regal catalog submit [name] [priceUsd]

  • After pull you get REGAL-MAGIC-TAGS-GUIDE.md and AGENTS.md. Copy goes in SiteText k=… Images go in SiteAsset k=… Brand colors use var(--rc-primary), var(--rc-accent), var(--rc-bg).
  • sync uploads to draft only. publish promotes draft to live. discard drops unpublished draft.
  • Layout must keep exactly one Children slot. Prefer registered magic tags over hardcoded marketing copy.

03

Use the desk

The night shift opens one login. These are the paths staff actually walk — not a feature list.

  1. 01

    First week on the desk

    Profile and Keys → payments. Load vehicles and packages. Invite one dispatcher. Publish a theme with Book now. Send a test quote. Assign the trip on Dispatcher.

Fleet

Dashboard for today’s trips. Vehicles: roster, photos, class, capacity, rates. Packages: airport, hourly, point-to-point. Drivers: documents and the chauffeur app. Dispatcher: who is free, who is en route — assign from the board, not a group chat.

Sales

Leads land from the site and forms. Convert to a customer and a quote. Bookings hold flight numbers, extras, and pickup time. Connect Stripe, Square, or PayPal on Keys so ride payouts hit your processor — they never pass through us. Invoices go out from the trip card.

Engage

Inbox is WhatsApp Cloud and company chat. Email inbox is company mailboxes, templates, and scheduled quote mail. Notifications alert the desk for new leads, paid quotes, and trip status. SMS uses platform Twilio (or your Twilio keys when Super Admin allows). Pickup reminders should not wake a personal phone.

Brand

Theme sets colors and logo. Site Theme picks the JSX layout and edits copy and photos. Theme Editor is the in-desk agent. Booking embed drops the same book form on a page you already own. Custom domain attaches from settings once DNS is ready.

Team

Staff roles: owner, dispatcher, finance, marketing, or custom permissions. Keys hold payments, email, SMS, Google Ads, tracking pixels, and the optional AI API key. Billing is the live Super Admin plan catalog. Integrations: QuickBooks, Xero, calendar feed.

  • Pixels (GA4, GTM, Meta, TikTok) run on your company site, not the marketing domain.
  • AI on the desk uses platform models by default. Own ChatGPT or Claude keys appear on Keys when the plan allows BYOK.

04

MCP tools

Regal Compass MCP is an HTTP tool server the desk uses for Site Theme and ops AI. Writes land in draft. You publish in admin or with regal publish.

  1. 01

    What it is

    POST /tools/:name with Authorization: Bearer and, when the body includes companyId, X-MCP-Token (HMAC of companyId + expiry). Local listen is port 8787.

  2. 02

    Who uses it

    Companyadmin calls it for the theme editor and ops chat. Agencies building a site use the Theme CLI. Tenants are not given MCP_SERVER_SECRET — that is a platform operator secret.

Theme

read_company_context · list_company_sections · read_section_by_id · validate_jsx · dry_run_patch_section · patch_section_by_id · list_edit_history · rollback_last_edit · classify_edit_intent · list/update_company_texts · update_section_texts · update_branding · list/update_company_asset · add_nav_link · remove_nav_link · diff_from_theme_template · reset_section_from_template · apply_full_theme · duplicate_section_to_page

Ops read

get_company_ops_summary · get_bookings_summary · get_booking_details · list_customers_summary · get_customer_details · list_vehicles · get_vehicle_details · list_drivers_summary · list_leads_summary · get_lead_details · get_inbox_summary. Some tools accept revealPii — treat that as sensitive and keep it off unless you must show a phone or email.

Ops write

create_customer · update_customer · create_vehicle · update_vehicle · create_booking · update_booking_status · create_lead · update_lead_status. Writes still respect company scope. Booking status values match the desk (pending through trip_completed or cancelled).

Google Ads

get_google_ads_status · list_google_ads_campaigns · get_google_ads_campaign · get_google_ads_insights · get_google_ads_diagnostics · update_google_ads_campaign_status · update_google_ads_campaign_budget · add_google_ads_negative_keywords · create_google_ads_campaign. The Ads account must already be connected on Keys.

  • ChatGPT / Claude custom connectors use POST /mcp with OAuth (not MCP_SERVER_SECRET).
  • GET /mcp/tools lists names for the desk. GET /health reports env and database. Theme JSX patch tools stay on the secret REST path only.

05

Connect ChatGPT

Three paths: desk BYOK, ChatGPT custom MCP connector (OAuth), or coding against a pulled theme.

  1. 01

    ChatGPT MCP connector

    In ChatGPT, add a custom connector / MCP server. Server URL: https://mcp.regal-compass.com/mcp. Auth: OAuth. Name: Regal Compass. Sign in on app.regal-compass.com, pick your company, Allow. Theme JSX patch tools are not on this connector — use Site Theme or the Theme CLI for that.

  2. 02

    Desk AI (BYOK)

    Open Settings → Keys → AI API key. This block appears only when Super Admin allows your own key. Otherwise the desk uses platform AI.

  3. 03

    Pick ChatGPT (OpenAI)

    Provider: ChatGPT (OpenAI). Model id example: gpt-4.1-mini. Paste the OpenAI API key. Save. Inbox compose, ops chat, and theme help use that key. Platform AI credits are not charged on this path.

  4. 04

    Theme work with a coding agent

    Connect the Theme CLI, regal pull, open the folder in Cursor or another coding tool that can follow AGENTS.md. Do not invent magic tags. Sync drafts; the owner publishes.

    REGAL_API_BASE=https://app.regal-compass.com regal pull
    regal docs
    regal sync
    regal publish
  5. 05

    Clear the key

    On the same Keys form, check clear key and save to return to platform AI.

06

Connect Claude

Same Keys form as ChatGPT, Anthropic as the provider. For layouts, Claude Code or Cursor in the pulled theme folder — publish still belongs to the owner.

  1. 01

    Desk AI (BYOK)

    Open Settings → Keys → AI API key. Allowed only when the plan lets you bring your own key.

  2. 02

    Pick Claude (Anthropic)

    Provider: Claude (Anthropic). Model id example: claude-sonnet-4-5. Paste the Anthropic API key. Save. The same inbox, ops, and theme-help surfaces use Claude instead of the platform default.

  3. 03

    Theme work with Claude Code or Cursor

    regal pull, read AGENTS.md and REGAL-MAGIC-TAGS-GUIDE.md, edit JSX, regal sync. Preview draft. Owner runs regal publish or Publish in Site Theme.

    REGAL_API_BASE=https://app.regal-compass.com regal setup
    # work in the theme folder with Claude Code or Cursor
    regal sync
    regal preview --draft
    regal publish
  4. 04

    Clear the key

    Check clear key on Keys to drop the Anthropic key and use platform AI again.

Open the desk

Create the company, load the fleet, publish the site. CLI and BYOK wait until you need them.

Start free trial