|
| 1 | +// ============================================================================= |
| 2 | +// export_report — Generate markdown session reports from timeline data |
| 3 | +// Closes #5: Export timeline to markdown/PDF reports |
| 4 | +// ============================================================================= |
| 5 | + |
| 6 | +import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; |
| 7 | +import { z } from "zod"; |
| 8 | +import { getTimeline, listIndexedProjects } from "../lib/timeline-db.js"; |
| 9 | +import { getRelatedProjects } from "../lib/config.js"; |
| 10 | +import { writeFile, mkdir } from "node:fs/promises"; |
| 11 | +import { join, basename } from "node:path"; |
| 12 | +import { homedir } from "node:os"; |
| 13 | +import type { SearchScope } from "../types.js"; |
| 14 | + |
| 15 | +// ── Types ────────────────────────────────────────────────────────────────── |
| 16 | + |
| 17 | +interface DaySummary { |
| 18 | + date: string; |
| 19 | + prompts: number; |
| 20 | + assistantReplies: number; |
| 21 | + toolCalls: number; |
| 22 | + commits: number; |
| 23 | + corrections: number; |
| 24 | + errors: number; |
| 25 | + compactions: number; |
| 26 | + subAgentSpawns: number; |
| 27 | + topTools: Map<string, number>; |
| 28 | +} |
| 29 | + |
| 30 | +interface ReportData { |
| 31 | + project: string; |
| 32 | + period: string; |
| 33 | + since: string; |
| 34 | + until: string; |
| 35 | + totalEvents: number; |
| 36 | + days: DaySummary[]; |
| 37 | + eventsByType: Map<string, number>; |
| 38 | +} |
| 39 | + |
| 40 | +// ── Helpers ──────────────────────────────────────────────────────────────── |
| 41 | + |
| 42 | +function parseRelativeDate(input: string): string { |
| 43 | + const match = input.match(/^(\d+)(days?|weeks?|months?|years?)$/); |
| 44 | + if (!match) return input; |
| 45 | + const [, numStr, unit] = match; |
| 46 | + const num = parseInt(numStr, 10); |
| 47 | + const d = new Date(); |
| 48 | + if (unit.startsWith("day")) d.setDate(d.getDate() - num); |
| 49 | + else if (unit.startsWith("week")) d.setDate(d.getDate() - num * 7); |
| 50 | + else if (unit.startsWith("month")) d.setMonth(d.getMonth() - num); |
| 51 | + else if (unit.startsWith("year")) d.setFullYear(d.getFullYear() - num); |
| 52 | + return d.toISOString(); |
| 53 | +} |
| 54 | + |
| 55 | +async function getSearchProjects(scope: SearchScope): Promise<string[]> { |
| 56 | + const currentProject = process.env.CLAUDE_PROJECT_DIR; |
| 57 | + switch (scope) { |
| 58 | + case "current": |
| 59 | + return currentProject ? [currentProject] : []; |
| 60 | + case "related": { |
| 61 | + const related = getRelatedProjects(); |
| 62 | + return currentProject ? [currentProject, ...related] : related; |
| 63 | + } |
| 64 | + case "all": { |
| 65 | + const projects = await listIndexedProjects(); |
| 66 | + return projects.map((p) => p.project); |
| 67 | + } |
| 68 | + default: |
| 69 | + return currentProject ? [currentProject] : []; |
| 70 | + } |
| 71 | +} |
| 72 | + |
| 73 | +function buildDaySummaries(events: any[]): DaySummary[] { |
| 74 | + const days = new Map<string, DaySummary>(); |
| 75 | + |
| 76 | + for (const event of events) { |
| 77 | + const date = event.timestamp |
| 78 | + ? new Date(event.timestamp).toISOString().slice(0, 10) |
| 79 | + : "unknown"; |
| 80 | + |
| 81 | + if (!days.has(date)) { |
| 82 | + days.set(date, { |
| 83 | + date, |
| 84 | + prompts: 0, |
| 85 | + assistantReplies: 0, |
| 86 | + toolCalls: 0, |
| 87 | + commits: 0, |
| 88 | + corrections: 0, |
| 89 | + errors: 0, |
| 90 | + compactions: 0, |
| 91 | + subAgentSpawns: 0, |
| 92 | + topTools: new Map(), |
| 93 | + }); |
| 94 | + } |
| 95 | + |
| 96 | + const day = days.get(date)!; |
| 97 | + switch (event.type) { |
| 98 | + case "prompt": |
| 99 | + day.prompts++; |
| 100 | + break; |
| 101 | + case "assistant": |
| 102 | + day.assistantReplies++; |
| 103 | + break; |
| 104 | + case "tool_call": |
| 105 | + day.toolCalls++; |
| 106 | + if (event.tool_name) { |
| 107 | + day.topTools.set( |
| 108 | + event.tool_name, |
| 109 | + (day.topTools.get(event.tool_name) || 0) + 1, |
| 110 | + ); |
| 111 | + } |
| 112 | + break; |
| 113 | + case "commit": |
| 114 | + day.commits++; |
| 115 | + break; |
| 116 | + case "correction": |
| 117 | + day.corrections++; |
| 118 | + break; |
| 119 | + case "error": |
| 120 | + day.errors++; |
| 121 | + break; |
| 122 | + case "compaction": |
| 123 | + day.compactions++; |
| 124 | + break; |
| 125 | + case "sub_agent_spawn": |
| 126 | + day.subAgentSpawns++; |
| 127 | + break; |
| 128 | + } |
| 129 | + } |
| 130 | + |
| 131 | + return [...days.values()].sort((a, b) => a.date.localeCompare(b.date)); |
| 132 | +} |
| 133 | + |
| 134 | +function renderMarkdown(data: ReportData): string { |
| 135 | + const lines: string[] = []; |
| 136 | + |
| 137 | + lines.push(`# Session Report: ${data.project}`); |
| 138 | + lines.push(""); |
| 139 | + lines.push(`**Period:** ${data.since.slice(0, 10)} → ${data.until.slice(0, 10)}`); |
| 140 | + lines.push(`**Total Events:** ${data.totalEvents}`); |
| 141 | + lines.push(`**Days Active:** ${data.days.length}`); |
| 142 | + lines.push(""); |
| 143 | + |
| 144 | + // Overview table |
| 145 | + lines.push("## Summary"); |
| 146 | + lines.push(""); |
| 147 | + lines.push("| Metric | Count |"); |
| 148 | + lines.push("|--------|------:|"); |
| 149 | + |
| 150 | + const totals = { |
| 151 | + prompts: 0, |
| 152 | + assistantReplies: 0, |
| 153 | + toolCalls: 0, |
| 154 | + commits: 0, |
| 155 | + corrections: 0, |
| 156 | + errors: 0, |
| 157 | + compactions: 0, |
| 158 | + subAgentSpawns: 0, |
| 159 | + }; |
| 160 | + |
| 161 | + for (const day of data.days) { |
| 162 | + totals.prompts += day.prompts; |
| 163 | + totals.assistantReplies += day.assistantReplies; |
| 164 | + totals.toolCalls += day.toolCalls; |
| 165 | + totals.commits += day.commits; |
| 166 | + totals.corrections += day.corrections; |
| 167 | + totals.errors += day.errors; |
| 168 | + totals.compactions += day.compactions; |
| 169 | + totals.subAgentSpawns += day.subAgentSpawns; |
| 170 | + } |
| 171 | + |
| 172 | + lines.push(`| 💬 Prompts | ${totals.prompts} |`); |
| 173 | + lines.push(`| 🤖 Responses | ${totals.assistantReplies} |`); |
| 174 | + lines.push(`| 🔧 Tool Calls | ${totals.toolCalls} |`); |
| 175 | + lines.push(`| 📦 Commits | ${totals.commits} |`); |
| 176 | + lines.push(`| ❌ Corrections | ${totals.corrections} |`); |
| 177 | + lines.push(`| ⚠️ Errors | ${totals.errors} |`); |
| 178 | + lines.push(`| 🗜️ Compactions | ${totals.compactions} |`); |
| 179 | + lines.push(`| 🚀 Sub-agents | ${totals.subAgentSpawns} |`); |
| 180 | + lines.push(""); |
| 181 | + |
| 182 | + // Quality indicators |
| 183 | + if (totals.prompts > 0) { |
| 184 | + const correctionRate = ((totals.corrections / totals.prompts) * 100).toFixed(1); |
| 185 | + const errorRate = ((totals.errors / totals.prompts) * 100).toFixed(1); |
| 186 | + const toolsPerPrompt = (totals.toolCalls / totals.prompts).toFixed(1); |
| 187 | + |
| 188 | + lines.push("## Quality Indicators"); |
| 189 | + lines.push(""); |
| 190 | + lines.push(`- **Correction rate:** ${correctionRate}% of prompts needed corrections`); |
| 191 | + lines.push(`- **Error rate:** ${errorRate}% of prompts produced errors`); |
| 192 | + lines.push(`- **Tool density:** ${toolsPerPrompt} tool calls per prompt`); |
| 193 | + if (totals.commits > 0) { |
| 194 | + const promptsPerCommit = (totals.prompts / totals.commits).toFixed(1); |
| 195 | + lines.push(`- **Prompts per commit:** ${promptsPerCommit}`); |
| 196 | + } |
| 197 | + lines.push(""); |
| 198 | + } |
| 199 | + |
| 200 | + // Daily breakdown |
| 201 | + lines.push("## Daily Breakdown"); |
| 202 | + lines.push(""); |
| 203 | + lines.push("| Date | 💬 | 🔧 | 📦 | ❌ | ⚠️ |"); |
| 204 | + lines.push("|------|---:|---:|---:|---:|---:|"); |
| 205 | + |
| 206 | + for (const day of data.days) { |
| 207 | + lines.push( |
| 208 | + `| ${day.date} | ${day.prompts} | ${day.toolCalls} | ${day.commits} | ${day.corrections} | ${day.errors} |`, |
| 209 | + ); |
| 210 | + } |
| 211 | + lines.push(""); |
| 212 | + |
| 213 | + // Top tools across all days |
| 214 | + const allTools = new Map<string, number>(); |
| 215 | + for (const day of data.days) { |
| 216 | + for (const [tool, count] of day.topTools) { |
| 217 | + allTools.set(tool, (allTools.get(tool) || 0) + count); |
| 218 | + } |
| 219 | + } |
| 220 | + |
| 221 | + if (allTools.size > 0) { |
| 222 | + lines.push("## Most Used Tools"); |
| 223 | + lines.push(""); |
| 224 | + const sorted = [...allTools.entries()].sort((a, b) => b[1] - a[1]).slice(0, 10); |
| 225 | + for (const [tool, count] of sorted) { |
| 226 | + lines.push(`- **${tool}**: ${count} calls`); |
| 227 | + } |
| 228 | + lines.push(""); |
| 229 | + } |
| 230 | + |
| 231 | + // Activity sparkline (simple text-based) |
| 232 | + if (data.days.length > 1) { |
| 233 | + lines.push("## Activity Trend"); |
| 234 | + lines.push(""); |
| 235 | + const maxPrompts = Math.max(...data.days.map((d) => d.prompts), 1); |
| 236 | + const bars = ["▁", "▂", "▃", "▄", "▅", "▆", "▇", "█"]; |
| 237 | + const sparkline = data.days |
| 238 | + .map((d) => { |
| 239 | + const idx = Math.round((d.prompts / maxPrompts) * (bars.length - 1)); |
| 240 | + return bars[idx]; |
| 241 | + }) |
| 242 | + .join(""); |
| 243 | + lines.push(`\`${sparkline}\` (${data.days[0].date} → ${data.days[data.days.length - 1].date})`); |
| 244 | + lines.push(""); |
| 245 | + } |
| 246 | + |
| 247 | + lines.push("---"); |
| 248 | + lines.push(`_Generated by preflight export_report on ${new Date().toISOString().slice(0, 10)}_`); |
| 249 | + |
| 250 | + return lines.join("\n"); |
| 251 | +} |
| 252 | + |
| 253 | +// ── Tool Registration ────────────────────────────────────────────────────── |
| 254 | + |
| 255 | +export function registerExportReport(server: McpServer) { |
| 256 | + server.tool( |
| 257 | + "export_report", |
| 258 | + "Generate a markdown session report from timeline data. Summarizes activity, quality metrics, tool usage, and daily trends for a project over a time period.", |
| 259 | + { |
| 260 | + scope: z |
| 261 | + .enum(["current", "related", "all"]) |
| 262 | + .default("current") |
| 263 | + .describe("Search scope"), |
| 264 | + project: z.string().optional().describe("Filter to a specific project (overrides scope)"), |
| 265 | + since: z |
| 266 | + .string() |
| 267 | + .default("1week") |
| 268 | + .describe("Start date (ISO or relative like '1week', '30days')"), |
| 269 | + until: z.string().optional().describe("End date (ISO or relative)"), |
| 270 | + save: z |
| 271 | + .boolean() |
| 272 | + .default(false) |
| 273 | + .describe("Save report to ~/.preflight/reports/"), |
| 274 | + }, |
| 275 | + async (params) => { |
| 276 | + const since = parseRelativeDate(params.since); |
| 277 | + const until = params.until ? parseRelativeDate(params.until) : new Date().toISOString(); |
| 278 | + |
| 279 | + let projectDirs: string[]; |
| 280 | + if (params.project) { |
| 281 | + projectDirs = [params.project]; |
| 282 | + } else { |
| 283 | + projectDirs = await getSearchProjects(params.scope); |
| 284 | + } |
| 285 | + |
| 286 | + if (projectDirs.length === 0) { |
| 287 | + return { |
| 288 | + content: [ |
| 289 | + { |
| 290 | + type: "text", |
| 291 | + text: `No projects found for scope "${params.scope}". Set CLAUDE_PROJECT_DIR or onboard a project first.`, |
| 292 | + }, |
| 293 | + ], |
| 294 | + }; |
| 295 | + } |
| 296 | + |
| 297 | + // Fetch all events in the period (high limit for reports) |
| 298 | + const events = await getTimeline({ |
| 299 | + project_dirs: projectDirs, |
| 300 | + since, |
| 301 | + until, |
| 302 | + limit: 10000, |
| 303 | + }); |
| 304 | + |
| 305 | + if (events.length === 0) { |
| 306 | + return { |
| 307 | + content: [ |
| 308 | + { |
| 309 | + type: "text", |
| 310 | + text: "No events found for the given period. Try a wider date range or different scope.", |
| 311 | + }, |
| 312 | + ], |
| 313 | + }; |
| 314 | + } |
| 315 | + |
| 316 | + const projectName = |
| 317 | + params.project |
| 318 | + ? basename(params.project) |
| 319 | + : projectDirs.length === 1 |
| 320 | + ? basename(projectDirs[0]) |
| 321 | + : `${projectDirs.length} projects`; |
| 322 | + |
| 323 | + const days = buildDaySummaries(events); |
| 324 | + |
| 325 | + const reportData: ReportData = { |
| 326 | + project: projectName, |
| 327 | + period: `${since.slice(0, 10)} to ${until.slice(0, 10)}`, |
| 328 | + since, |
| 329 | + until, |
| 330 | + totalEvents: events.length, |
| 331 | + days, |
| 332 | + eventsByType: new Map(), |
| 333 | + }; |
| 334 | + |
| 335 | + for (const event of events) { |
| 336 | + reportData.eventsByType.set( |
| 337 | + event.type, |
| 338 | + (reportData.eventsByType.get(event.type) || 0) + 1, |
| 339 | + ); |
| 340 | + } |
| 341 | + |
| 342 | + const markdown = renderMarkdown(reportData); |
| 343 | + |
| 344 | + // Optionally save to file |
| 345 | + if (params.save) { |
| 346 | + const reportsDir = join(homedir(), ".preflight", "reports"); |
| 347 | + await mkdir(reportsDir, { recursive: true }); |
| 348 | + const filename = `report-${projectName}-${since.slice(0, 10)}-to-${until.slice(0, 10)}.md`; |
| 349 | + const filePath = join(reportsDir, filename); |
| 350 | + await writeFile(filePath, markdown, "utf-8"); |
| 351 | + |
| 352 | + return { |
| 353 | + content: [ |
| 354 | + { type: "text", text: markdown }, |
| 355 | + { type: "text", text: `\n\n📄 Saved to: ${filePath}` }, |
| 356 | + ], |
| 357 | + }; |
| 358 | + } |
| 359 | + |
| 360 | + return { content: [{ type: "text", text: markdown }] }; |
| 361 | + }, |
| 362 | + ); |
| 363 | +} |
0 commit comments