Docsbook
Overview

Update ui settings

MCPupdate_ui_settingsWRITE$0.02 / call

Show or hide one interface element of the docs site — the header search button, sidebar search, the copy-page menu and its entries, previous/next links, breadcrumbs, scroll-to-top, page feedback, the 'was this helpful' bar, edit-on-GitHub, the Ask AI buttons (header, outline, on selection), copy-as-markdown, and where the language and theme switchers sit. Also the HOME-PAGE LANDING switches (home_hide_sidebar, home_hide_outline, home_wide_content), which strip the sidebar, the outline and the column width off the site's FRONT PAGE ONLY so it can read as a landing page — use them for 'make the home page a landing page', 'full-width main page', «сделай главную посадочной», «убери сайдбары на главной». And the SITE FOOTER (whether it exists, its layout, its copyright text, its call-to-action button, and whether it shows the social icons and a theme picker) — 'add a footer', 'put a copyright line at the bottom', «добавь футер». Pass only the toggles the user mentioned; the rest are untouched. Use it for 'hide the search button', 'remove breadcrumbs', «убери кнопку поиска». NOT header links or folder tabs — and NOT the footer's LINK COLUMNS, which are update_navigation's footer_columns. NOT colours or fonts (update_branding). All toggles available on FREE plan. BEFORE CHANGING THIS, call docsbook_expert with what you are trying to achieve: it names the reading that should decide the value, so the setting is a conclusion rather than a guess. One call, changes nothing.

Arguments
workspace_idstringrequired

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.

show_search_buttonbooleanoptional

The search button in the site header.

show_search_in_sidebarbooleanoptional

The search box at the top of the left sidebar.

show_copy_page_buttonbooleanoptional

—

show_copy_skills_urlbooleanoptional

Show "Copy Skills.md URL" in the Copy page dropdown

show_view_as_markdownbooleanoptional

Show "View as Markdown" in the Copy page dropdown

show_open_in_chatgptbooleanoptional

Show "Open in ChatGPT" in the Copy page dropdown

show_open_in_claudebooleanoptional

Show "Open in Claude" in the Copy page dropdown

show_open_in_cursorbooleanoptional

Show "Open in Cursor" in the Copy page dropdown

show_open_in_windsurfbooleanoptional

Show "Open in Windsurf" in the Copy page dropdown

show_connect_vscodebooleanoptional

Show "Connect to VSCode" in the Copy page dropdown

show_prev_next_buttonsbooleanoptional

—

show_breadcrumbsbooleanoptional

—

home_hide_sidebarbooleanoptional

HOME PAGE ONLY: hide the left navigation rail on the site's front page (its top-level README/index), on desktop — the mobile drawer stays. Every other page keeps its sidebar.

home_hide_outlinebooleanoptional

HOME PAGE ONLY: hide the right-hand "On this page" outline on the site's front page.

home_wide_contentbooleanoptional

HOME PAGE ONLY: let the front page's content run the full window width instead of the fixed reading column.

show_scroll_to_topbooleanoptional

—

show_page_feedbackbooleanoptional

—

show_content_feedbackbooleanoptional

—

show_edit_on_githubbooleanoptional

—

show_ask_ai_buttonbooleanoptional

Show AI chat button (AI must be enabled separately)

show_ask_ai_headerbooleanoptional

—

show_ask_ai_outlinebooleanoptional

—

show_ask_ai_on_selectionbooleanoptional

Show floating Ask AI button when user selects text in the docs (AI must be enabled separately)

show_ask_docs_buttonbooleanoptional

Floating "Ask Docs" pill pinned to the page's bottom-right corner

show_copy_markdownbooleanoptional

—

language_in_headerbooleanoptional

—

theme_in_headerbooleanoptional

—

language_sidebar_togglebooleanoptional

—

github_edit_basestringoptional

Base URL for Edit on GitHub links

footer_enabledbooleanoptional

Show the site footer — the band under every docs page. Off by default. It renders only once it has content: a link column (update_navigation footer_columns), footer_text, a CTA, the logo or the social icons.

footer_layoutstringoptional

How the footer's blocks sit: 'columns' (brand block left, link columns right), 'centered' (everything stacked down the middle) or 'minimal' (one row — text left, links and socials right). Placement only; it never turns a block off. One of: columns, centered, minimal.

footer_textstringoptional

Free text under the footer's logo — copyright line, legal entity, postal address. Plain text: line breaks are kept, markup is not. Max 600 chars. Pass an empty string to clear it.

footer_show_logobooleanoptional

Show the site logo in the footer's brand block.

footer_show_socialsbooleanoptional

Show the social icons in the footer. WHICH accounts is not a footer setting — it is the workspace's social_links (update_navigation); this only decides whether the footer draws them.

footer_show_theme_pickerbooleanoptional

Show a three-way light / dark / system picker in the footer.

footer_cta_labelstringoptional

Label for an optional call-to-action button in the footer's brand block (e.g. 'Get started'). Without a label no button is drawn. Pass an empty string to remove it.

footer_cta_urlstringoptional

Where the footer's call-to-action button goes. Leave unset to reuse the workspace's own cta_url (see get_workspace) rather than repeating it.

Call it#

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_ui_settings",
    "arguments": {
      "workspace_id": "<workspace_id>",
      "footer_layout": "columns"
    }
  }
}
curl -X POST 'https://docsbook.io/api/mcp/server' \
  -H 'Authorization: Bearer dbk_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json, text/event-stream' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"update_ui_settings","arguments":{"workspace_id":"<workspace_id>","footer_layout":"columns"}}}'

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.

Your workspace is resolved from the API key, so workspace_id is decided server-side here and anything you send for it is ignored.

POST/api/v1/tools/update_ui_settings
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.

Body
argsobjectrequired

The arguments above, as one JSON object.

Request
curl -X POST 'https://docsbook.io/api/v1/tools/update_ui_settings' \
  -H 'Authorization: Bearer dbk_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"args":{"workspace_id":"<workspace_id>","footer_layout":"columns"}}'

Updated

Was this page helpful?