Model Context Protocol v1.0 • Reference Guide

Brabrix MCP Server: Referência Completa

O servidor MCP é o motor que permite à sua IA agir como um engenheiro sênior que conhece cada detalhe do seu projeto na Brabrix.

1. Ferramentas de Leitura de Contexto

Estas ferramentas permitem que a IA entenda o cenário atual do projeto e do workspace.

brabrix_get_workspace_config

Descrição: Lê o arquivo .brabrix/config.json local.

Uso: Permite que a IA saiba automaticamente em qual projectId e taskId ela deve focar sem você precisar digitar.

brabrix_get_project_context

Parâmetros: projectId? (string)

Retorno: Nome do projeto, cliente, stack tecnológica e objetivo principal.

brabrix_get_related_context_for_task

Parâmetros: projectId?, taskId?

Descrição: A ferramenta mais poderosa para o desenvolvedor. Retorna um bundle contendo Projeto + Task + Spec + Docs relacionados.

2. Planejamento e Especificações

Documentação técnica viva acessível por comandos.

Tool Parâmetros O que a IA recebe
brabrix_get_task_spec taskId Markdown completo com regras técnicas, diagramas e detalhes de implementação da tarefa.
brabrix_get_prd projectId? Documento de Requisitos de Produto (Visão de Negócio).
brabrix_get_technical_spec projectId? Especificação técnica global (Arquitetura, Padrões, DB).
brabrix_get_backlog status?, type? Lista de itens filtrada por tipo (Task, Bug, Story) ou status.
brabrix_get_board projectId? Resumo do board Kanban (Itens em TODO, IN_PROGRESS, DONE).

3. Automação de Workflow (Novos Comandos)

Ferramentas exclusivas para acelerar o ciclo de desenvolvimento e garantir qualidade.

brabrix_suggest_git_metadata

Ação: Gera branchName e commitMessage.

Lógica: Normaliza o título da tarefa para o padrão git (ex: feat/TASK-123-api-auth) e cria uma mensagem seguindo Conventional Commits.

brabrix_get_alignment_prompt

Ação: Injeta um "Super-Prompt" de revisão.

Lógica: Cruza os Critérios de Aceite da Task com a Implementation Spec e pede para a IA fazer um self-check de compliance.

4. Ferramentas de Escrita (Opcional)

Importante: Estas ferramentas requerem BRABRIX_MCP_ENABLE_WRITE_TOOLS=true nas variáveis de ambiente.

brabrix_update_task_status

Inputs: taskId, status (Enum), comment?

Uso: "Mova a tarefa para DONE e adicione o comentário: 'Finalizado conforme spec'."

brabrix_add_task_comment

Inputs: taskId, comment

Uso: Registrar logs de progresso ou dúvidas diretamente na plataforma Brabrix.

5. MCP Resources (Acesso Nativo)

Diferente das ferramentas, os Resources são "URLs" que a IA pode ler como se fossem arquivos locais.

  • brabrix://project/prd — O Documento de Requisitos de Produto.
  • brabrix://project/tech-spec — A Especificação Técnica Global do Projeto.
Vantagem: Agentes avançados (como o Claude) podem "assinar" esses recursos e ser notificados se eles mudarem durante a sessão.

6. Guia de Prompts Avançados

Copie e cole estes prompts no seu agente de IA (Gemini, Claude, Cursor) para extrair o máximo do contexto via MCP:

🚀 Início e Planejamento

1. Onboarding de Tarefa (O Essencial):

"Verifique minha configuração de workspace e pegue o contexto completo da minha tarefa atual. Com base na spec técnica e no PRD, crie uma lista de arquivos que precisarei alterar e os testes que devo implementar."

2. Refinamento de Arquitetura:

"Use o MCP para ler a Especificação Técnica Global (brabrix://project/tech-spec) e os Critérios de Aceite da tarefa atual. A arquitetura atual que temos atende a estes requisitos? Sugira uma abordagem em etapas."

3. Estimativa e Quebra (Breakdown):

"Leia o PRD do projeto e a tarefa que estou focando no momento. Quais são as armadilhas ocultas ou edge cases não documentados que devo prever antes de começar a codar?"

💻 Durante o Desenvolvimento

4. Geração de Boilerplate Alinhado:

"Estou prestes a criar as entidades desta tarefa. Busque a especificação da tarefa via MCP e gere as interfaces/tipagens e o esqueleto das classes respeitando estritamente o que foi documentado."

5. Resolução de Dúvidas de Negócio:

"Encontrei uma ambiguidade na regra de negócio. Consulte o Documento de Requisitos de Produto (PRD) via recurso MCP e me confirme qual é a regra exata de negócio descrita ali."

