Skip to main content
Glama

Add a custom domain

add_custom_domain

Attach a new hostname to an existing deployed app in pending DNS state and return DNS setup instructions. Requires dns_mode: subdomain_cname or apex_address. Rejects hostnames that are already registered. After configuring DNS with your provider, call verify_custom_domain to activate routing.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
app_idYesTarget app id
domainYesHostname to connect to this app
dns_modeYesDNS routing mode for this hostname

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare the write/non-idempotent/open-world profile, and the description usefully adds beyond that: the app is left in a 'pending DNS state', DNS instructions are returned, duplicate hostnames are rejected, and routing only activates after a separate verify call. It doesn't cover failure modes or rollback, keeping it just short of a 5.

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?

Four short sentences, front-loaded with the core action and scope, each contributing distinct information (state, requirements, rejection rule, next step). Slight redundancy with the schema enum values, but no filler.

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 write tool with full annotation coverage, complete schema, and only three params, the description covers the action, resulting state, constraints, and the required follow-up call. No output schema exists, yet return content (DNS instructions) is still summarized, so nothing essential is missing.

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 all three params (including the enum) documented in the schema itself. The description repeats the dns_mode enum values but adds no syntax, format, or constraint detail beyond what the schema provides, matching the baseline for fully documented params.

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 (attach) and resource (a new hostname/domain to a deployed app), and clarifies the resulting state (pending DNS) plus what it returns (DNS setup instructions). It also implicitly distinguishes itself from verify_custom_domain and get_custom_domain_instructions.

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 names the follow-up tool (verify_custom_domain) and the condition that triggers it, states the required dns_mode values, and gives an exclusion (hostnames already registered are rejected). An agent knows exactly when to call this and what to do next.

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