Codacy

Accede a la API de Codacy para analizar la calidad del código, la cobertura y la seguridad de tus repositorios.

Documentación

Servidor MCP de Codacy

Codacy Badge

Servidor MCP para la API de Codacy, que permite acceder a repositorios, archivos, calidad, cobertura, seguridad y más.

Tabla de Contenidos

Funciones / Herramientas

Las siguientes herramientas están disponibles a través del Servidor MCP de Codacy:

Configuración y Gestión de Repositorios

  • codacy_setup_repository: Añade o sigue un repositorio en Codacy si aún no está presente. Esta herramienta garantiza que el repositorio esté registrado en Codacy, permitiendo análisis y gestión adicionales.

Gestión de Organizaciones y Repositorios

  • codacy_list_organizations: Lista organizaciones con soporte de paginación.
  • codacy_list_organization_repositories: Lista repositorios en una organización con soporte de paginación.
  • codacy_get_repository_with_analysis: Obtiene el repositorio con información de análisis, incluyendo métricas de Calificación, Problemas, Duplicación, Complejidad y Cobertura.

Calidad de Código y Análisis

  • codacy_list_repository_issues: Lista y filtra problemas de calidad de código en un repositorio. Esta es la herramienta principal para investigar problemas generales de calidad de código (por ejemplo, mejores prácticas, rendimiento, complejidad, estilo) pero NO problemas de seguridad. Para problemas relacionados con seguridad, use la herramienta de elementos SRM en su lugar. Las características incluyen:

    • Soporte de paginación para manejar grandes conjuntos de resultados
    • Filtrado por múltiples criterios, incluyendo severidad, categoría e idioma
    • Filtrado basado en autor para responsabilidad
    • Análisis específico por rama
    • Búsqueda basada en patrones

    Casos de uso comunes:

    • Auditorías de calidad de código
    • Evaluación de deuda técnica
    • Verificaciones de cumplimiento de guías de estilo
    • Investigación de problemas de rendimiento
    • Análisis de complejidad

Gestión y Análisis de Archivos

  • codacy_list_files: Lista archivos en un repositorio con soporte de paginación.
  • codacy_get_file_issues: Obtiene la lista de problemas para un archivo en un repositorio.
  • codacy_get_file_coverage: Obtiene información de cobertura para un archivo en el commit más reciente de una rama del repositorio.
  • codacy_get_file_clones: Obtiene la lista de clones de duplicación (segmentos de código idénticos o muy similares) para un archivo en un repositorio.
  • codacy_get_file_with_analysis: Obtiene información detallada de análisis para un archivo, incluyendo métricas de Calificación, Problemas, Duplicación, Complejidad y Cobertura.

Análisis de Seguridad

  • codacy_search_organization_srm_items: Herramienta principal para listar elementos/problemas/vulnerabilidades/hallazgos de seguridad en toda una organización. Los resultados están relacionados con el panel de gestión de seguridad y riesgos (SRM) de la organización en Codacy.
  • codacy_search_repository_srm_items: Lista elementos/problemas/vulnerabilidades/hallazgos de seguridad para un repositorio específico.

Ambas herramientas proporcionan un análisis de seguridad integral que incluye:

  • SAST (Escaneo de código)
  • Secrets (Escaneo de secretos)
  • SCA (Escaneo de dependencias)
  • IaC (Escaneo de infraestructura como código)
  • CICD (Escaneo de CI/CD)
  • DAST (Pruebas dinámicas de seguridad de aplicaciones)
  • PenTesting (Pruebas de penetración)

Análisis de Pull Requests

  • codacy_list_repository_pull_requests: Lista pull requests de un repositorio al que el usuario tiene acceso.
  • codacy_get_repository_pull_request: Obtiene información detallada sobre un pull request específico.
  • codacy_list_pull_request_issues: Devuelve una lista de problemas encontrados en un pull request (problemas nuevos o corregidos).
  • codacy_get_pull_request_files_coverage: Obtiene información de cobertura de diff para todos los archivos en un pull request.
  • codacy_get_pull_request_git_diff: Devuelve el diff de Git legible por humanos de un pull request.

Gestión de Herramientas y Patrones

  • codacy_list_tools: Lista todas las herramientas de análisis de código disponibles en Codacy.
  • codacy_list_repository_tools: Obtiene la configuración de las herramientas de análisis y las herramientas disponibles para un repositorio.
  • codacy_get_pattern: Obtiene la definición de un patrón específico.
  • codacy_list_repository_tool_patterns: Lista los patrones de una herramienta disponible para un repositorio.
  • codacy_get_issue: Obtiene información detallada sobre un problema específico.

