get_docs
One reader for platform docs and design catalogs. Docs: mode=nav (default) returns titles and parent/children/sibling links only; mode=content fetches the section body; mode=manifest returns the whole tree (path, title, kind, concern, covers) in one call; mode=bundle takes paths[] plus include[] (body, ancestors, children, shared-concepts, blocks, lifecycles, related-tools, related-endpoints) and returns every dependency in one response, listing anything over budgetBytes in omitted. Design surface: pass surface (page, chrome-header, chrome-footer, page-component, email-chrome-header, email-chrome-footer) for the block catalog; mode=index (default) returns categories and block types, mode=block with type returns one block (includeShell adds shell.* fields), mode=full returns the whole surface snapshot and is expensive. Pass path=surfaces for the surface list with lifecycles and the content contract, or path=lifecycles for the lifecycle guide (events, constraints, actions, bindings). mcp/tools and api/endpoints are human pages too; mode=content lists them. Insert only catalog block types from these responses.
get_docs · Group: docs
One reader for platform docs and design catalogs. Docs: mode=nav (default) returns titles and parent/children/sibling links only; mode=content fetches the section body; mode=manifest returns the whole tree (path, title, kind, concern, covers) in one call; mode=bundle takes paths[] plus include[] (body, ancestors, children, shared-concepts, blocks, lifecycles, related-tools, related-endpoints) and returns every dependency in one response, listing anything over budgetBytes in omitted. Design surface: pass surface (page, chrome-header, chrome-footer, page-component, email-chrome-header, email-chrome-footer) for the block catalog; mode=index (default) returns categories and block types, mode=block with type returns one block (includeShell adds shell.* fields), mode=full returns the whole surface snapshot and is expensive. Pass path=surfaces for the surface list with lifecycles and the content contract, or path=lifecycles for the lifecycle guide (events, constraints, actions, bindings). mcp/tools and api/endpoints are human pages too; mode=content lists them. Insert only catalog block types from these responses.
Inputs
| Field | Required | Notes |
|---|---|---|
path | optional | |
paths | optional | Atomic read: docs paths to fetch in one response. Use with mode=bundle. |
include | optional | Bundle dependencies: body, ancestors, children, shared-concepts, blocks, lifecycles, related-tools, related-endpoints. |
depth | optional | Bundle: levels of children to include (0-4, default 1). |
budgetBytes | optional | Bundle: response byte budget; overflow is listed in omitted. |
surface | optional | |
mode | optional | |
type | optional | |
includeShell | optional |
Maps to
GET /api/v1/{locale}/docs→ APIGET /api/v1/{locale}/design-docs→ APIGET /api/v1/{locale}/design-docs/{surface}→ APIGET /api/v1/{locale}/design-docs/lifecycles→ API