> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-86180b7b.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Configurar o ClickHouse MCP server com o Open WebUI e o ClickHouse Cloud

> Este guia explica como configurar o Open WebUI com um ClickHouse MCP server usando Docker.

export const Image = ({img, alt, size}) => {
  return <Frame>
      <img src={img} alt={alt} />
    </Frame>;
};

<div id="using-clickhouse-mcp-server-with-open-webui">
  # Usando o ClickHouse MCP server com o Open WebUI
</div>

> Este guia explica como configurar o [Open WebUI](https://github.com/open-webui/open-webui) com um ClickHouse MCP server
> e conectá-lo aos conjuntos de dados de exemplo do ClickHouse.

<Steps>
  <Step>
    ## Instale o uv

    Você precisará instalar o [uv](https://docs.astral.sh/uv/) para seguir as instruções deste guia.
    Se não quiser usar o uv, será necessário atualizar a configuração do MCP server para usar um gerenciador de pacotes alternativo.
  </Step>

  <Step>
    ## Inicie o Open WebUI

    Para iniciar o Open WebUI, execute o seguinte comando:

    ```bash theme={null}
    uv run --with open-webui open-webui serve
    ```

    Acesse [http://localhost:8080/](http://localhost:8080/) para ver a UI.
  </Step>

  <Step>
    ## Configure o ClickHouse MCP server

    Para configurar o ClickHouse MCP server, precisaremos converter o MCP server em endpoints da Open API.
    Primeiro, vamos definir variáveis de ambiente que permitirão a conexão com o ClickHouse SQL Playground:

    ```bash theme={null}
    export CLICKHOUSE_HOST="sql-clickhouse.clickhouse.com"
    export CLICKHOUSE_USER="demo"
    export CLICKHOUSE_PASSWORD=""
    ```

    Em seguida, podemos executar `mcpo` para criar os endpoints da Open API:

    ```bash theme={null}
    uvx mcpo --port 8000 -- uv run --with mcp-clickhouse --python 3.10 mcp-clickhouse
    ```

    Você pode ver uma lista dos endpoints criados acessando [http://localhost:8000/docs](http://localhost:8000/docs)

    <Image img="https://mintcdn.com/private-7c7dfe99-mintlify-86180b7b/DF-nZAmnH8TA7I_p/images/use-cases/AI_ML/MCP/0_endpoints.png?fit=max&auto=format&n=DF-nZAmnH8TA7I_p&q=85&s=cbd5d0dc4063d06fe6292264fe1d38ac" alt="endpoints da Open API" size="md" width="1455" height="759" data-path="images/use-cases/AI_ML/MCP/0_endpoints.png" />

    Para usar esses endpoints com o Open WebUI, precisamos ir até as configurações:

    <Image img="https://mintcdn.com/private-7c7dfe99-mintlify-86180b7b/DF-nZAmnH8TA7I_p/images/use-cases/AI_ML/MCP/1_settings.png?fit=max&auto=format&n=DF-nZAmnH8TA7I_p&q=85&s=f55ff21d94151d654e13effe6bc514f1" alt="configurações do Open WebUI" size="md" width="518" height="575" data-path="images/use-cases/AI_ML/MCP/1_settings.png" />

    Clique em `Tools`:

    <Image img="https://mintcdn.com/private-7c7dfe99-mintlify-86180b7b/DF-nZAmnH8TA7I_p/images/use-cases/AI_ML/MCP/2_tools_page.png?fit=max&auto=format&n=DF-nZAmnH8TA7I_p&q=85&s=b3259f601b22ad36ed2832cb00d64abc" alt="ferramentas do Open WebUI" size="md" width="1829" height="1190" data-path="images/use-cases/AI_ML/MCP/2_tools_page.png" />

    Adicione [http://localhost:8000](http://localhost:8000) como URL da ferramenta:

    <Image img="https://mintcdn.com/private-7c7dfe99-mintlify-86180b7b/DF-nZAmnH8TA7I_p/images/use-cases/AI_ML/MCP/3_add_tool.png?fit=max&auto=format&n=DF-nZAmnH8TA7I_p&q=85&s=925738a863b5d09aaa1c9f0f863ed2da" alt="ferramenta do Open WebUI" size="md" width="1838" height="1201" data-path="images/use-cases/AI_ML/MCP/3_add_tool.png" />

    Depois disso, você deverá ver um `1` ao lado do ícone da ferramenta na barra de chat:

    <Image img="https://mintcdn.com/private-7c7dfe99-mintlify-86180b7b/DF-nZAmnH8TA7I_p/images/use-cases/AI_ML/MCP/4_tools_available.png?fit=max&auto=format&n=DF-nZAmnH8TA7I_p&q=85&s=18b35822fcc68c6fcb63cea112d5a899" alt="ferramentas disponíveis no Open WebUI" size="md" width="1495" height="229" data-path="images/use-cases/AI_ML/MCP/4_tools_available.png" />

    Ao clicar no ícone da ferramenta, você poderá listar as ferramentas disponíveis:

    <Image img="https://mintcdn.com/private-7c7dfe99-mintlify-86180b7b/DF-nZAmnH8TA7I_p/images/use-cases/AI_ML/MCP/5_list_of_tools.png?fit=max&auto=format&n=DF-nZAmnH8TA7I_p&q=85&s=45db20cb9ed3fad53c42fc71f98f671b" alt="lista de ferramentas do Open WebUI" size="md" width="1373" height="711" data-path="images/use-cases/AI_ML/MCP/5_list_of_tools.png" />
  </Step>

  <Step>
    ## Configure o OpenAI

    Por padrão, o Open WebUI funciona com modelos do Ollama, mas também podemos adicionar endpoints compatíveis com OpenAI.
    Eles são configurados pelo menu de configurações, mas desta vez precisamos clicar na aba `Connections`:

    <Image img="https://mintcdn.com/private-7c7dfe99-mintlify-86180b7b/DF-nZAmnH8TA7I_p/images/use-cases/AI_ML/MCP/6_connections.png?fit=max&auto=format&n=DF-nZAmnH8TA7I_p&q=85&s=94653fd63724201e55f4d261b9ad1539" alt="conexões do Open WebUI" size="md" width="1824" height="1184" data-path="images/use-cases/AI_ML/MCP/6_connections.png" />

    Vamos adicionar o endpoint e nossa chave da OpenAI:

    <Image img="https://mintcdn.com/private-7c7dfe99-mintlify-86180b7b/DF-nZAmnH8TA7I_p/images/use-cases/AI_ML/MCP/7_add_connection.png?fit=max&auto=format&n=DF-nZAmnH8TA7I_p&q=85&s=1bca08c6b5367f0965cfe08cc05bd628" alt="Open WebUI - Adicionar OpenAI como conexão" size="md" width="1821" height="1192" data-path="images/use-cases/AI_ML/MCP/7_add_connection.png" />

    Os modelos da OpenAI ficarão disponíveis no menu superior:

    <Image img="https://mintcdn.com/private-7c7dfe99-mintlify-86180b7b/086sd15g6bbbY0wP/images/use-cases/AI_ML/MCP/8_openai_models_more.png?fit=max&auto=format&n=086sd15g6bbbY0wP&q=85&s=09851b915b3bf5bdfd45c7407806e222" alt="Open WebUI - Modelos" size="md" width="1574" height="1248" data-path="images/use-cases/AI_ML/MCP/8_openai_models_more.png" />
  </Step>

  <Step>
    ## Converse com o ClickHouse MCP server usando o Open WebUI

    Podemos então iniciar uma conversa, e o Open WebUI chamará o MCP server quando necessário:

    <Image img="https://mintcdn.com/private-7c7dfe99-mintlify-86180b7b/086sd15g6bbbY0wP/images/use-cases/AI_ML/MCP/9_conversation.png?fit=max&auto=format&n=086sd15g6bbbY0wP&q=85&s=81d538fada85555e335f90d096bae3e8" alt="Open WebUI - Conversar com o ClickHouse MCP server" size="md" width="2449" height="1839" data-path="images/use-cases/AI_ML/MCP/9_conversation.png" />
  </Step>
</Steps>
