Codacy

Acesse a API do Codacy para analisar qualidade de código, cobertura e segurança dos seus repositórios.

Documentação

Servidor MCP Codacy

Servidor MCP para a API do Codacy, permitindo acesso a repositórios, arquivos, qualidade, cobertura, segurança e muito mais.

Sumário

Recursos / Ferramentas
Configuração
Solução de Problemas
Contribuição
Suporte ao Codacy-CLI
Licença

Recursos / Ferramentas

As seguintes ferramentas estão disponíveis através do Servidor MCP Codacy:

Configuração e Gerenciamento de Repositórios

codacy_setup_repository: Adicionar ou seguir um repositório no Codacy se ainda não estiver presente. Esta ferramenta garante que o repositório esteja registrado no Codacy, permitindo análises e gerenciamento adicionais.

Gerenciamento de Organizações e Repositórios

codacy_list_organizations: Listar organizações com suporte a paginação.
codacy_list_organization_repositories: Listar repositórios em uma organização com suporte a paginação.
codacy_get_repository_with_analysis: Obter repositório com informações de análise, incluindo métricas de Nota, Problemas, Duplicação, Complexidade e Cobertura.

Qualidade e Análise de Código

codacy_list_repository_issues: Lista e filtra problemas de qualidade de código em um repositório. Esta é a principal ferramenta para investigar preocupações gerais de qualidade de código (ex.: boas práticas, desempenho, complexidade, estilo), mas NÃO problemas de segurança. Para problemas relacionados à segurança, use a ferramenta de itens SRM. Recursos incluem:
- Suporte a paginação para lidar com grandes conjuntos de resultados
- Filtragem por múltiplos critérios, incluindo severidade, categoria e linguagem
- Filtragem baseada em autor para responsabilização
- Análise específica por branch
- Pesquisa baseada em padrões
Casos de uso comuns:
- Auditorias de qualidade de código
- Avaliação de dívida técnica
- Verificações de conformidade com guias de estilo
- Investigação de problemas de desempenho
- Análise de complexidade

Gerenciamento e Análise de Arquivos

codacy_list_files: Listar arquivos em um repositório com suporte a paginação.
codacy_get_file_issues: Obter a lista de problemas para um arquivo em um repositório.
codacy_get_file_coverage: Obter informações de cobertura para um arquivo no commit principal de um branch do repositório.
codacy_get_file_clones: Obter a lista de clones de duplicação (segmentos de código idênticos ou muito semelhantes) para um arquivo em um repositório.
codacy_get_file_with_analysis: Obter informações detalhadas de análise para um arquivo, incluindo métricas de Nota, Problemas, Duplicação, Complexidade e Cobertura.

Análise de Segurança

codacy_search_organization_srm_items: Ferramenta principal para listar itens/problemas/vulnerabilidades/descobertas de segurança em uma organização. Os resultados estão relacionados ao painel de segurança e gerenciamento de riscos (SRM) da organização no Codacy.
codacy_search_repository_srm_items: Listar itens/problemas/vulnerabilidades/descobertas de segurança para um repositório específico.

Ambas as ferramentas fornecem análise de segurança abrangente, incluindo:

SAST (Varredura de código)
Segredos (Varredura de segredos)
SCA (Varredura de dependências)
IaC (Varredura de infraestrutura como código)
CICD (Varredura de CI/CD)
DAST (Teste Dinâmico de Segurança de Aplicações)
Testes de Penetração

Análise de Pull Requests

codacy_list_repository_pull_requests: Listar pull requests de um repositório ao qual o usuário tem acesso.
codacy_get_repository_pull_request: Obter informações detalhadas sobre um pull request específico.
codacy_list_pull_request_issues: Retorna uma lista de problemas encontrados em um pull request (problemas novos ou corrigidos).
codacy_get_pull_request_files_coverage: Obter informações de cobertura de diff para todos os arquivos em um pull request.
codacy_get_pull_request_git_diff: Retorna o diff Git legível por humanos de um pull request.

Gerenciamento de Ferramentas e Padrões

codacy_list_tools: Listar todas as ferramentas de análise de código disponíveis no Codacy.
codacy_list_repository_tools: Obter configurações de ferramentas de análise e ferramentas disponíveis para um repositório.
codacy_get_pattern: Obter a definição de um padrão específico.
codacy_list_repository_tool_patterns: Listar os padrões de uma ferramenta disponível para um repositório.
codacy_get_issue: Obter informações detalhadas sobre um problema específico.

Análise via CLI

codacy_cli_analyze: Executar análise de qualidade localmente usando o Codacy CLI. Recursos incluem:
- Analisar arquivos específicos ou diretórios inteiros
- Usar ferramentas específicas ou todas as ferramentas disponíveis
- Obter resultados imediatos sem esperar pela análise agendada
- Aplicar correções com base na configuração do Codacy

Configuração

Pré-requisitos

Certifique-se de que sua máquina tenha as seguintes ferramentas instaladas:

git
node.js
- certifique-se de que o comando npx seja executado sem problemas.