6. Contexto de Múltiplos Arquivos:

"Busque o backlog inteiro via MCP e encontre outras tarefas similares à atual ou que toquem no mesmo domínio. Tem alguma dependência ou conflito que eu deva considerar?"

✅ Qualidade e Git

7. Quality Assurance (Self-Check):

"Antes de eu commitar, use o brabrix_get_alignment_prompt. Analise meu código atual e me diga se esqueci de algum critério de aceite ou regra de negócio descrita no PRD."

8. Testes Orientados a Comportamento:

"Com base nos critérios de aceite da minha tarefa atual, gere os casos de teste unitário (given/when/then) que garantam que eu atendi 100% da especificação exigida."

9. Geração de Git Metadata (Padronizado):

"Meu código está pronto e alinhado. Chame a ferramenta brabrix_suggest_git_metadata e me dê o comando bash exato para criar a branch e fazer o commit inicial."

🔄 Workflow e Sincronização

10. Atualização de Status:

"Já terminei a implementação. Use o mcp para mover minha tarefa atual para o status 'IN_REVIEW' no board da Brabrix e adicione um comentário resumindo os arquivos que criei."

11. Relatório de Progresso (Daily):

"Busque o board do projeto e liste todas as tarefas que estão 'IN_PROGRESS' e 'DONE'. Gere um pequeno relatório textual que eu possa colar na minha reunião de Daily."

🛠️ Refatoração e Manutenção

12. Análise de Dívida Técnica:

"Busque todas as tarefas no backlog com a tag 'IMPROVEMENT' ou 'BUG'. Quais áreas do sistema parecem precisar de mais atenção de refatoração no próximo sprint?"

13. Refatoração Guiada pela Spec:

"Estou refatorando este módulo. Leia a especificação técnica (brabrix://project/tech-spec) e me aponte se minha nova abordagem fere algum princípio arquitetural do projeto."

14. Geração de Documentação Local:

"Baseado na tarefa que acabei de concluir e no PRD, gere um arquivo README.md para este módulo explicando como as novas funções devem ser consumidas pelos outros times."

🐛 Debugging e Resolução de Problemas

15. Triagem de Bug de Produção:

"Estou resolvendo o bug reportado na tarefa atual. Compare a descrição do problema com a Especificação original da Feature. Isso é realmente um bug ou o sistema está agindo conforme planejado inicialmente?"

16. Mapeamento de Impacto (Risco):

"Preciso alterar a modelagem de dados descrita nesta tarefa. Leia o contexto da tarefa e me dê um relatório de quais outros módulos ou épicos do backlog podem quebrar devido a essa mudança."

🗣️ Colaboração e Comunicação

17. Preparação para Pull Request (PR):

"Use a tarefa atual para gerar um texto de descrição de Pull Request. Inclua o link/ID da tarefa, o que foi feito, o que foi testado e quais critérios de aceite foram atendidos."

18. Sugestão de Comentário para o Time:

"Estou bloqueado nesta tarefa porque a API externa falhou. Use o comando 'brabrix_add_task_comment' para registrar um comentário formal e claro na tarefa avisando o restante da equipe."

19. Geração de Change Log (Release Notes):

"Liste todas as tarefas que estão em 'DONE' no board atual e gere um Release Notes amigável para enviar aos clientes, focando no valor de negócio entregue."

🧠 Exploração Criativa

20. Brainstorming de Soluções:

"Tenho a tarefa atual assinada para mim, mas não sei por onde começar. Leia o contexto, atue como um Engenheiro Staff e proponha 3 caminhos técnicos diferentes para resolver o problema, com prós e contras."

21. Simulação de Cenário (What-If):

"E se precisarmos mudar o projeto inteiro de PostgreSQL para MongoDB? Leia a especificação técnica do projeto (MCP) e liste todos os pontos de atrito que enfrentaremos."
Superpoderes nos Editores

Cursor, Copilot & Mais

Como configurar o MCP da Brabrix nos editores de código mais populares.

1. Cursor (Codex / AI IDE)

O Cursor tem suporte nativo a MCP, o que o torna a melhor experiência para usar o Brabrix Dev.

  1. Abra o Cursor e vá em Settings (ícone de engrenagem no topo direito).
  2. Navegue até Features > MCP.
  3. Clique em + Add New MCP Server.
  4. Configure da seguinte forma:
    • Name: brabrix
    • Type: stdio
    • Command: node /CAMINHO/ABSOLUTO/apps/brabrix-mcp-server/dist/index.js
  5. Adicione as Environment Variables (Token e Project ID) conforme solicitado.

