Servidor MCP de DeepSource

Un servidor de Protocolo de Contexto de Modelo (MCP) que se integra con DeepSource para proporcionar a los asistentes de IA acceso a métricas de calidad del código, problemas y resultados de análisis.

Descripción general

El servidor MCP de DeepSource permite a los asistentes de IA interactuar con las capacidades de análisis de calidad del código de DeepSource a través del Protocolo de Contexto de Modelo. Esta integración permite a los asistentes de IA:

• Recuperar métricas de código y resultados de análisis

• Problemas de acceso y filtrado

• Comprobar el estado de la calidad

• Analizar la calidad del proyecto a lo largo del tiempo

Related MCP server: CodeAlive MCP

Características

• Integración de API de DeepSource : se conecta a DeepSource a través de la API GraphQL

• Compatibilidad con el protocolo MCP : implementa el protocolo de contexto de modelo para la integración del asistente de IA

• Métricas y umbrales de calidad : recupere y administre métricas de calidad del código con umbrales

• Informes de cumplimiento de seguridad : acceda a los informes de cumplimiento de OWASP Top 10, SANS Top 25 y MISRA-C

• Vulnerabilidades de dependencia : acceda a información de vulnerabilidad de seguridad sobre dependencias

• TypeScript/Node.js : Creado con TypeScript para seguridad de tipos y funciones modernas de JavaScript

• Multiplataforma : funciona en Linux, macOS y Windows

• Manejo robusto de errores : manejo integral de errores para problemas de red, autenticación y análisis

Uso con Claude Desktop

1. Editar claude_desktop_config.json :

   • Abra Claude Desktop

   • Vaya a Settings -> Developer -> Edit Config

   • Agregue una de las siguientes configuraciones a la sección mcpServers

2. Reinicie Claude Desktop para aplicar los cambios

Consultas de ejemplo

Una vez conectado, su asistente de IA puede usar datos de DeepSource con consultas como:

What issues are in the JavaScript files of my project?

Esto utilizaría la herramienta project_issues con filtros:

{
  "projectKey": "your-project-key",
  "path": "src/",
  "analyzerIn": ["javascript"],
  "first": 10
}

Para filtrar las ejecuciones de análisis:

Show me the most recent Python analysis runs

Esto utilizaría la herramienta project_runs con filtros:

{
  "projectKey": "your-project-key",
  "analyzerIn": ["python"],
  "first": 5
}

Para las métricas de calidad del código:

What's my code coverage percentage? Is it meeting our thresholds?

Esto utilizaría la herramienta quality_metrics :

{
  "projectKey": "your-project-key",
  "shortcodeIn": ["LCV", "BCV", "CCV"]
}

Para informes de cumplimiento de seguridad:

Are we compliant with OWASP Top 10 security standards?

Esto utilizaría la herramienta compliance_report :

{
  "projectKey": "your-project-key",
  "reportType": "OWASP_TOP_10"
}

Para establecer umbrales:

Update our line coverage threshold to 80%

Esto utilizaría la herramienta update_metric_threshold :

{
  "projectKey": "your-project-key",
  "repositoryId": "repo-id",
  "metricShortcode": "LCV",
  "metricKey": "AGGREGATE",
  "thresholdValue": 80
}

Variables de entorno

El servidor admite las siguientes variables de entorno:

• DEEPSOURCE_API_KEY (obligatorio): Su clave API de DeepSource para autenticación

• LOG_FILE (opcional): Ruta al archivo donde se escribirán los registros. Si no se configura, no se escribirán registros.

• LOG_LEVEL (opcional): Nivel mínimo de registro para escribir (DEBUG, INFO, WARN, ERROR). El valor predeterminado es DEBUG.

Ejemplo de configuración con registro:

{
  "mcpServers": {
    "deepsource": {
      "command": "npx",
      "args": [
        "-y",
        "deepsource-mcp-server@1.1.0"
      ],
      "env": {
        "DEEPSOURCE_API_KEY": "your-deepsource-api-key",
        "LOG_FILE": "/tmp/deepsource-mcp.log",
        "LOG_LEVEL": "DEBUG"
      }
    }
  }
}

Estibador

{
  "mcpServers": {
    "deepsource": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "DEEPSOURCE_API_KEY",
        "-e",
        "LOG_FILE=/tmp/deepsource-mcp.log",
        "-v",
        "/tmp:/tmp",
        "sapientpants/deepsource-mcp-server"
      ],
      "env": {
        "DEEPSOURCE_API_KEY": "your-deepsource-api-key",
        "LOG_FILE": "/tmp/deepsource-mcp.log"
      }
    }
  }
}

