Skip to main content
Glama

Create custom domain

create_custom_domain

Claim a custom hostname for this tenant and generate its DNS challenge. The claim alone grants NOTHING until ownership is proven — it returns TWO DNS records (an ownership TXT and a permanent routing CNAME) in dns_records that the customer must add at their DNS provider. Present those records to the human, wait for them to add them, then call verify_custom_domain. slug_prefix/root_endpoint are optional here and are usually set later with update_custom_domain (after the domain verifies).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
hostnameYesThe customer's fully-qualified hostname, e.g. shop.customer.com. Immutable — it is the domain's identity.
slug_prefixNoOptional. The endpoint subtree this domain mounts (an isolation boundary). Usually the slug prefix of the app this domain should front. Can be set later with update_custom_domain.
display_nameNoOptional human label, e.g. 'Marketing site'.
root_endpointNoOptional. What the domain root ('/') serves, RELATIVE to slug_prefix. Can be set later with update_custom_domain.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
statusYes
hostnameYes
dns_recordsNo
slug_prefixNo
verified_atNo
activated_atNo
display_nameNo
root_endpointNo
last_check_messageNo
cert_status_messageNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Goes beyond annotations by explaining that the claim alone grants nothing until ownership is proven, and that it returns DNS records for verification. This contextualizes the non-idempotent and non-read-only nature without contradicting the annotations.

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?

The description is slightly verbose but every sentence carries essential information: purpose, consequence, workflow, and parameter timing. It is well-structured and free of fluff, though the multi-clause sentences could be tightened.

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?

The description covers the core workflow (claim, present records, verify) and references update_custom_domain for later configuration. It does not detail the output schema shape beyond dns_records, but that is provided separately, so the context is sufficient.

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?

The schema already covers all 4 parameters with detailed descriptions, so the baseline is 3. The description adds value by noting that slug_prefix and root_endpoint are typically set later, which clarifies their optional usage in this specific call.

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?

Clearly states the action (claim a custom hostname and generate DNS challenge) and differentiates from related tools like verify_custom_domain and update_custom_domain. It specifies the primary output (two DNS records) and the provisional nature of the claim.

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 instructs to present DNS records to the human, wait for them to be added, and then call verify_custom_domain. Also notes that slug_prefix/root_endpoint are usually set later with update_custom_domain, providing clear guidance on when to use alternatives.

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.

Resources