List content widgets
MCP
list_content_widgetsREADno token needed$0.00003 / call
Features
List the widgets that can be embedded directly in documentation markdown (as opposed to find_widget, which covers interactive widgets rendered in the AI chat). Returns, for each widget, what it renders, when to use it, the exact markdown contract it expects, and a copy-pasteable example — and, above them, writing_style: how the PROSE between the widgets reads (one- or two-line paragraphs, identifiers in inline code, concepts linked where they are named, bold only where the eye lands) with a page that shows it. Widgets the workspace owner switched off in the admin panel are NOT listed — their markers render as plain markdown, so writing one would produce a page that silently looks unchanged.
Input2
Your API key, for the REST call. Sent from your browser straight to the API — never to Docsbook, never stored.
Return only this widget (e.g. 'cards'). Omit to list every content widget.
Workspace whose widget settings apply. Omit when the token is scoped to a single repo — that workspace is used. Only affects which widgets are switched off; the markdown contract is the same everywhere. 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.
Output6
{ name, summary, use_when, markdown_contract, example }.
Use cases
- Call this before writing or editing a docs page that would benefit from a card grid, an accordion, or any other rich content block — the catalog is the live source of truth, so never guess a widget name or syntax.
Example input
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_content_widgets",
"arguments": {}
}
}Example output
{
"syntax": "<syntax>",
"rules": [],
"where_to_use": "<where_to_use>",
"widgets": [],
"disabled_widgets": [],
"disabled_note": "<disabled_note>"
}