Domain Tools

MCP tools for listing custom domains and discovering domain IDs

Tools for discovering custom domains registered to a workspace. Creating a recording link requires a domainId, so these are the tools an agent uses to find one before calling userplane_create_link.

userplane_list_domains

List custom domains registered to a workspace. Each domain has a status (pending, verified, revoked). Filter by status to find only usable domains.

Parameter	Type	Required	Description
workspaceId	string	Yes	Workspace ID
page	number	No	Page number (default: 1)
per_page	number	No	Results per page (default: 10, max: 50)
status	string	No	Filter by status (pending, verified, revoked)

Returns: Paginated list of domains. Each entry is a flat object with domainId, domainUrl, domainStatus, and createdAt.

Only verified domains can be used to create recording links. Pass status: "verified" to filter out pending and revoked domains in a single call.

---

userplane_get_domain

Retrieve details for a single custom domain including URL, verification status, and creation time.

Parameter	Type	Required	Description
workspaceId	string	Yes	Workspace ID
domainId	string	Yes	Domain ID

Returns: A flat object with domainId, domainUrl, domainStatus, and createdAt.

---

Example prompts

List the verified domains in workspace {workspaceId}, then create a reusable recording link on the first one and reference it as "onboarding-form".

Which domains are registered in workspace {workspaceId}? Are any of them still pending verification?

Replace {workspaceId} with your actual workspace ID from the Userplane dashboard URL bar.

Related articles

• Recording Link Tools — tools for creating and managing recording links.
• Workspace Tools — tools for profiles, workspaces, and projects.
• Getting Started — first steps after connecting your AI client.