Edit goal

MCPedit_goal

WRITE$0.00001 / call

Features

CORRECT a goal that already exists — its label, what one completion is worth, or what it matches — without breaking it. A funnel step refers to a goal BY KEY, so archiving the goal breaks every funnel naming it, and a funnel that loses a step reports a BETTER conversion rate than the real one. And created_at is when this project started measuring the thing: a re-create resets it, so four months of history reads as a goal created today. A different name is a different goal. Pass only what changes. Warnings come back in issues and are worth relaying verbatim.

Input7

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 MCP endpoint is auto-scoped). 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.

keystringrequired

The goal's name, from list_goals. Not editable — see the description.

kindstring

page = a pageview of a path. event = one of the events the docs emit (see get_analytics event names). section = a heading/anchor came into view — THIS is how a 'scrolled as far as pricing' goal works, and it needs no new tracking. outbound = a click leaving for a host (matched by host, so query strings do not matter). One of: page, event, section, outbound.

matchstring

New matcher: a path for 'page', an event name for 'event', an anchor for 'section', a host for 'outbound'.

match_pathstring

New scope. Pass an empty string to clear it and count the goal everywhere.

labelstring

New human label.

value_usdnumber

What ONE completion is worth, in dollars. Pass 0 to clear it — which switches money figures OFF for this goal rather than reporting it as worthless.

Output3

workspace_idnumber

goalobject

issuesobject[]

Limitations

🔴 Not the same as deleting it and creating it again, which was the only route until 2026-09-12 and silently cost two things every time.
The KEY cannot be changed here, deliberately — funnels, MCP callers and the owner's own notes all point at it, and a rename leaves all of them pointing at nothing.

Example input

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "edit_goal",
    "arguments": {
      "key": "<key>",
      "kind": "page"
    }
  }
}

Example output

{
  "workspace_id": 0,
  "goal": {},
  "issues": []
}

更新于 Sep 24, 2026