NPX

{
  "mcpServers": {
    "deepsource": {
      "command": "npx",
      "args": [
        "-y",
        "deepsource-mcp-server@1.1.0"
      ],
      "env": {
        "DEEPSOURCE_API_KEY": "your-deepsource-api-key"
      }
    }
  }
}

Herramientas disponibles

El servidor MCP de DeepSource proporciona las siguientes herramientas:

1. projects : enumera todos los proyectos de DeepSource disponibles

   • Parámetros:

     • No hay parámetros requeridos

2. project_issues : Obtener problemas de un proyecto DeepSource con filtrado

   • Parámetros:

     • projectKey (obligatorio): el identificador único del proyecto DeepSource

     • Parámetros de paginación:

       • offset (opcional): número de elementos que se omitirán para la paginación

       • first (opcional) - Número de artículos a devolver (predeterminado 10)

       • after (opcional) - Cursor para paginación hacia adelante

       • before (opcional) - Cursor para paginación hacia atrás

       • last (opcional) - Número de elementos a devolver antes del cursor 'antes' (predeterminado: 10)

     • Parámetros de filtrado:

       • path (opcional) - Filtrar problemas por ruta de archivo específica

       • analyzerIn (opcional): filtra problemas por analizadores específicos (por ejemplo, ["python", "javascript"])

       • tags (opcional) - Filtrar problemas por etiquetas

3. project_runs : enumera las ejecuciones de análisis para un proyecto DeepSource con filtrado

   • Parámetros:

     • projectKey (obligatorio): el identificador único del proyecto DeepSource

     • Parámetros de paginación:

       • offset (opcional): número de elementos que se omitirán para la paginación

       • first (opcional) - Número de artículos a devolver (predeterminado 10)

       • after (opcional) - Cursor para paginación hacia adelante

       • before (opcional) - Cursor para paginación hacia atrás

       • last (opcional) - Número de elementos a devolver antes del cursor 'antes' (predeterminado: 10)

     • Parámetros de filtrado:

       • analyzerIn (opcional): filtra las ejecuciones por analizadores específicos (por ejemplo, ["python", "javascript"])

4. run : obtiene una ejecución de análisis específica por su runUid o commitOid

   • Parámetros:

     • runIdentifier (obligatorio): el runUid (UUID) o commitOid (hash de confirmación) para identificar la ejecución

5. recent_run_issues : obtiene los problemas del análisis más reciente ejecutado en una rama específica con soporte de paginación

   • Parámetros:

     • projectKey (obligatorio): el identificador único del proyecto DeepSource

     • branchName (obligatorio): el nombre de la rama desde la cual se obtendrá la ejecución más reciente

     • Parámetros de paginación:

       • first (opcional) - Número de números a devolver (predeterminado: 10)

       • after (opcional) - Cursor para paginación hacia adelante

       • last (opcional) - Número de números a devolver antes de un cursor (predeterminado: 10)

       • before (opcional) - Cursor para paginación hacia atrás

   • Devoluciones:

     • Información sobre la ejecución más reciente en la sucursal

     • Problemas actuales en el proyecto (nota: los problemas son a nivel de repositorio, no específicos de la ejecución)

     • Información de paginación, incluidos los cursores y el estado de la página.

     • Metadatos sobre la ejecución y la rama

6. dependency_vulnerabilities : Obtener vulnerabilidades de dependencia de un proyecto DeepSource

   • Parámetros:

     • projectKey (obligatorio): el identificador único del proyecto DeepSource

     • Parámetros de paginación:

       • offset (opcional): número de elementos que se omitirán para la paginación

       • first (opcional) - Número de artículos a devolver (predeterminado 10)

       • after (opcional) - Cursor para paginación hacia adelante

       • before (opcional) - Cursor para paginación hacia atrás

       • last (opcional) - Número de elementos a devolver antes del cursor 'antes' (predeterminado: 10)

7. quality_metrics : Obtenga métricas de calidad de un proyecto DeepSource con filtrado

   • Parámetros:

     • projectKey (obligatorio): el identificador único del proyecto DeepSource

     • shortcodeIn (opcional): filtra métricas por códigos cortos específicos (por ejemplo, ["LCV", "BCV"])

   • Devuelve métricas como:

     • Cobertura de línea (LCV)

     • Cobertura de sucursales (BCV)

     • Cobertura de la documentación (DCV)

     • Porcentaje de código duplicado (DDP)

     • Cada métrica incluye valores actuales, umbrales y estado de aprobación/reprobación.

