Skip to main content
Glama

vibedeploy

by be.vibedeploy

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.
request_idNoServer-assigned request correlation id. Quote it when contacting support.
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.

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already provide idempotentHint and non-destructiveHint. Description adds that the tool returns a TXT record and the user must add it at their DNS provider. Also notes the required follow-up step. Could mention potential errors if domain already attached, but overall solid.

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

Conciseness4/5

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

Description is concise, front-loaded with the main action, and structured into few sentences. Some redundancy with annotations (idempotent statement), but not wasteful.

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

Completeness4/5

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

Given the output schema exists, description adequately covers prerequisites, return value (TXT record), and next steps. For a two-step domain attachment process, it is complete enough.

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 coverage is 100% with descriptions. Description adds example values and clarifies that domain must be a valid FQDN and siteName is a VibeDeploy site name, but does not significantly enhance understanding beyond the schema.

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 it is the first step of attaching a custom domain to a site, and returns a TXT record for DNS validation. It distinguishes from sibling tools like verify_custom_domain and remove_custom_domain.

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?

Explicitly specifies prerequisites (site must exist on platform subdomain, else call deploy_site first), recommends calling verify_custom_domain after DNS propagation, and highlights idempotent behavior. Guides the agent on when and how to use.

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

All vibedeploy toolsInspect
Try in Browser
RayrunBuild, deploy, and operate MCP servers without becoming an infrastructure team.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A4.2/5.0
Disambiguation5/5

Every tool has a clearly distinct purpose, from deployment and file management to domain configuration and analytics. Even similar-sounding tools like add_files and add_file_chunk are well-differentiated by context and use case.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern using snake_case (e.g., add_custom_domain, list_sites, delete_source_file). The naming is predictable and easy to understand.

Tool Count4/5

39 tools is higher than the typical 3-15 range, but each tool serves a necessary function for a comprehensive deployment platform. The count is justified by the broad feature set, though slightly heavy.

Completeness5/5

The tool set covers the full lifecycle of site deployment, management, backup, custom domains, form handling, analytics, and source editing. There are no obvious gaps for the intended functionality.

Resources