MCP Tools Reference

This page lists every tool exposed by the Docsbook MCP server at https://docsbook.io/api/mcp/server. Each tool requires Bearer authentication via OAuth 2.0 + PKCE. The minimum plan column indicates the workspace tier required to call the tool; calls below that tier return a plan_required error.

To connect from Claude Code:

mcp add --transport http https://docsbook.io/api/mcp/server

Workspace and branding#

Tool	Min plan	Description
`get_info`	Free	Server capabilities, version, available tool list
`list_workspaces`	Free	All workspaces for the authenticated user with capabilities
`get_workspace`	Free	Fetch one workspace by ID or `owner/repo`
`create_workspace`	Free	Create a workspace from a GitHub repository
`update_branding`	Free	Colors, fonts, logo, icon, default theme
`update_ui_settings`	Free	Toggle header, search, feedback, copy button, breadcrumbs
`update_navigation`	Free	Header links, social links, folder tabs
`update_ai_settings`	PRO	Enable AI chat, set provider and API key, model selection
`update_seo`	PRO	SEO meta tags, sitemap, OpenGraph
`update_domain`	PRO	Attach or remove a custom domain
`update_languages`	PRO	Enable target languages for AI translation

Content and documentation#

Tool	Min plan	Description
`get_doc_graph`	PRO+	Full documentation graph (`format`: `"toon"` or `"json"`)
`read_doc_sections`	PRO+	Read specific sections by canonical refs
`reindex_doc_graph`	PRO+	Rebuild the graph (limit 100 / month per workspace)

AI chat#

Tool	Min plan	Description
`get_chat_system_prompt`	PRO+	Read the workspace's chat system prompt
`set_chat_system_prompt`	PRO+	Replace the chat system prompt
`set_chat_hooks`	PRO+	Configure pre/post LLM hooks
`test_chat_hook`	PRO+	Run a hook against a synthetic payload

Translations#

Tool	Min plan	Description
`set_translation_mode`	PRO+	`auto` (built-in AI) or `external` (webhook flow)
`list_pending_translations`	PRO	Translations awaiting approval
`get_translation`	PRO	Fetch one translation by language and path
`upload_translation`	PRO+	Upload an externally-produced translation
`approve_translation`	PRO+	Publish a pending translation
`delete_translation`	PRO+	Remove a translation

Analytics and observability#

Tool	Min plan	Description
`get_analytics`	Free	Views, visitors, top pages, referrers (period by plan)
`get_ai_usage`	Free	AI chat and translation usage, limits, remaining quota
`get_ai_questions`	PRO	All questions asked to the AI chat
`get_ai_unanswered`	PRO	Questions the AI could not answer
`get_negative_feedback`	PRO	Pages with thumbs-down feedback
`get_failed_searches`	PRO	Search queries that returned zero results
`get_popular_searches`	PRO	Top search queries by frequency
`get_page_journeys`	PRO+	User navigation paths between pages
`query_events`	PRO+	Arbitrary Axiom query over platform events

Webhooks#

Tool	Description
`register_webhook_<event>`	Register a webhook for one of ~15 events (HMAC secret + URL)
`list_webhooks`	List registered webhooks for the workspace
`unregister_webhook`	Remove a webhook subscription
`list_webhook_deliveries`	Delivery history with status, retry count, payload
`replay_webhook_delivery`	Re-deliver a specific past delivery
`test_webhook`	Send a synthetic payload to a URL

Event types include content.indexed, translation.completed, chat.no_answer, chat.negative_feedback, plan.upgraded, usage.limit_approaching, and others — see Webhooks for the full list and payload schemas.

Skills discovery#

Tool	Description
`find_skill`	Search the `docs-skills` catalog by `query` with optional `category` and `requires_plan` filters. Returns `raw_url` for the agent to fetch the SKILL.md directly.

由...提供支持 Docsbook

Mcp 工具 — 文档库