Skip to main content
Glama

Connect custom domain

setup_custom_domain
Idempotent

Connect the user's own domain (e.g. www.example.com, example.com, or landing.example.com) to a Convika landing page.

Use when the user wants their page accessible on their own domain instead of {subdomain}.convika.page (独自ドメイン, 自分のドメインでホームページ・ランディングページを公開). Returns the CNAME record for routing and TXT record for ownership verification. After DNS setup, SSL is automatically provisioned.

  • Available on all plans. Free: 1 custom domain, Pro/MAX: unlimited.

  • Standard flow: connect a www site first, then ask the user to add the returned CNAME and TXT records.

  • example.com and www.example.com connect the same pair: www.example.com is the site that serves the page, and example.com redirects to it (301, path and query kept) once its A record points at Convika. guidance.rootRedirect lists the records to add (A @ to Convika's IPv4, CNAME www, TXT) and any to delete. The pair counts as one domain. If example.com already shows another site, Convika connects only www and leaves example.com alone (guidance.rootRedirect says so). If the response has guidance.rootNotServed instead, example.com won't open the page: tell the user to share the www URL. Do not start a DNS-provider discussion during initial setup.

  • If the tool returns domain_provider_error, tell the user this is a Convika-side provider provisioning failure. Do not tell the user to wait for DNS propagation or change DNS records until Convika fixes the provider error.

  • If the tool returns invalid_hostname, the site itself can't be used (for example, reserved names such as anything.example.com). Ask the user for a site on a domain they own and call this tool again with it.

  • A value with a path (www.example.com/lp) returns path_not_supported: call set_site_url with the full URL instead.

  • If guidance.existingSite is present, another site shows there now and connecting would replace that whole site. Tell the user before any DNS change, as the text says.

  • Call get_domain_status to check verification progress after DNS setup

Input Schema

NameRequiredDescriptionDefault
siteIdYesThe ID of the page to add a custom domain to
hostnameYesThe custom domain hostname (e.g. 'www.example.com' or 'landing.example.com'). A root such as 'example.com' connects 'www.example.com'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / siteId / description
      Previous value: -"The ID of the site to add a custom domain to"New value: +"The ID of the page to add a custom domain to"
  2. Changed1 schema field changed
    • changedInput schema / properties / hostname / description
      Previous value: -"The custom domain hostname (e.g. 'www.example.com' or 'landing.example.com'). Must be a subdomain, not a root/apex domain like 'example.com'."New value: +"The custom domain hostname (e.g. 'www.example.com' or 'landing.example.com'). A root such as 'example.com' connects 'www.example.com'."
  3. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only say non-readOnly, idempotent, non-destructive; the description adds the substantive behavior: it returns CNAME + TXT records, SSL is auto-provisioned afterward, plan quotas (Free 1, Pro/MAX unlimited), the www/apex pairing and 301 redirect semantics, and named failure modes (domain_provider_error, invalid_hostname, path_not_supported, guidance.existingSite). One mild tension: it warns that connecting may 'replace that whole site' while destructiveHint=false — but this is domain-routing replacement surfaced through guidance.existingSite with a required user warning, not data deletion, so it does not rise to a contradiction.

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?

Front-loaded with purpose and return values, then organized as scannable bullets keyed to error codes and guidance fields. It is long for a 2-parameter tool and some clauses (redirect path/query preservation, 'as the text says') are detail-heavy, but nearly every line maps to a real decision the agent must make.

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?

There is no output schema, and the description compensates fully: it enumerates the returned records (CNAME, TXT) and the guidance fields (rootRedirect, rootNotServed, existingSite) with instructions for each. Combined with error-code handling and the verification follow-up, an agent has everything needed to call and interpret this tool.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3; the description goes beyond it by explaining that a root such as example.com connects www.example.com and that the pair counts as one domain, plus the path_not_supported → set_site_url rule. It does not restate siteId semantics, but the schema already covers that adequately.

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?

States a specific verb and resource ('Connect the user's own domain ... to a Convika landing page') and immediately contrasts with the default {subdomain}.convika.page hosting. It also names the neighboring tools it is not (set_site_url for path-bearing values, get_domain_status for verification), so an agent can route correctly without opening any schema.

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?

Gives explicit when-to-use ('use when the user wants their page on their own domain'), when-not/alternative routing ('a value with a path returns path_not_supported: call set_site_url instead'), and a follow-up step ('call get_domain_status after DNS setup'). It even includes negative guidance ('do not start a DNS-provider discussion during initial setup'), which is rare and useful.

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.