Update ui settings

MCPupdate_ui_settingsWRITE$0.00001 / call

Show or hide one interface element of the docs site — the header search button, sidebar search, collapsible top-level sidebar folders (sidebar_collapse_top_folders: «сверни папки первого уровня»), 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_hide_chrome, home_landing_typography), which strip the sidebar, the outline and the article chrome (breadcrumbs, 'Updated', rating bar, prev/next) off the site's FRONT PAGE ONLY and give its sections landing-page scale so it can read as a landing page — use them for 'make the home page a landing page', «сделай главную посадочной», «убери сайдбары на главной». There is no full-width/edge-to-edge switch: the front page always sits in the same reading column as every other 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.

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.

sidebar_collapse_top_foldersbooleanoptional

First-level sidebar folders become collapsible rows (chevron + name, fold on click, open by themselves around the current page) like second-level folders, instead of always-open uppercase section headings. Their pages stay flush left — no indent and no guide line, which remain the look of the second level. Off by default.

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_connect_mcpbooleanoptional

Show "Connect MCP" in the Copy page dropdown — copies a prompt that installs this project's MCP server into any agent

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. It also makes the front page a landing rather than the first doc: it leaves the sidebar tree, and the subheader's "Overview" tab opens the next page instead and is not highlighted on the front page (give the front page its own tab with update_navigation subheader_folders kind:"page" if the owner wants one).

home_hide_outlinebooleanoptional

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

home_hide_chromebooleanoptional

HOME PAGE ONLY: remove the article chrome from the front page — the breadcrumb/copy-page bar, the "Updated" line, the "Was this page helpful?" bar and the previous/next links — so it reads as a landing page, not as page one of a manual.

home_landing_typographybooleanoptional

HOME PAGE ONLY: landing-page scale for the front page's sections — each h2 becomes a large section title with air above it and the paragraph under it reads as that section's lead. Pair it with hero/stats/cards widgets in the README.

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#

MCPcurl

{
  "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 YOUR_MCP_OAUTH_TOKEN' \
  -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.

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

workspace_idstringrequired

show_search_buttonboolean

The search button in the site header.

show_search_in_sidebarboolean

The search box at the top of the left sidebar.

sidebar_collapse_top_foldersboolean

show_copy_page_buttonboolean

—

show_copy_skills_urlboolean

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

show_view_as_markdownboolean

Show "View as Markdown" in the Copy page dropdown

show_open_in_chatgptboolean

Show "Open in ChatGPT" in the Copy page dropdown

show_open_in_claudeboolean

Show "Open in Claude" in the Copy page dropdown

show_open_in_cursorboolean

Show "Open in Cursor" in the Copy page dropdown

show_open_in_windsurfboolean

Show "Open in Windsurf" in the Copy page dropdown

show_connect_vscodeboolean

Show "Connect to VSCode" in the Copy page dropdown

show_connect_mcpboolean

Show "Connect MCP" in the Copy page dropdown — copies a prompt that installs this project's MCP server into any agent

show_prev_next_buttonsboolean

—

show_breadcrumbsboolean

—

home_hide_sidebarboolean

home_hide_outlineboolean

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

home_hide_chromeboolean

home_landing_typographyboolean

show_scroll_to_topboolean

—

show_page_feedbackboolean

—

show_content_feedbackboolean

—

show_edit_on_githubboolean

—

show_ask_ai_buttonboolean

Show AI chat button (AI must be enabled separately)

show_ask_ai_headerboolean

—

show_ask_ai_outlineboolean

—

show_ask_ai_on_selectionboolean

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

show_ask_docs_buttonboolean

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

show_copy_markdownboolean

—

language_in_headerboolean

—

theme_in_headerboolean

—

language_sidebar_toggleboolean

—

github_edit_basestring

Base URL for Edit on GitHub links

footer_enabledboolean

footer_layoutstring

footer_textstring

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_logoboolean

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

footer_show_socialsboolean

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_pickerboolean

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

footer_cta_labelstring

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_urlstring

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.

Request

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

Updated Sep 24, 2026