Romanela
Guia qualquer agente de IA ou assistente de IA a escrever código saudável e de fácil manutenção
Documentação
Servidor MCP CodeScene
O Servidor MCP CodeScene expõe a análise de Code Health da CodeScene como ferramentas locais amigáveis para IA.
Este servidor foi projetado para ser executado no seu ambiente local e permite que assistentes de IA (como GitHub Copilot, Cursor, Claude code, etc.) solicitem insights significativos de Code Health diretamente do seu código-fonte. Os insights de Code Health enriquecem os prompts de IA com conteúdo rico sobre problemas de qualidade de código, problemas de manutenibilidade e dívida técnica em geral.
O repositório também inclui um conjunto baixável de habilidades públicas de agente em skills/ para equipes que desejam reutilizar fluxos de trabalho MCP da CodeScene em seus próprios pipelines agênticos.
Primeiros Passos com CodeScene MCP
Quer que a IA execute a configuração? Comece com skills/installing-and-activating-codescene-mcp/SKILL.md.
- Configurando a Autenticação para o Servidor MCP — consulte Autenticação.
- Instale o Servidor MCP usando uma das opções de instalação abaixo.
- Adicione o Servidor MCP ao seu assistente de IA. Consulte as instruções detalhadas para o seu ambiente no guia de instalação.
- Copie a orientação de agente que corresponde à sua licença para o seu repositório: AGENTS-full.md para usuários CodeScene Core, AGENTS-standalone.md para usuários de licença standalone, ou .amazonq/rules para Amazon Q. Copie também quaisquer habilidades públicas relevantes para prompts de fluxo de trabalho reutilizáveis.
- Explore as ferramentas disponíveis para ver o que o Servidor MCP pode fazer e quais ferramentas estão disponíveis para a sua licença.
Instalação
Escolha o método de instalação que funciona melhor para a sua plataforma.
NPM / npx (macOS, Linux, Windows)
Execute o servidor MCP diretamente com npx (sem necessidade de instalação):
npx @codescene/codehealth-mcp
Ou instale globalmente:
npm install -g @codescene/codehealth-mcp
A primeira execução baixa automaticamente o binário específico da plataforma para o seu sistema e o armazena em cache para uso futuro. Requer Node.js 18 ou posterior.
Claude Code
Adicione o marketplace da CodeScene e instale o plugin:
/plugin marketplace add codescene-oss/codescene-mcp-server
/plugin install codescene@codescene
Isso instala o servidor MCP e as habilidades de Code Health. Requer Node.js 18 ou posterior.
Claude Desktop
Baixe o pacote MCP da página de versões mais recentes:
codehealth-mcp-{version}.mcpb
Em seguida, abra o arquivo .mcpb com o Claude Desktop para instalar o servidor MCP.
Homebrew (macOS / Linux)
brew tap codescene-oss/codescene-mcp-server https://github.com/codescene-oss/codescene-mcp-server
brew trust codescene-oss/codescene-mcp-server
brew install cs-mcp
Windows
Execute isto no PowerShell:
irm https://raw.githubusercontent.com/codescene-oss/codescene-mcp-server/main/install.ps1 | iex
Download Manual
Baixe o binário mais recente para a sua plataforma na página de Releases do GitHub:
- macOS:
cs-mcp-macos-aarch64.zip(Apple Silicon) oucs-mcp-macos-amd64(Intel) - Linux:
cs-mcp-linux-aarch64.zipoucs-mcp-linux-amd64 - Windows:
cs-mcp-windows-amd64.exe
Após o download, torne-o executável e, opcionalmente, adicione-o ao seu PATH:
chmod +x cs-mcp-*
mv cs-mcp-* /usr/local/bin/cs-mcp
Você também pode compilar um executável estático a partir do código-fonte.
Docker
docker pull codescene/codescene-mcp
📖 Guia completo de instalação e integração | Compilar a imagem Docker localmente
Casos de Uso
[!TIP] Assista ao vídeo de demonstração do CodeScene MCP.
[!NOTE] O CodeScene MCP vem com um conjunto de prompts de exemplo, arquivos de orientação de agente para capturar os principais casos de uso e um conjunto baixável de habilidades públicas. Copie a orientação de agente que corresponde à sua licença — AGENTS-full.md para usuários CodeScene Core ou AGENTS-standalone.md para usuários standalone — e quaisquer habilidades relevantes para o seu próprio repositório.
Com o Servidor MCP CodeScene em funcionamento, suas ferramentas de IA podem:
Proteger Código Gerado por IA
Evite que a IA introduza dívida técnica sinalizando problemas de manutenibilidade como complexidade, aninhamento profundo, baixa coesão, etc.
Elevar Código Não Saudável para Prontidão de IA
A qualidade da refatoração por IA melhora quando o código é modular e fácil de raciocinar. O servidor MCP dá ao seu assistente orientação concreta para chegar lá:
- executar revisões focadas de Code Health,
- identificar os problemas específicos de design a serem abordados,
- refatorar em etapas pequenas e mensuráveis, e
- verificar o progresso com pontuações atualizadas de Code Health.
Este fluxo de trabalho funciona apenas com MCP e muitas vezes é suficiente para melhorar com segurança código legado.
Realizar Refatoração Direcionada
As ferramentas de IA podem refatorar código, mas carecem de direção sobre o que corrigir e como medir se ajudou. As ferramentas de Code Health resolvem isso dando aos assistentes de IA insights precisos sobre problemas de design, bem como uma forma objetiva de avaliar o resultado: o Code Health melhorou?
Entender o Código Existente Antes de Agir
Use revisões de Code Health para informar resumos, diagnósticos ou transformações de código orientados por IA com base em desafios cognitivos e de design do mundo real, não apenas sintaxe.
Revisar o Impacto da Salvaguarda MCP
Peça ao seu assistente de IA para mostrar a visão geral do uso do MCP para ver elevações de Code Health, degradações evitadas e o escopo e a qualidade dos seus últimos 250 eventos MCP. Clientes suportados exibem um painel interativo; outros clientes recebem um resumo em Markdown. Este recurso conectado à API requer uma conta CodeScene Core e não está disponível com licença standalone. Consulte show_mcp_usage_overview para detalhes.
Perguntas Frequentes
Preciso de uma conta CodeScene para usar o MCP?
O conjunto completo de recursos — incluindo hotspots, metas de dívida técnica e propriedade de código — requer uma assinatura CodeScene. Autentique-se pedindo ao seu Assistente de IA para fazer login na CodeScene, ou use a ferramenta de login. Alternativamente, use sua instância CodeScene para criar o CS_ACCESS_TOKEN que ativa o MCP.
O MCP suporta tanto CodeScene Cloud quanto CodeScene on-prem.
Para análise local de Code Health sem assinatura CodeScene, você pode usar o CodeScene Code Health MCP standalone.
Como o Servidor MCP mantém meu código privado e seguro?
O Servidor MCP CodeScene é executado totalmente localmente. Toda a análise — incluindo pontuação de Code Health, revisões delta e cálculos de caso de negócio — é realizada na sua máquina, contra o seu repositório local. Nenhum código-fonte ou dado de análise é enviado a provedores de nuvem, fornecedores de LLM ou qualquer serviço externo.
Os resultados da análise (por exemplo, hotspots e metas de dívida técnica) são obtidos via REST da sua própria conta CodeScene usando um token seguro.
Para detalhes completos, consulte a documentação completa de privacidade e segurança da CodeScene.
Posso usar qualquer LLM como base para o CodeScene MCP?
O CodeScene MCP pode funcionar com qualquer modelo que seu assistente de IA suporte, mas recomendamos fortemente escolher um modelo de fronteira quando seu assistente oferecer um seletor de modelos (como em ferramentas como GitHub Copilot).
Modelos de fronteira — como Claude Sonnet — oferecem adesão a regras e qualidade de refatoração muito melhores, enquanto modelos legados como GPT-4.1 frequentemente têm dificuldade com as restrições do MCP. Para uma experiência consistente e de alta qualidade, selecione o modelo mais recente disponível.
Tenho vários repositórios — como configuro o MCP?
Como você precisa fornecer um caminho de montagem para Docker, você pode ter uma configuração MCP por projeto (no VS Code, isso seria um arquivo .vscode/mcp.json por projeto, por exemplo) ou pode montar um diretório raiz dentro do qual todos os seus projetos estão e então usar apenas essa configuração.
Por que o IntelliJ fornece um caminho errado para o servidor MCP?
Em nossos testes, observamos que o AI Assistant do IntelliJ às vezes fornece um caminho errado para o servidor MCP CodeScene. Pelo que podemos dizer, parece não ter nada a ver com o servidor MCP em si, mas sim com o AI Assistant do IntelliJ, que parece alucinar partes do caminho algumas vezes. Ainda estamos investigando este problema e atualizaremos esta seção assim que tivermos mais informações.
Como configuro certificados SSL personalizados?
Se sua organização usa uma CA (Autoridade Certificadora) interna, defina a variável de ambiente REQUESTS_CA_BUNDLE para apontar para o arquivo de certificado da sua CA (formato PEM). O servidor MCP configura SSL automaticamente — você só precisa defini-la uma vez.
O MCP também suporta SSL_CERT_FILE e CURL_CA_BUNDLE como alternativas.
Para exemplos de configuração detalhados (incluindo montagem de certificados Docker), consulte Opções de Configuração — SSL/TLS.
Como desativo a verificação de atualização de versão?
O servidor MCP verifica periodicamente o GitHub para novas versões e mostra um banner "ATUALIZAÇÃO DE VERSÃO DISPONÍVEL" quando sua versão está desatualizada. Esta verificação é executada em segundo plano e nunca bloqueia respostas de ferramentas, mas em ambientes com restrição de rede você pode querer desativá-la completamente.
Defina a variável de ambiente CS_DISABLE_VERSION_CHECK para qualquer valor não vazio (por exemplo, 1). Para detalhes de configuração, consulte Opções de Configuração — Verificação de Versão.
Compilando a partir do Código-Fonte
O servidor MCP é escrito em Rust. Para compilar a partir do código-fonte:
cargo build --release
O binário é produzido em target/release/cs-mcp.
Para mais detalhes, consulte: