Star Report

Gener

Documentación

starReport

starReport es una herramienta Node.js para generar y gestionar automáticamente informes de actividad de repositorios de GitHub especificados, como estrellas, commits, issues, etc. Admite servicios de protocolo MCP, integra análisis inteligente de modelos grandes y puede enviar automáticamente informes a grupos de Feishu.

Características principales

  • Monitoreo de actividad de repositorios de GitHub: recopila automáticamente datos como el número de estrellas, commits e issues de repositorios especificados, con soporte para estadísticas diarias y semanales.
  • Envío automático de informes: puede enviar automáticamente informes diarios, semanales y resultados de análisis inteligente a grupos de Feishu para facilitar la sincronización del equipo.
  • Soporte de servicio MCP: proporciona capacidades de consulta de datos, generación de informes, análisis de IA y envío de mensajes a través del protocolo MCP (stdio), lo que facilita la integración en plataformas de automatización.
  • Análisis inteligente: integra modelos grandes (como OpenAI/Zhipu) para realizar análisis de tendencias, resúmenes y visualización de tablas de datos históricos, con soporte para análisis de preguntas personalizadas.
  • Análisis de transmisión en tiempo real SSE: admite el retorno en tiempo real de contenido de análisis inteligente a través de HTTP SSE, adecuado para la visualización en tiempo real en el frontend.
  • Preguntas y respuestas por Webhook: compatible con el webhook de Feishu, admite preguntas en chats de grupo y devuelve resultados de análisis inteligente.
  • Tareas programadas: incluye tareas programadas integradas que recopilan datos y envían informes automáticamente cada día/semana, sin intervención manual.
  • Configuración flexible: admite la especificación flexible de repositorios monitoreados, métodos de envío y parámetros de modelos grandes mediante variables de entorno y configuración de MCP.

Método de instalación

  1. Clonar el repositorio:
    git clone https://github.com/hu-qi/starReport.git
    
  2. Entrar al directorio del proyecto e instalar dependencias:
    cd starReport
    npm install
    

Instrucciones de uso

  1. Configurar variables de entorno: Copiar .env.example como .env y completar la configuración correspondiente según sea necesario.
  2. Ejecutar el proyecto:
    node index.js
    

Ejemplo de configuración del servidor MCP

Si necesita iniciar el servicio a través del protocolo MCP, consulte la siguiente configuración:

{
  "mcpServers": {
    "starReport-server": {
      "command": "npx",
      "args": [
        "-y",
        "star-report",
        "mcp-server"
      ],
      "env": {
        "GITHUB_TOKEN": "<你的 GitHub Token>",
        "FEISHU_WEBHOOK": "<你的飞书 Webhook>",
        "REPORT_REPOS": "<repo1,repo2,repo3>",
        "API_KEY": "<你的 API Key>",
        "API_BASE_URL": "<API Base URL>",
        "API_MODEL": "<模型名称>",
        "DATA_FILE":"<数据存放可读性的文件路径,如path/to/writable/directory/data.json>"
      }
    }
  }
}

Si se ejecuta localmente, reemplace command y args:

"command": "node",
"args": [
  "index.js",
  "mcp-server"
],
  • command: comando de inicio, generalmente npx.
  • : parámetros de línea de comandos, star-report mcp-server inicia el servicio MCP.
  • env: configuración de variables de entorno, debe completarse según la situación real.
    • GITHUB_TOKEN: token de acceso de GitHub.
    • FEISHU_WEBHOOK: webhook del robot de grupo de Feishu.
    • REPORT_REPOS: lista de repositorios de GitHub a monitorear, separados por comas.
    • API_KEY, API_BASE_URL, API_MODEL: configuración relacionada con modelos grandes.

No divulgue información sensible en lugares públicos.

Demostración de funciones

  • Herramientas MCP:

MCP 工具

  • Enumerar funciones:

func-list

  • Envío de mensajes a Feishu:

feishu-push

Licencia

Este proyecto está licenciado bajo la licencia MIT.