Análisis CLI

  • codacy_cli_analyze: Ejecuta análisis de calidad localmente usando Codacy CLI. Las características incluyen:
    • Analizar archivos específicos o directorios completos
    • Usar herramientas específicas o todas las herramientas disponibles
    • Obtener resultados inmediatos sin esperar el análisis programado
    • Aplicar correcciones basadas en la configuración de Codacy

Configuración

Requisitos

Asegúrate de que tu máquina tenga instaladas las siguientes herramientas:

  • git
  • node.js
    • asegúrate de que el comando npx se ejecute sin problemas.

Para el análisis local, el Servidor MCP requiere que Codacy CLI esté instalado. Si no está disponible, el Servidor MCP intentará instalarlo por ti. Codacy CLI v2 se ejecuta en macOS, Linux y Windows (solo con WSL).

Token de Acceso Personal a la API

Obtén el Token de API de tu Cuenta de Codacy desde tu Cuenta de Codacy.

Lo necesitarás más adelante en la configuración.

Instalación

En IDEs compatibles como VS Code, Cursor y Windsurf, la forma más fácil de instalar el Servidor MCP de Codacy es hacerlo desde la extensión de Codacy. Si aún no lo has hecho, instala la extensión desde tu IDE, o desde cualquiera de los marketplaces disponibles (Microsoft, OpenVSX). Desde el panel de extensiones, simplemente haz clic en Add Codacy MCP Server. Reinicia tu IDE después.

Sin la extensión, aún puedes usar e instalar el Servidor MCP:

Cursor, Windsurf y otros

Puedes usar la instalación con un clic para Cursor:

Install MCP Server

De lo contrario, dependiendo de a qué estés conectando el Servidor MCP, puedes usar los siguientes métodos:

  • Cursor: edita el archivo .cursor/mcp.json para añadir lo siguiente
  • Windsurf: edita el archivo .codeium/windsurf/mcp_config.json para añadir lo siguiente
  • Claude Desktop: edita el archivo claude_desktop_config.json para añadir lo siguiente
{
  "mcpServers": {
    "codacy": {
      "command": "npx",
      "args": ["-y", "@codacy/codacy-mcp"],
      "env": {
        "CODACY_ACCOUNT_TOKEN": "<YOUR_TOKEN>"
      }
    }
  }
}

VS Code con Copilot

Puedes usar la instalación con un clic para VS Code:

Install with Codacy in VS Code Install with Codacy in VS Code Insiders

De lo contrario, si deseas configurarlo manualmente:

  1. Para conectar el Servidor MCP a Copilot en VS Code, añade lo siguiente a la configuración global del IDE:
{
  "mcp": {
    "inputs": [],
    "servers": {
      "codacy": {
        "command": "npx",
        "args": ["-y", "@codacy/codacy-mcp"],
        "env": {
          "CODACY_ACCOUNT_TOKEN": "<YOUR_TOKEN>"
        }
      }
    }
  }
}

Puedes abrir el archivo user settings.json en:

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

O abre el archivo general settings.json directamente, que según tu sistema operativo debería estar ubicado en:

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

No olvides actualizar el valor de CODACY_ACCOUNT_TOKEN con tu token.

  1. Asegúrate de tener el modo Agente habilitado: vscode://settings/chat.agent.enabled

  2. Abre el chat de Copilot y cambia el modo a Agent. Puedes verificar que el servidor MCP se habilitó correctamente haciendo clic en el icono Select tools, que debería listar todas las herramientas de Codacy disponibles.

Copilot Agent with Codacy tools

Solución de Problemas

Claude Desktop y NVM

Al usar NVM con Claude Desktop, NPX puede no funcionar. Primero debes instalar el Servidor MCP globalmente, y luego usar Node directamente:

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>"
      }
    }
  }
}

Contribuir

Para trabajar localmente en el código del Servidor MCP, ejecuta:

npm install
npm run update-api
npm run build

Pruebas con Inspector

Puedes probar el servidor MCP usando la herramienta inspector. Puedes establecer una variable de entorno CODACY_ACCOUNT_TOKEN o pasarla en línea:

CODACY_ACCOUNT_TOKEN=your_token_here npm run inspect

Esto compilará el proyecto y lanzará el inspector de MCP con tu token de Codacy.

Pruebas con un Agente

Puedes probar tu instancia local configurando el Servidor MCP de la siguiente manera:

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

Soporte de Codacy-CLI

Para usar Codacy-CLI, debe estar instalado. Cada vez que el Servidor MCP reciba una solicitud de análisis, intentará instalar el CLI e inicializarlo.

En caso de que quieras usar una versión específica de nuestro CLI, envía una variable de entorno CODACY_CLI_VERSION en la configuración del Servidor MCP.

Licencia

Este servidor MCP está licenciado bajo la Licencia MIT. Esto significa que eres libre de usar, modificar y distribuir el software, sujeto a los términos y condiciones de la Licencia MIT. Para más detalles, consulta el archivo LICENSE en el repositorio del proyecto.