Skip to main content
Glama

List custom domains

list_domains
Read-only

Retrieve custom domains and their status, problem details, DNS records, and publication without a DNS check, either as a full profile list with limits or one domain by hostname or publication.

Instructions

Read custom domains without running a DNS check: status, problem, DNS records and the publication shown. No address: every custom domain of the profile plus how many it holds and may hold. With type, namespace and id, or with hostname: that one custom domain.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

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

Input Schema

NameRequiredDescriptionDefault
idNoPublication ID
typeNoPublication type; with namespace and id, instead of hostname
hostnameNoCustom domain as a bare hostname, e.g. www.example.com; instead of type, namespace and id
namespaceNoPublication namespace
ownerTokenNoWhole list or by hostname: an admin profile token. By publication: a profile token or an owner token added to the profile. Default: env BREWPAGE_OWNER_TOKEN (local server only).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv1.22.0
    • addedInput schema / properties / hostname
      Added value: +{
      +  "description": "Custom domain as a bare hostname, e.g. www.example.com; instead of type, namespace and id",
      +  "type": "string"
      +}
    • addedInput schema / properties / id
      Added value: +{
      +  "description": "Publication ID",
      +  "type": "string"
      +}
    • addedInput schema / properties / namespace
      Added value: +{
      +  "description": "Publication namespace",
      +  "type": "string"
      +}
    • changedInput schema / properties / ownerToken / description
      Previous value: -"Admin token of the profile. Default: env BREWPAGE_OWNER_TOKEN (local server only)."New value: +"Whole list or by hostname: an admin profile token. By publication: a profile token or an owner token added to the profile. Default: env BREWPAGE_OWNER_TOKEN (local server only)."
    • addedInput schema / properties / type
      Added value: +{
      +  "description": "Publication type; with namespace and id, instead of hostname",
      +  "enum": [
      +    "html",
      +    "site"
      +  ],
      +  "type": "string"
      +}
  2. Addedv1.18.0

TDQS

A3.9/5.0
Behavior3/5

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

readOnlyHint=true is already declared, and the description usefully adds that no DNS lookup is performed and what fields come back. It stops short of stating auth/permission behavior (ownerToken scope) or ordering/pagination for the full-list mode, so it adds context but not depth.

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?

Three short sentences, front-loaded with the read-only/no-DNS constraint. The telegraphic phrasing ("No address: every custom domain...") is slightly elliptical but no sentence is wasted.

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 5-parameter, read-only, no-output-schema tool, the description covers both invocation modes and the returned fields, and ownerToken auth is handled by the schema. Minor gap: no note on ordering or list size limits in the all-domains mode.

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%, so each parameter is already documented, including the type/namespace/id vs hostname mutual exclusion. The description adds the zero-argument case, which the schema cannot express, but otherwise restates the combination logic rather than extending it.

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 ("Read custom domains"), enumerates the returned fields (status, problem, DNS records, publication), and explicitly contrasts with DNS-checking tools via "without running a DNS check", which separates it from check_domain.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives a clear selection rule: no address returns every custom domain of the profile with capacity counts, while type+namespace+id or hostname returns a single one. It implicitly routes DNS verification elsewhere, but never names check_domain or set_domain/remove_domain as the alternatives.

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