Agora, no chat do Cursor, basta mencionar @brabrix ou simplesmente pedir para ele ler o backlog.

2. GitHub Copilot (via Bridge)

O Copilot no VS Code ainda não suporta MCP nativamente em todas as versões, mas você pode usar o **Copilot Extension SDK** ou uma bridge.

Usando com o Chat do Copilot:

A forma mais eficiente hoje é via Custom Instructions:

  1. Certifique-se que o MCP Server está rodando localmente.
  2. Use a ferramenta copilot-mcp para criar a ponte.
  3. Ou, utilize o **Claude Desktop** com o plugin do Copilot para que o Claude atue como o orquestrador entre o Copilot e o MCP da Brabrix.
Dica Pro: Muitos desenvolvedores usam o Claude Code em paralelo ao VS Code/Copilot. O Claude Code tem suporte total ao MCP da Brabrix e pode editar os arquivos que o Copilot está sugerindo.

3. Claude Code, Gemini CLI & Codex CLI

Claude Code

claude mcp add brabrix -- node /path/to/dist/index.js

Gemini CLI

Adicione ao arquivo ~/.gemini/settings.json na chave mcpServers o path para o servidor e suas credenciais.

Codex CLI

No arquivo ~/.codex/config.json, adicione a configuração na chave mcp:

{
  "mcp": {
    "servers": {
      "brabrix": {
        "command": "node",
        "args": ["/path/to/dist/index.js"],
        "env": { "BRABRIX_TOKEN": "..." }
      }
    }
  }
}
VS Code Extension v0.0.1 • Manual do Usuário

Brabrix Dev: O Manual Definitivo

Descubra cada funcionalidade, atalho e configuração secreta da extensão que transforma o VS Code em uma plataforma de engenharia autônoma.

1. Explorando o Painel Lateral (Views)

Ao clicar no ícone da Brabrix na Activity Bar, você encontra três painéis projetados para diferentes estágios do desenvolvimento:

🏢 Projetos

Gerencie seus workspaces. Aqui você pode:

  • Vincular Workspace: Conecta a pasta atual ao contexto do projeto na nuvem.
  • Sincronizar Contexto: Faz o download completo de PRDs e Specs para a pasta local (.brabrix/context/).
  • Criar Projeto Local: Modo 100% offline (usando um banco local JSON) para quando você não quer/pode sincronizar com a web.
  • Editar Projeto Local: Altere configurações de projetos criados offline.
  • Abrir no Navegador: Um clique para abrir o dashboard web da Brabrix.
  • Gerar Arquivos .md: Exporta o contexto do projeto para formato markdown.

📋 Backlog

A visão estrutural do seu produto. Suporta uma hierarquia complexa: EPIC > FEATURE > USER_STORY > TASK / BUG.

  • Criar Novo Item (Ícone +): Permite criar novos itens no backlog. A extensão pergunta o tipo (Feature, Task, Bug, etc.), o título e permite vincular a um item "Pai".
  • Editar Item: Permite renomear itens ou alterar descrições localmente.
  • Ver Detalhes do Item (Ícone i): Abre um painel lateral do VS Code exibindo os Critérios de Aceite e as descrições.
  • Excluir Item: Remove itens diretamente da árvore.

🎯 Board (Kanban)

Foco na execução diária. Agrupa as tarefas ativas pelos status: TODO, READY, IN_PROGRESS, IN_REVIEW e DONE. Clique em Atualizar Status (Ícone de Play) para mover os cards pelo fluxo.

2. O Poder do Botão Direito (Context Menus)

A Brabrix injeta "magias" contextuais em diferentes partes do editor. Veja a lista exaustiva do que você pode fazer clicando com o botão direito:

Em Projetos (Visão Projetos)

  • Gerar PRD do Projeto: Pede para a IA rascunhar um Documento de Requisitos de Produto inicial (Product Requirements Document).
  • Gerar Prompt de Skills: Analisa o PRD do projeto e cria instruções técnicas rigorosas (AGENTS.md) para a equipe e outras IAs seguirem.
  • Exportar Documentos do Workflow: Baixa todos os artefatos de governança (Technical Spec, Architecture Docs, PRD) como arquivos separados na sua máquina.

Em User Stories e Features (No Backlog)

  • Quebrar História em Tarefas: Seleciona a História ou Feature, envia para a IA e ela devolve tarefas técnicas menores e granulares com estimativas de horas, prontas para irem para o Board.

