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 a TXT record the user must add at their DNS provider. Idempotent: calling twice with the same (siteName, domain) returns the existing record instead of creating a duplicate. After the TXT is published (typically within minutes; up to 24h), call verify_custom_domain with the returned recordId. The site itself must already exist on a platform subdomain (e.g. {name}.vibedeploy.be or {name}.vibedeploy.eu). Call deploy_site first if it doesn't.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
domainYesThe user-owned hostname to attach (e.g. 'tester.subsite.site'). Must be a valid FQDN.
siteNameYesThe VibeDeploy site name to attach the domain to (e.g. 'tester').

Output Schema

TableJSON 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.
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 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.
verificationRecordNoOnly present when status is pending_verification.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • removedOutput schema / properties / request_id
      Removed value: -{
      -  "description": "Server-assigned request correlation id. Quote it when contacting support.",
      -  "type": "string"
      -}
  2. Changed1 schema field changed
    • addedOutput schema / properties / request_id
      Added value: +{
      +  "description": "Server-assigned request correlation id. Quote it when contacting support.",
      +  "type": "string"
      +}
  3. 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')."
  4. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already declare idempotentHint=true and destructiveHint=false, and the description adds concrete idempotency semantics: calling twice with the same (siteName, domain) returns the existing record instead of creating a duplicate. It also discloses the return value (TXT record), the DNS propagation delay, and the prerequisite that the site must exist, adding value beyond the structured annotations.

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 compact but information-dense, front-loading the core action and return value before covering idempotency, next actions, and preconditions. Every sentence contributes a distinct, actionable piece of information, and the structure mirrors the workflow an agent must follow.

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?

With an output schema present, annotations covering safety and idempotency, and a description that covers prerequisites, next steps, and return semantics, nothing an agent needs to correctly select and invoke this tool is missing. The description fully compensates for the tool's moderate complexity.

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%, so the schema already documents both siteName and domain with examples. The description reinforces the relationship between the two parameters through idempotency wording and the explicit platform-subdomain prerequisite, but it does not materially add meaning beyond the schema's own parameter descriptions.

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 clearly states the tool starts attaching a user-owned domain to an existing site, returns a TXT record for DNS verification, and is explicitly step 1 of a 2-step flow. It distinguishes itself from the sibling verify_custom_domain by naming the next step and the recordId it produces.

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?

The description gives explicit when-to-use context: attaching a user-owned domain, and it prescribes the sequence — call verify_custom_domain after TXT publication, and call deploy_site first if the site doesn't exist. It also states the site must already exist on a platform subdomain, which is a clear precondition.

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.