Para análise local, o Servidor MCP requer o Codacy CLI instalado. Se não estiver disponível, o Servidor MCP tentará instalá-lo para você. O Codacy CLI v2 é executado em macOS, Linux e Windows (apenas com WSL).

Token de Acesso Pessoal da API

Obtenha o Token de API da sua Conta Codacy na sua Conta Codacy.

Você precisará dele mais tarde na configuração.

Instalação

Em IDEs suportados como VS Code, Cursor e Windsurf, a maneira mais fácil de instalar o Servidor MCP do Codacy é fazê-lo pela extensão do Codacy. Se ainda não o fez, instale a extensão de dentro do seu IDE, ou de qualquer um dos marketplaces disponíveis (Microsoft, OpenVSX). No painel da extensão, basta clicar em Adicionar Servidor MCP Codacy. Reinicie seu IDE depois.

Sem a extensão, você ainda pode usar e instalar o Servidor MCP:

Cursor, Windsurf e outros

Você pode usar a instalação com um clique para o Cursor:

Caso contrário, dependendo de onde você está conectando o Servidor MCP, você pode usar os seguintes métodos:

Cursor: edite o arquivo .cursor/mcp.json para adicionar o seguinte
Windsurf: edite o arquivo .codeium/windsurf/mcp_config.json para adicionar o seguinte
Claude Desktop: edite o arquivo claude_desktop_config.json para adicionar o seguinte

{
  "mcpServers": {
    "codacy": {
      "command": "npx",
      "args": ["-y", "@codacy/codacy-mcp"],
      "env": {
        "CODACY_ACCOUNT_TOKEN": "<YOUR_TOKEN>"
      }
    }
  }
}

VS Code com Copilot

Você pode usar a instalação com um clique para o VS Code:

Caso contrário, se você deseja configurá-lo manualmente:

Para conectar o Servidor MCP ao Copilot no VS Code, adicione o seguinte à configuração global do IDE:

{
  "mcp": {
    "inputs": [],
    "servers": {
      "codacy": {
        "command": "npx",
        "args": ["-y", "@codacy/codacy-mcp"],
        "env": {
          "CODACY_ACCOUNT_TOKEN": "<YOUR_TOKEN>"
        }
      }
    }
  }
}

Você pode abrir o arquivo settings.json do usuário em:

View > Command Palette > Preferences: Open User Settings (JSON)

Ou abra o arquivo settings.json geral diretamente, que de acordo com seu sistema operacional deve estar localizado em:

para macOS: ~/Library/Application Support/Code/User/settings.json
para Windows: %APPDATA%\Code\User\settings.json
para Linux: ~/.config/Code/User/settings.json

Não se esqueça de atualizar o valor de CODACY_ACCOUNT_TOKEN com seu token.

Certifique-se de ter o modo Agente habilitado: vscode://settings/chat.agent.enabled
Abra o chat do Copilot e alterne o modo para Agent. Você pode verificar se o servidor MCP foi habilitado corretamente clicando no ícone Select tools, que deve listar todas as ferramentas Codacy disponíveis.

Copilot Agent with Codacy tools

Solução de Problemas

Claude Desktop e NVM

Ao usar NVM com Claude Desktop, o NPX pode não funcionar. Você deve primeiro instalar o Servidor MCP globalmente e depois usar o Node diretamente:

npm install -g @codacy/codacy-mcp

{
  "mcpServers": {
    "codacy": {
      "command": "/Users/yourusername/.nvm/versions/node/vXX.X.X/bin/node",
      "args": ["/path-to/codacy-mcp/dist/index.js"],
      "env": {
        "CODACY_ACCOUNT_TOKEN": "<YOUR_TOKEN>"
      }
    }
  }
}

Contribuição

Para trabalhar localmente no código do Servidor MCP, execute:

npm install
npm run update-api
npm run build

Testando com o Inspector

Você pode testar o servidor MCP usando a ferramenta inspector. Você pode definir uma variável de ambiente CODACY_ACCOUNT_TOKEN ou passá-la inline:

CODACY_ACCOUNT_TOKEN=your_token_here npm run inspect

Isso compilará o projeto e iniciará o inspector MCP com seu token Codacy.

Testando com um Agente

Você pode testar sua instância local configurando o Servidor MCP da seguinte forma:

"codacy": {
  "command": "/path/to/bin/node",
  "args": [
    "/path/to/codacy-mcp-server/dist/index.js"
  ],
  "env": {
    "CODACY_ACCOUNT_TOKEN": "<YOUR_TOKEN>"
  }
}

Suporte ao Codacy-CLI

Para usar o Codacy-CLI, ele precisa estar instalado. Sempre que o Servidor MCP receber uma solicitação de análise, ele tentará instalar o CLI e inicializá-lo.

Caso você queira usar uma versão específica do nosso CLI, envie uma variável de ambiente CODACY_CLI_VERSION na configuração do Servidor MCP.

Licença

Este servidor MCP é licenciado sob a Licença MIT. Isso significa que você é livre para usar, modificar e distribuir o software, sujeito aos termos e condições da Licença MIT. Para mais detalhes, consulte o arquivo LICENSE no repositório do projeto.