Skip to main content
Glama

Create an API domain

create_domain

Creates an API domain that defines the public URL namespace for your deployed endpoints. Run it before deploying endpoints, then pass the returned id as the deployment's domainId.

Instructions

Creates an API domain — the namespace your deployed endpoints live under. Its slug becomes the first path segment of every endpoint in it: https://api.qu4zr.io/{slug}/{path} — and, where site hosts are enabled, the HOSTNAME a site is served at (https://{slug}.{zone}/), so it is a public, permanent, brandable name and not an internal id. The reply carries the domain's baseUrl; use that as the canonical base for its pages rather than assembling a URL. Do this BEFORE deploy_endpoint, then pass the returned id as deploy_endpoint's domainId. The slug is GLOBALLY unique across all users and is effectively permanent once endpoints are deployed and callers depend on the URL, so it requires confirm=true — call without confirm first to preview, and let the user pick the slug rather than choosing a memorable one yourself. Omit slug to derive it from name.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "name": "<name>"
    },
    "name": "create_domain"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesDisplay name, e.g. "Orders API".
slugNoURL segment, e.g. "orders-api". Globally unique. Defaults to name.
tagsNo
confirmNoMust be true to create. Omit/false returns a preview only.
descriptionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.53.0

TDQS

A4.6/5.0
Behavior4/5

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

No annotations are supplied, so the description carries the full load, and it does most of it: global slug uniqueness, effective permanence once endpoints are deployed, the confirm/preview gate, and the downstream effect (hostname, base in URLs). What it does not cover is error behavior on slug collision or whether creation is reversible/deletable.

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?

Front-loaded with purpose, then URL implication, then the returned baseUrl, then ordering vs deploy_endpoint, then the slug/confirm constraint. Dense but every sentence adds decision-relevant information; no filler.

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?

For a mutation tool with no annotations and no output schema, the description covers prerequisites, the preview gate, the permanence warning, and the relevant part of the response (baseUrl). Minor gap: no mention of failure modes for duplicate slugs or of the tags/description parameters.

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 60%, and the description compensates for the most consequential gap by explaining that slug is a globally unique public URL segment that defaults from name. confirm's preview semantics are restated and reinforced. However, tags and description parameters remain undocumented in both schema and description.

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 ('Creates an API domain') and immediately defines what a domain is — the namespace endpoints live under, with its slug as the first path segment. It distinguishes the concept from an internal id and from sibling tools like deploy_endpoint, so an agent can place it correctly in the workflow.

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?

Explicit ordering guidance: 'Do this BEFORE deploy_endpoint, then pass the returned id as deploy_endpoint's domainId.' It also prescribes the two-step confirm flow (call without confirm to preview) and tells the agent not to pick the slug itself.

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