Bauplan

Interaja com tabelas de dados do Bauplan e execute consultas.

Documentação

mcp-bauplan

Um servidor MCP (Model Context Protocol) minimalista para interagir com tabelas de dados e executar consultas Bauplan.

O Bauplan gerencia um armazenamento de dados de tabelas Iceberg no S3.

Recursos

  • Obter tabelas de dados Bauplan e seus esquemas no namespace configurado
  • Consultar tabelas de dados Bauplan usando SQL (somente SELECT)

Suporta tanto transportes SSE quanto STDIO.

Ferramentas

O servidor implementa as seguintes ferramentas para interagir com tabelas de dados Bauplan:

  • list_tables:
    • Lista todas as tabelas no namespace configurado
  • get_schema:
    • Obtém o esquema de uma tabela de dados
  • run_query:
    • Executa uma consulta SELECT na tabela especificada

Configuração

  1. Crie _ou edite o arquivo de configuração do Claude Desktop localizado em:

    • No macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
    • No Windows: %APPDATA%/Claude/claude_desktop_config.json
  2. Adicione o seguinte:

{
  "mcpServers": {
    "mcp-bauplan": {
      "command": "/path/to/uvx",
      "args": ["mcp-bauplan"],
      "env": {
        "BAUPLAN_API_KEY": "your-api-key",
        "BAUPLAN_BRANCH": "your-branch",
        "BAUPLAN_NAMESPACE": "your-namespace",
        // Optional
        "BAUPLAN_TIMEOUT": "query-timeout-secs" // default 30 seconds
      }
    }
  }
}
  1. Substitua /path/to/uvx pelo caminho absoluto para o executável uvx. Encontre o caminho com o comando which uvx em um terminal. Isso garante que a versão correta de uvx seja usada ao iniciar o servidor.

  2. Reinicie o Claude Desktop para aplicar as alterações.

Executar o servidor SSE autônomo

Crie um arquivo .env a partir do .env.example e execute o seguinte comando:

$ uvx --env-file /path/to/.env mcp-bauplan --transport sse --port 9090

Observe que o uso de nvx e não uvx buscará mcp-bauplan do registro padrão https://pypi.org.

Desenvolvimento Futuro

Desenvolvimento - trabalho em andamento

  1. Documentação do Bauplan (SDK e Plataforma) como Recurso
  2. Automação da Execução Bauplan - mais comandos e execução de pipeline
  3. Geração de Consultas
  4. Geração de Código Usando Modelos
  5. Governança e Conformidade de Dados
  6. Testes e Validação
  7. Ecossistema de Integração

Configuração

  1. Pré-requisitos:

  2. Clone o Repositório:

git clone https://github.com/marcoeg/mcp-bauplan
cd mcp-nvd
  1. Defina as Variáveis de Ambiente:

    • Crie um arquivo .env na raiz do projeto:
      BAUPLAN_API_KEY=your-api-key
      BAUPLAN_BRANCH=your-branch
      BAUPLAN_NAMESPACE=your-namespace
      
  2. Instale as Dependências:

uv sync
uv pip install -e .

Executar com o MCP Inspector

cd /path/to/the/repo
source .env

CLIENT_PORT=8077 SERVER_PORT=8078 npx @modelcontextprotocol/inspector \
     uv run mcp-bauplan

Observação: omita CLIENT_PORT=8077 SERVER_PORT=8078 se as portas padrão não estiverem em conflito.

Em seguida, abra o navegador na URL indicada pelo MCP Inspector, normalmente http://localhost:8077?proxyPort=8078

Alterne livremente entre os tipos de transporte stdio e sse no inspector. Para usar sse, você precisa executar o servidor conforme explicado abaixo.

Testando com o transporte SSE

Executar o Servidor:

cd /path/to/the/repo
source .env

uv run mcp-bauplan --transport sse --port 9090
  • Executa com transporte SSE na porta 9090 por padrão.

Em seguida, abra o navegador na URL indicada pelo MCP Inspector. Selecione o Tipo de Transporte SSE.