Skip to main content

Ask AI assistant widget for Antora

Add an AI assistant or AI search widget to your Antora documentation using Biel.ai's web components. You can also connect AI agents through MCP, with or without installing the widget.

Prerequisites​

Add the assistant widget​

Assistant widget for docs

  1. Modify the UI bundle:

    • If you're using a custom UI bundle for your Antora project, navigate to the UI bundle's directory.

    • Otherwise, clone Antora's default UI bundle with the following command:

      git clone https://gitlab.com/antora/antora-ui-default.git
  2. Locate the head.hbs file, which is usually under src/partials, and insert the following code:

    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/biel-search/dist/biel-search/biel-search.css">
    <script type="module" src="https://cdn.jsdelivr.net/npm/biel-search/dist/biel-search/biel-search.esm.js"></script>
  3. Locate the footer.hbs or the specific file where you'd like the assistant to appear. Just before the closing tags in that file, add the following snippet:

    <biel-button project="<YOUR_PROJECT_ID>"
    header-title="Biel.ai assistant"
    button-position="bottom-right"
    modal-position="bottom-right"
    button-style="dark">
    Ask AI
    </biel-button>

    Replace <YOUR_PROJECT_ID> with your project's ID from the Biel.ai dashboard.

  4. Build and verify your project:

    • Re-bundle your custom UI and run the Antora build command.
    • If using the default UI, you'd have to integrate it as a local UI and then run Antora with the --ui-bundle-url flag to point to your modified local UI bundle.
    • Once built, ensure the assistant is functioning correctly on your site.

Add the search widget​

  1. In your custom UI bundle, append these assets to src/partials/head.hbs:

    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/biel-search/dist/biel-search/biel-search.css">
    <script type="module" src="https://cdn.jsdelivr.net/npm/biel-search/dist/biel-search/biel-search.esm.js"></script>
  2. Add this element inside the navbar in src/partials/header-content.hbs:

    <biel-search-button project="<YOUR_PROJECT_ID>" button-style="rounded">
    Search
    </biel-search-button>

    Replace <YOUR_PROJECT_ID> with your project ID.

  3. Rebuild the UI bundle and rebuild Antora using that bundle. Open Search, enter a term from your documentation, and open a result.

Connect AI agents with MCP​

Let AI tools search and read your indexed documentation. MCP is available on every plan and during your trial.

  1. In the Biel.ai dashboard, open your project’s Settings > MCP.
  2. Select Enable MCP server and click Save.
  3. In the widget, open Connect via MCP using the <> button. Select your AI client or choose MCP URL to copy the endpoint into its settings.

Without the widget: after enabling MCP, copy MCP endpoint from Settings > MCP and add it to your AI client. No widget installation or website changes are required.

The widget also exposes WebMCP tools to compatible browser agents visiting your site. Use the latest widget release and keep Enable WebMCP selected in Settings > MCP.

Next steps​