Skip to main content
Glama

Attach a custom domain (step 1 of 2)

add_custom_domain
Idempotent

Start 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.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "siteName": "<siteName>",
      "domain": "<domain>"
    },
    "name": "add_custom_domain"
  }
}

Input Schema

NameRequiredDescriptionDefault
domainYesThe user-owned hostname to attach, e.g. 'shop.example.com'. Must be a valid FQDN.
siteNameYesThe VibeDeploy site name to attach the domain to (e.g. 'tester').

Output Schema

NameRequiredDescriptionDefault
domainYes
statusYespending_verification on first attach; verified if the domain was already set up earlier.
nextCallNoStructured hint for the next tool call (e.g. verify_custom_domain). Lets an agent chain without parsing instructions.
recordIdYesPass this to verify_custom_domain after the TXT is in place.
dnsRecordsNoEvery 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.
dnsProviderNoThe provider that hosts the domain's DNS, recognised from its nameservers. Absent when unknown.
instructionsYesPlain-English instructions for the user.
alreadyAttachedNoTrue when the call returned an existing record instead of creating one (idempotent path).
dnsAutoConfiguredNoTrue 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.
verificationRecordNoOnly present when status is pending_verification.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • removedOutput schema / properties / dnsProvider / properties / helpUrl / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / dnsProvider / properties / helpUrl / type
      Added value: +[
      +  "string",
      +  "null"
      +]
  2. Changed1 schema field changed
    • addedOutput schema / properties / dnsProvider
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "The provider that hosts the domain's DNS, recognised from its nameservers. Absent when unknown.",
      +  "properties": {
      +    "helpUrl": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "The provider's own help article on DNS records, when known."
      +    },
      +    "id": {
      +      "type": "string"
      +    },
      +    "name": {
      +      "description": "The company that hosts the domain's DNS, e.g. Combell, OVHcloud, Cloudflare.",
      +      "type": "string"
      +    },
      +    "panelUrl": {
      +      "description": "Where the user logs in to edit the DNS records.",
      +      "type": "string"
      +    },
      +    "steps": {
      +      "description": "Steps specific to this provider, in order. Relay them with the records.",
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    }
      +  },
      +  "required": [
      +    "id",
      +    "name",
      +    "panelUrl",
      +    "helpUrl",
      +    "steps"
      +  ],
      +  "type": "object"
      +}
  3. Changed3 schema fields changed
    • addedOutput schema / properties / dnsRecords
      Added value: +{
      +  "description": "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.",
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "alternative": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "type": {
      +            "type": "string"
      +          },
      +          "value": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "type",
      +          "value"
      +        ],
      +        "type": "object"
      +      },
      +      "fqdn": {
      +        "type": "string"
      +      },
      +      "host": {
      +        "description": "Value for the provider's Host/Name field ('@' is the domain itself).",
      +        "type": "string"
      +      },
      +      "purpose": {
      +        "enum": [
      +          "routing",
      +          "ownership",
      +          "www"
      +        ],
      +        "type": "string"
      +      },
      +      "type": {
      +        "type": "string"
      +      },
      +      "value": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "purpose",
      +      "type",
      +      "host",
      +      "fqdn",
      +      "value"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / verificationRecord / properties / host
      Added value: +{
      +  "description": "What to type in the DNS provider's Host/Name field (e.g. '_vibedeploy.shop'); most providers append the domain themselves.",
      +  "type": "string"
      +}
    • changedOutput schema / properties / verificationRecord / properties / name / description
      Previous value: -"DNS record name to add (e.g. '_vibedeploy.shop.example.com')."New value: +"Full DNS record name (e.g. '_vibedeploy.shop.example.com')."
  4. Changed3 schema fields changed
    • changedInput schema / properties / domain / description
      Previous value: -"The user-owned hostname to attach (e.g. 'tester.subsite.site'). Must be a valid FQDN."New value: +"The user-owned hostname to attach, e.g. 'shop.example.com'. Must be a valid FQDN."
    • changedOutput schema / properties / dnsAutoConfigured / description
      Previous value: -"True when the verification TXT was written automatically because the domain is managed through VibeDeploy's Gandi account. The caller can call verify_custom_domain immediately without waiting for the user to add a TXT manually. Absent / false means the user has to add the record at their own DNS provider before verify will succeed."New value: +"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."
    • changedOutput schema / properties / verificationRecord / properties / name / description
      Previous value: -"DNS record name to add (e.g. '_vibedeploy.tester.subsite.site')."New value: +"DNS record name to add (e.g. '_vibedeploy.shop.example.com')."
  5. Changed1 schema field changed
    • removedOutput schema / properties / request_id
      Removed value: -{
      -  "description": "Server-assigned request correlation id. Quote it when contacting support.",
      -  "type": "string"
      -}
  6. Changed1 schema field changed
    • addedOutput schema / properties / request_id
      Added value: +{
      +  "description": "Server-assigned request correlation id. Quote it when contacting support.",
      +  "type": "string"
      +}
  7. Changed1 schema field changed
    • changedInput schema / properties / siteName / description
      Previous value: -"The vibedeploy.be site name to attach the domain to (e.g. 'tester')."New value: +"The VibeDeploy site name to attach the domain to (e.g. 'tester')."
  8. First observed

TDQS

A4.7/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond the annotations, the description discloses the returned DNS records, the idempotent behavior in concrete terms, the asynchronous verification path, the expected propagation window, and automatic re-checking with email notification. These details materially help an agent understand side effects and follow-up behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the core action and return value, then proceeds through idempotency, verification, timing, and prerequisites in a logical order. Every sentence contributes useful operational context without redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a two-step domain attachment flow, the description covers the prerequisite, the immediate return value, the required follow-up call, and asynchronous outcomes. With an output schema available, it need not describe the full response shape, and it does not omit anything critical for correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, and the schema already defines siteName and domain with examples and FQDN requirements. The description reinforces that the domain is user-owned and that identical siteName/domain inputs return the existing record, but it adds little syntax or format detail beyond the schema baseline.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: attaching a user-owned domain to an existing site, explicitly as step 1 of 2. It clearly distinguishes this from verification, listing, and removal sibling tools by explaining that it returns DNS records and a recordId for later verification.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives explicit workflow guidance: call verify_custom_domain with the returned recordId after DNS records are published, and call deploy_site first if the site does not already exist. Timing expectations and automatic re-checks are also stated, leaving little ambiguity about when and how to use this tool.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.