Skip to main content
Glama

Check custom domain DNS

check_domain

Run an on-demand DNS check for a custom domain to view its status, DNS records, and any problem to fix; repeat only after DNS changes.

Instructions

Run a DNS check of a custom domain now and return its status, problem and DNS records. One check after the DNS records exist is enough: BrewPage keeps checking on its own (nextCheckAt) and reading the status needs no check; another check fits only after a DNS change. Status: pending_dns (DNS records not seen yet), verifying (DNS records found, HTTPS being issued), active (live), lost (DNS records broke after going live; still served until graceEndsAt; restored records and one more check bring it back). problem names the fix. Addressed by publication (type, namespace, id; a profile token or an owner token added to the profile) or by hostname (an admin profile token). A repeat within seconds answers 429 with Retry-After.

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": "check_domain"
  }
}

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
ownerTokenNoBy publication: a profile token or an owner token added to the profile. By hostname: an admin profile token. Default: env BREWPAGE_OWNER_TOKEN (local server only).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.22.0
    • changedInput schema / properties / hostname / description
      Previous value: -"Custom domain, e.g. www.example.com; instead of type, namespace and id"New value: +"Custom domain as a bare hostname, e.g. www.example.com; instead of type, namespace and id"
    • changedInput schema / properties / ownerToken / description
      Previous value: -"By publication: an owner token in the profile. By hostname: an admin token of the profile. Default: env BREWPAGE_OWNER_TOKEN (local server only)."New value: +"By publication: a profile token or an owner token added to the profile. By hostname: an admin profile token. Default: env BREWPAGE_OWNER_TOKEN (local server only)."
  2. Addedv1.18.0

TDQS

A4.6/5.0
Behavior4/5

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

Goes well beyond annotations by disclosing the full status lifecycle (pending_dns, verifying, active, lost), the grace period after loss, and the 429/Retry-After rate limit on rapid repeats. It does not explicitly tie the `readOnlyHint: false` annotation to the fact that the call triggers a check with side effects, but the described behavior is consistent with it.

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-loads the action and return values, then layers status semantics and addressing. Dense with nested parentheticals, but nearly every clause carries operational meaning (state meanings, grace period, rate limit) rather than 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 five-parameter tool with no output schema, the description still explains what is returned, the meaning of each status value, how to recover from `lost`, and how to authenticate. Nothing essential to calling or interpreting the result is missing.

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, but the description adds real value by explaining the two mutually exclusive addressing modes: publication (type, namespace, id) versus bare hostname, plus the token authority required in each case. That clarifies why five optional parameters exist and how they combine.

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 (run a DNS check of a custom domain) and names exactly what comes back (status, `problem`, DNS records). This clearly separates it from siblings like list_domains or set_domain, which do not trigger a check.

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 when-to-use and when-not-to-use guidance: one check after records exist, no check needed to read status, and another only after a DNS change. It also names the alternative behavior (automatic rechecking via `nextCheckAt`), so the agent knows when to skip the call entirely.

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