Set doc status

MCPset_doc_status

WRITE$0.00001 / call

Features

Move ONE documentation page through its lifecycle — the call for 'this spec is approved', 'freeze this decision record', 'mark the old guide deprecated', «эту страницу утвердили», «заморозь», «пометь устаревшей». Statuses: generated — A machine wrote this page and no human has read it yet. draft — Someone is still writing it. Not ready to be read as settled. review — Waiting for a human to read it and decide. approved — A human read this version and signed off. Safe to build work from. Agents may build from it. locked — Frozen on purpose. Agents may read it and build from it, but may not rewrite it. Agents may build from it. deprecated — Superseded. Kept so its links keep working, not to be relied on. archived — History. Neither built from nor edited. Each page also carries a version, bumped automatically by every write that changes its text. That is not a bug to work around by re-approving in the same breath — re-approve after somebody has read the new text. Not every move is legal: from each status only the ones listed for it (get_doc_outline shows where every page sits).

Input5

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 page: a repo file path ('specs/auth.md') or its URL slug ('specs/auth').

statusstringrequired

The status to move it to. One of: generated, draft, review, approved, locked, deprecated, archived.

versionstring

Optional explicit version, e.g. '1.0' when a draft becomes the first real release. Omit to keep the page's current version — a status change is not an edit.

notestring

Why, in the approver's own words. Goes into the commit message and the change record.

Output8

pathstring

fromstring

The status the page was at.

tostring

versionstring

lifecycleobject

The page's lifecycle after the move, in the same shape read_doc returns.

unchangedboolean

True when the page already sat there and nothing was committed.

commitShastring

pullRequestobject

Limitations

Writes to it are refused.
Writes to it are refused.
🔴 APPROVAL IS OF A VERSION, NOT OF A PAGE: editing an approved page sends it back to review, because the sign-off was of the text that just changed.
🔴 This is the only way to reach approved or locked.
write_docs cannot set them, so an agent can never approve its own output as part of writing it.
REQUIRES a read-write MCP token.

Example input

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "set_doc_status",
    "arguments": {
      "path": "<path>",
      "status": "generated"
    }
  }
}

Example output

{
  "path": "<path>",
  "from": "<from>",
  "to": "<to>",
  "version": "<version>",
  "lifecycle": {},
  "unchanged": true,
  "commitSha": "<commitSha>",
  "pullRequest": {}
}

Aktualisiert Sep 24, 2026