关键词

GitHub 数据监控数据分析实时分析自动报告飞书推送

使用说明内容（Markdown格式）

  • 项目简介 StarReport 是一个基于模型上下文协议（MCP）的后端服务，旨在向 LLM 客户端以标准化方式提供资源、工具和提示模板，并通过日常任务与 AI 分析实现对指定 GitHub 仓库的活跃度监控、报告生成以及消息推送等能力。实现了 stdio、SSE 等传输方式的 MCP 服务，以及一个用于实时分析的 HTTP 服务入口，并支持对接飞书群进行通知。

  • 主要功能点

    • 通过 MCP 协议托管 Resources、Tools、Prompts，允许客户端查询和执行
    • 日报/周报定时任务：自动抓取指定仓库的 Stars、Commits、Issues 等指标并生成报告
    • AI 智能分析：基于历史数据进行趋势分析、洞察提取与可执行建议
    • 实时流式分析：SSE 端点实现实时分析输出
    • Webhook 接入：支持 Feishu 等 webhook 的查询与分析触发
    • 通过飞书推送分析结果和报告

  • 安装步骤

    1. 克隆仓库并安装依赖
      • 运行 npm install
    2. 配置环境变量
      • 需要设置 GITHUB_TOKEN、FEISHU_WEBHOOK、REPORT_REPOS、API_KEY、API_BASE_URL、API_MODEL、DATA_FILE 等，具体含义与示例请参阅仓库 README 的说明
    3. 启动方式（多种任务模式任选其一）
      • 日报/每日任务：node index.js daily
      • 周报任务：node index.js weekly
      • 交互分析：node index.js analysis
      • MCP 服务（stdio 连接）：node index.js mcp-server
      • 实时分析 HTTP 服务（SSE）：node index.js sse-server

  • 服务器配置（MCP 客户端需要的最小配置信息，JSON 形式，包含 server name、command、args、env 等；请据仓库信息生成准确的配置信息及参数注释，勿直接显示代码） 配置示例（文本描述）： { "mcpServers": { "starReport-server": { "name": "starReport-mcp-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": "<数据存放路径>" } } } }

  • 基本使用方法

    • 运行前请确保环境变量正确配置，特别是 GitHub 访问令牌和飞书 webhook
    • 通过 MCP 客户端链接 starReport 的 mcp-server（stdio 模式）或使用 SSE 端点进行实时分析
    • 使用 daily/weekly/analysis 任务类型进行数据采集与分析；mcp-server 模式会启动 MCP 服务，供客户端调用工具、获取数据、触发分析
    • 如需实时分析，请访问 /mcp-sse 获取流式分析输出；/feishu-webhook 可接收来自 Feishu 的问题并返回分析结果

  • 运行与维护要点

    • 数据存储：默认在当前目录 data.json，若文件系统只读将回退至内存存储
    • 定时任务：每日生成日报、每周生成周报（可按需要启用/禁用）
    • 安全提示：请不要在公开场合暴露敏感密钥与令牌

信息

分类

AI与计算

访问项目