Docsbook
概览

Get doc outline

MCPget_doc_outlineREADno token needed$0.008 / call

List every markdown page in the workspace with a short summary (title, heading count, char count) plus its lifecycle — status, version and agentMayBuildFrom. Use it to discover what pages exist before searching or writing. It is also the REVIEW BOARD for documentation that is governed by status: status: 'review' lists what is waiting on a human, status: 'generated' what a machine wrote that nobody has read. counts always describes the whole prefix, not the filtered rows, so 'four of ninety pages are approved' is one call. 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.) · locked (Frozen on purpose. Agents may read it and build from it, but may not rewrite it.) · deprecated (Superseded. Kept so its links keep working, not to be relied on.) · archived (History. Neither built from nor edited.)

Arguments
workspace_idstringoptional

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.

path_prefixstringoptional

Optional: restrict to pages under this path prefix.

statusstringoptional

Optional: only pages at this lifecycle status. counts still covers them all. One of: generated, draft, review, approved, locked, deprecated, archived.

Call it#

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_doc_outline",
    "arguments": {
      "status": "generated"
    }
  }
}
curl -X POST 'https://docsbook.io/api/mcp/server' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json, text/event-stream' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"get_doc_outline","arguments":{"status":"generated"}}}'

Try it over REST#

The same tool is callable as a plain HTTP request, no MCP client required. It runs on the same server, at the same price.

GET/api/v1/get_doc_outline
Authorization
Authorizationstringrequired

Your API key, sent as Authorization: Bearer dbk_YOUR_API_KEY.Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.

Query
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.

path_prefixstring

Optional: restrict to pages under this path prefix.

statusstring

Optional: only pages at this lifecycle status. counts still covers them all. One of: generated, draft, review, approved, locked, deprecated, archived.

Request
curl 'https://docsbook.io/api/v1/get_doc_outline?status=generated' \
  -H 'Authorization: Bearer dbk_YOUR_API_KEY'

Updated

此页面对您有帮助吗？