Em Tarefas e Bugs (Backlog e Board)

  • Gerar Prompt da Tarefa: Compila a Especificação, Critérios de Aceite e o Histórico da tarefa em um único texto estruturado para a IA entender.
  • Copiar Spec Técnica: Copia apenas o markdown técnico para a área de transferência. Útil para colar no chat do GitHub Copilot ou Cursor.
  • Fazer Code Review da Tarefa: A IA analisa seus arquivos em stage no Git comparando-os estritamente com os Critérios de Aceite da Tarefa antes de abrir um PR.
  • Finalizar Tarefa e Commitar: O fluxo ouro! Move a tarefa para DONE na Brabrix, pede à IA para escrever uma mensagem de Conventional Commit com base nas suas alterações, e faz o commit no git local.

Direto no Código-Fonte (Editor de Texto)

  • Reportar Bug a partir de Erro: Viu uma falha no código? Selecione as linhas defeituosas, clique com o botão direito e escolha "Brabrix: Reportar Bug". A extensão cria um card de Bug no backlog já com o snippet de código anexado na descrição.

3. Execução Integrada de Agentes (CLIs)

A extensão não apenas gera prompts, ela orquestra Agentes de Linha de Comando (CLI) diretamente em um terminal integrado do VS Code.

No menu da tarefa, após gerar o prompt, você pode enviar o contexto inteiro com apenas um clique para:

  • 🚀 Executar com Gemini CLI: Chama o gemini-cli. Excelente para mapeamento de arquitetura complexa e features inteiras.
  • 🧠 Executar com Claude Code: Chama o claude-code (da Anthropic). O melhor para refatoração cirúrgica e edição precisa de múltiplos arquivos.
  • ⚙️ Executar com Codex CLI: Integração com agentes OpenAI, bom para geração de testes e boilerplate.

Você também tem a opção "Executar prompt em CLI local" que usará o agente padrão definido nas configurações.

4. Configuração Automática do MCP

Se você usa o Cursor, Claude Desktop ou o próprio Gemini CLI com suporte a Model Context Protocol (MCP), a extensão facilita o setup:

  • Configurar MCP da Brabrix (Command Palette): Abre um assistente visual para te guiar.
  • Copiar Configuração MCP para Gemini: Gera o bloco JSON exato com as variáveis de ambiente (Tokens, IDs de Projeto) preenchidas.
  • Copiar Comando MCP para Claude: Gera o comando claude mcp add ... pronto para colar e executar no terminal.

5. Dicionário de Configurações Avançadas (Settings)

Acesse File > Preferences > Settings (ou digite Ctrl+,) e procure por "Brabrix" para customizar sua experiência:

Chave da Configuração O que faz (Valor Padrão)
brabrix.docsFolder Define a pasta onde os artefatos locais (PRDs, Backlog) são salvos (Default: .brabrix). Recomendado adicionar ao .gitignore.
brabrix.agent.defaultCli Qual agente usar quando você clica em "Executar prompt em CLI local" (Opções: gemini, claude, codex, custom).
brabrix.agent.executionProfile Define como a Brabrix orienta o CLI local a executar o prompt:
- plan (Padrão): A IA deve analisar e sugerir um plano antes de alterar arquivos.
- edit: Permite que a IA altere arquivos livremente.
- safe: Apenas gera ou copia o prompt, não executa no terminal.
- manual: Força a IA a retornar blocos de código para você aplicar manualmente.
brabrix.agent.executionMode askBeforeRun (Escreve o comando no terminal e espera você apertar ENTER) ou copyOnly (Apenas copia o comando de execução para o clipboard).
brabrix.agent.terminalName Nome da aba do terminal integrado que a Brabrix criará/usará (Default: "Brabrix Dev Agent").
brabrix.agent.*Command Permite customização livre dos comandos shell para cada IA. Exemplo do Gemini: gemini < "{promptFile}".
brabrix.apiBaseUrl URL da API da Brabrix (Padrão Cloud). Altere caso esteja rodando uma versão Enterprise local.

6. Atalhos Essenciais (Command Palette)

Pressione Ctrl+Shift+P (ou Cmd+Shift+P) e digite "Brabrix":

  • Brabrix: Login / Logout — Autentica ou desconecta seu ambiente do servidor web.
  • Brabrix: Vincular workspace ao projeto — Faz a ponte entre seu código local e a nuvem.
  • Brabrix: Desvincular workspace — Quebra o vínculo com o projeto atual.
  • Brabrix: Sincronizar contexto do projeto — Força a atualização dos documentos Markdown.
  • Brabrix: Selecionar tarefa atual — Define no contexto (para MCP e Prompts) em qual card você está trabalhando neste exato momento.
  • Brabrix: Ver status de sincronização — Mostra quando o contexto foi baixado pela última vez.