Skip to main content
Glama

HelpCenter.io for agents

Set the Custom Domain

helpcenter_set_custom_domain
DestructiveIdempotent

Connect the help center to the user's own domain (e.g. help.example.com), as its Settings page does. Then give the user the DNS record from the result to add at their DNS provider; the certificate is requested once the record points here, and the domain goes live minutes later. Follow it with helpcenter_get_custom_domain.

Works once the user has claimed the help center, verified their email address and activated a plan; until then it answers capability_locked with the user's next step (helpcenter_get_help_center shows it too).

Changing to a new domain counts against the help center's 4 changes a month and stops the old domain answering: only set the domain the user asked for. Setting the domain it already has changes nothing. Refused when another help center already holds the domain (domain_taken).

Args:

  • domain (string, required): a host name, without http(s):// or a path.

Returns: { custom_domain } as helpcenter_get_custom_domain answers it.

Input Schema

NameRequiredDescriptionDefault
domainYesThe user's host name for the help center, like 'help.example.com': no http(s)://, no path. A leading 'www.' is dropped.
agent_keyYesThe api_key helpcenter_create_help_center returned for this help center, exactly as returned. Required on every call: this endpoint has no sign-in, so the key is how each call says which help center it acts on. It is sent to HelpCenter.io as this call's credential and nowhere else, and it is never shown again: keep it for the whole task, and never show it to the user or write it into content.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Goes well beyond the annotations by disclosing the 4-changes-per-month quota, that the old domain stops answering, the no-op case when the domain is unchanged, and the domain_taken refusal. The destructiveHint=true annotation is corroborated rather than merely repeated, and the credential/lifecycle context is spelled out in the schema.

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-loaded with the action and its consequence, then prerequisites, then side effects, then args/returns. Dense but purposeful; the multi-clause prerequisite sentence is the only mildly heavy part.

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 destructive, open-world mutation with no output schema, it covers preconditions, quota and irreversibility, error outcomes, and the shape of the return ({ custom_domain }). An agent can execute and report back without further discovery.

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% and the schema description already states 'no http(s)://, no path' and the www. normalization, so the description's domain note is largely duplicative. No additional syntax or validation detail is added beyond what the schema carries.

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 ('Connect the help center to the user's own domain'), and distinguishes itself from the read counterpart by naming helpcenter_get_custom_domain as the follow-up. The DNS/certificate explanation makes the side effect concrete rather than abstract.

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 prerequisites (claimed help center, verified email, activated plan) and what to do when they are unmet (read the capability_locked next step). It also gives a negative rule — only set the domain the user asked for — and routes to helpcenter_get_custom_domain afterwards.

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