Docsbook
Visão geral

Update site address

MCPupdate_site_address
WRITE$0.00001 / call
Features

Change the ADDRESS of the site: the in .docsbook.io — its path name / subdomain. NOT the display name (update_branding custom_name), NOT a domain of their own (update_domain). Works for EVERY project, including one whose pages come from the user's own GitHub repository — the address is a Docsbook setting and no repository is renamed. Pass an empty name to clear it and fall back to the default address. Report site_url from the result verbatim.

Input2
Authorizationheaderrequired
Your API key, for the REST call. Sent from your browser straight to the API — never to Docsbook, never stored.
workspace_idstring
Workspace ID (optional when the MCP endpoint is auto-scoped to a workspace). Numeric workspace id — OR the project as the user names it: 'owner/repo', the repo name alone, the site's display name, its docs URL or custom domain. Text is resolved server-side; an ambiguous name returns the candidates instead of guessing, so pass what the user said rather than calling list_workspaces first.
namestringrequired
The new name, as a person would write it — 'Acme API'. It becomes acme-api.docsbook.io.
Use cases
  • Call it when the user asks to change the site's URL or path («поменяй адрес сайта», «поменяй path name»), and when a project is still on the opaque ws-- address it was reserved with before it had a name.
Limitations
  • The name is slugged the way the create form slugs it ('Acme API' → acme-api); a taken or reserved name is REFUSED, never silently suffixed into a different URL.
  • 🔴 THIS MOVES A LIVE URL — the old address stops serving the site, so only call it when the user asked for it.
Example input
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_site_address",
    "arguments": {
      "name": "<name>"
    }
  }
}

Atualizado

Esta página foi útil?