Search & GitBook Assistant

Help your users find the information they need faster with powerful knowledge discovery tools for your published content

GitBook Assistant is will be available soon!

GitBook Assistant is current available in closed beta — it will be available for everyone soon. In the meantime, published documentation will still feature keywords search and GitBook AI search.

Choose your site’s search experience

GitBook sites offer different search experiences depending on what you want for your users:

  • Keyword search – A standard search experience based on keywords. Automatically enabled on all sites.

  • GitBook AI search – Users get short answers to questions directly from the search box.

  • GitBook Assistant – Users get an advanced, interactive chat experience with GitBook’s AI agent.

To choose your site’s search experience, open your site’s dashboard, navigate to the Settings page and choose AI & MCP from the menu on the left. Here you can choose your preferred experience.

Searching published documentation

Users can open the Ask or search… bar by pressing + K on Mac or Ctrl + K on PC.

Your users can search for keywords within your docs site and jump quickly to specific pages or page sections across your entire site.

If your docs site has multiple sections, the search results will contain pages from all of these sections so that you users can jump straight to the page they need.

GitBook Assistant

This feature is available on the Ultimate site plan.

GitBook Assistant gives your users fast, accurate answers about your documentation using natural language. It’s embedded right into your docs site, so users can ask questions, request more information about the page they’re on, or get other contextual help.

The Assistant uses agentic retrieval to understand the context of the query based on the user’s current page, previously-read pages, and previous conversations they’ve had.

GitBook Assistant is trained on your documentation, but you can also add external sources to expand it’s context and knowledge and give better answers.

Try GitBook Assistant for yourself!

You can try GitBook Assistant for yourself right here in our docs. To get started, click the Assistant button next to the Ask or search… bar. Here are some ideas to test it out:

  • Ask a simple question about something on this page

  • Ask a technical question about our API

  • Ask follow-up questions or ask for more details about a specific part of Assistant’s answer

  • Ask a question about conversations in our GitHub Community, which we’ve connected to Assistant using an MCP server — something like “What discussions have there been about customization options?”

Using GitBook Assistant

Users can access GitBook Assistant in three ways:

  • Press + J on Mac or Ctrl + J on PC

  • Click the GitBook Assistant button next to the Ask or search… bar

  • Type a question into the Ask or search… bar and choose the ‘Ask…’ option at the top of the menu.

Extend GitBook Assistant with MCP servers

You can also choose to add external data sources to GitBook Assistant to give it more context and data to pull answers from. You can do this by connecting Assistant to MCP servers for external platforms, such as:

  • Your community (Slack, Discord, GitHub Communities etc)

  • Support tools (Intercom etc)

  • Your future product roadmap (GitHub, Linear etc)

  • Docs for external integrations with products

To add an MCP server to GitBook Assistant, follow these steps:

1

Open your site’s settings

Navigate to your site dashboard and choose the Settings option from the site header. Then choose the AI & MCP section from the left-hand menu

2

Add a new server

At the bottom of the page is a table showing all the connected MCP servers. To add a new server, click Add MCP server

3

Choose your MCP server

To add your server you’ll need to give it a name, add the URL for the server, and configure the HTTP headers that will be sent along with the request to the server when a user submits a query.

This feature is available on Premium and Ultimate site plans.

GitBook AI search offers basic AI-powered answers in the Search and find… bar of your site. It’s trained on the content of your docs site, but cannot pull in information from external sources.

If you have enabled GitBook AI search from your site’s settings page, your users can access it by asking a question directly in the Ask or search… bar at the top of the page.

They can open this by clicking it directly, or by pressing + K on a Mac or Ctrl + K on a PC.

As well as a summarized answer, below your users will also see an expandable section that shows the sources that GitBook AI used to create its answer, plus related questions you can click as a follow-up.

FAQs

Integrating GitBook AI with your product

With our API, you can embed GitBook AI into your product or website! This opens up lots of possibilities, including in-app helpers and website chat bots that can respond to questions based on the content in your documentation.

Head to our developer documentation to find out more.

Last updated

Was this helpful?