Read project doc

MCPread_project_doc

READ$0.00003 / call

Features

Read ONE documentation page in full — its complete markdown, title and repo path. THE step between finding a page and editing it: read it here, change the text, then write_docs the whole file back. Takes the repo path search_docs and get_doc_outline use ('guides/setup.md') or the URL slug the analytics tools return ('guides/setup'); a near-miss with a single candidate is resolved for you (resolvedFrom says so), several candidates are listed to choose from. Changes nothing; available to any token. The result carries lifecycle: the page's status, its version, and agent_may_build_from. Read it, quote it as a draft, but do not generate work from it, do not cite it as a decision, and say which status it is in. set_doc_status is how it gets approved.

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 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 ('reference/README.md') or its URL slug ('reference/introduction').

Use cases

Use it for 'fix the command on the installation page', 'show me the quickstart', «покажи страницу», «поправь строку на странице».

Limitations

🔴 When that is false the page is NOT a source of truth — a machine drafted it, or a human has not signed it off, or it was superseded.

Example input

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

更新于 Sep 24, 2026