Mark path as funnel step

MCPmark_path_as_funnel_step

WRITE$0.00001 / call

Features

Add a documentation PAGE to a funnel as its next step, creating the page goal if it does not exist yet. The shortcut for 'this page is part of the route readers should take' — it saves creating a goal and then editing the funnel. Creates the funnel too if the name is new. Note the broad-entry rule: if this is the FIRST step of a new funnel you will get a warning, because a single page as step 1 excludes every reader who arrived deep.

Input4

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.

pathstringrequired

The doc path, e.g. '/docs/quickstart'.

funnelstringrequired

Funnel name to append the step to. Created if it does not exist.

positionnumber

0-based index to insert at. Appends when omitted.

Output5

workspace_idnumber

funnelobject

goalstring

issuesobject[]

unchangedstring

Example input

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "mark_path_as_funnel_step",
    "arguments": {
      "path": "<path>",
      "funnel": "<funnel>"
    }
  }
}

Example output

{
  "workspace_id": 0,
  "funnel": {},
  "goal": "<goal>",
  "issues": [],
  "unchanged": "<unchanged>"
}

更新于 Sep 24, 2026