Attach a custom domain (step 1 of 2)
add_custom_domainStart attaching a user-owned domain to an existing site: returns the DNS records the user adds at their DNS provider (a routing record that sends visitors here, plus a TXT that proves ownership). Idempotent: the same siteName and domain return the existing record. Once the records are published (usually minutes, up to 24h), call verify_custom_domain with the returned recordId; VibeDeploy also re-checks automatically for a few days and emails the user when the domain is live. The site must already exist; call deploy_site first if it does not.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| domain | Yes | The user-owned hostname to attach, e.g. 'shop.example.com'. Must be a valid FQDN. | |
| siteName | Yes | The VibeDeploy site name to attach the domain to (e.g. 'tester'). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| domain | Yes | ||
| status | Yes | pending_verification on first attach; verified if the domain was already set up earlier. | |
| nextCall | No | Structured hint for the next tool call (e.g. verify_custom_domain). Lets an agent chain without parsing instructions. | |
| recordId | Yes | Pass this to verify_custom_domain after the TXT is in place. | |
| dnsRecords | No | Every record to add at the DNS provider: routing (sends visitors to VibeDeploy), ownership (TXT) and the optional www/apex twin. Only present when status is pending_verification. | |
| dnsProvider | No | The provider that hosts the domain's DNS, recognised from its nameservers. Absent when unknown. | |
| instructions | Yes | Plain-English instructions for the user. | |
| alreadyAttached | No | True when the call returned an existing record instead of creating one (idempotent path). | |
| dnsAutoConfigured | No | True when the verification TXT was written automatically (domain registered through VibeDeploy): call verify_custom_domain right away. Otherwise the user adds the record at their DNS provider first. | |
| verificationRecord | No | Only present when status is pending_verification. |