8. update_metric_threshold : Actualiza el umbral para una métrica de calidad específica

   • Parámetros:

     • projectKey (obligatorio): el identificador único del proyecto DeepSource

     • repositoryId (obligatorio): el ID del repositorio GraphQL

     • metricShortcode (obligatorio): el código corto de la métrica que se actualizará

     • metricKey (obligatorio): la clave de idioma o contexto para la métrica

     • thresholdValue (opcional): el nuevo valor de umbral o nulo para eliminar el umbral

   • Ejemplo: Establecer un umbral de cobertura de línea del 80 %: metricShortcode="LCV", metricKey="AGGREGATE", thresholdValue=80

9. update_metric_setting : Actualizar la configuración de una métrica de calidad

   • Parámetros:

     • projectKey (obligatorio): el identificador único del proyecto DeepSource

     • repositoryId (obligatorio): el ID del repositorio GraphQL

     • metricShortcode (obligatorio): el código corto de la métrica que se actualizará

     • isReported (obligatorio): si se debe informar la métrica

     • isThresholdEnforced (obligatorio): si se debe aplicar el umbral (puede fallar las comprobaciones)

10. compliance_report : Obtener informes de cumplimiento de seguridad de un proyecto de DeepSource

• Parámetros:

  • projectKey (obligatorio): el identificador único del proyecto DeepSource

  • reportType (obligatorio): el tipo de informe de cumplimiento que se obtendrá ( OWASP Top 10 , SANS Top 25 o MISRA-C )

• Devuelve datos completos de cumplimiento de seguridad que incluyen:

  • Estadísticas de problemas de seguridad por categoría y gravedad

  • Estado de cumplimiento (aprobado/reprobado)

  • Datos de tendencias que muestran cambios a lo largo del tiempo

  • Análisis y recomendaciones para mejorar la postura de seguridad

Desarrollo

1. Clonar el repositorio:

git clone https://github.com/sapientpants/deepsource-mcp-server.git
cd deepsource-mcp-server

2. Instalar dependencias:

pnpm install

3. Construir el proyecto:

pnpm run build

4. Configurar Claude Desktop

{
  "mcpServers": {
    "deepsource": {
      "command": "node",
      "args": [
        "/path/to/deepsource-mcp-server/dist/index.js"
      ],
      "env": {
        "DEEPSOURCE_API_KEY": "your-deepsource-api-key"
      }
    }
  }
}

Prerrequisitos

• Node.js 20 o superior

• pnpm 10.7.0 o superior

• Docker (para compilaciones de contenedores)

Guiones

• pnpm run build : compila el código TypeScript

• pnpm run start - Iniciar el servidor

• pnpm run dev - Inicia el servidor en modo de desarrollo

• pnpm run test - Ejecutar pruebas

• pnpm run lint - Ejecutar ESLint

• pnpm run format - Formatear código con Prettier

Solución de problemas

Habilitar el registro de depuración

Si tiene problemas, habilite el registro de depuración para ver información detallada:

1. Establezca la variable de entorno LOG_FILE en una ruta de archivo donde se deben escribir los registros

2. Establezca LOG_LEVEL en DEBUG (este es el valor predeterminado)

3. Consulte el archivo de registro para obtener información detallada del error

Ejemplo de configuración:

{
  "mcpServers": {
    "deepsource": {
      "command": "npx",
      "args": ["-y", "deepsource-mcp-server@1.1.0"],
      "env": {
        "DEEPSOURCE_API_KEY": "your-api-key",
        "LOG_FILE": "/tmp/deepsource-mcp.log",
        "LOG_LEVEL": "DEBUG"
      }
    }
  }
}

A continuación, compruebe el archivo de registro:

tail -f /tmp/deepsource-mcp.log

Problemas comunes

1. Error de autenticación : asegúrese de que su DEEPSOURCE_API_KEY sea correcta y tenga los permisos necesarios

2. No aparecen registros : verifique que la ruta LOG_FILE sea escribible y que el directorio principal exista

3. Errores de la herramienta : consulte el archivo de registro para obtener mensajes de error detallados y seguimientos de la pila

Licencia

Instituto Tecnológico de Massachusetts (MIT)