@kaddo/mcp 3.23.2 → 3.24.0

package/dist/index.js

@@ -2502,6 +2502,200 @@ function serializeImpactJson(r) {
   return JSON.stringify(r, null, 2) + "\n";
 }
 
+// ../cli/src/core/savings.ts
+import { parse as parseYaml6 } from "yaml";
+var DEFAULT_ASSUMPTIONS = {
+  currency: "USD",
+  hourly_cost: 40,
+  context_preparation_minutes_saved_per_work_item: 30,
+  rework_hours_avoided_per_resolved_drift: 2,
+  onboarding_hours_saved_per_new_contributor: 4,
+  review_minutes_saved_per_work_item_with_ownership: 20,
+  clarification_minutes_saved_per_ready_work_item: 25,
+  architecture_discovery_hours_saved_when_graph_good: 3,
+  expected_new_contributors_per_month: 1,
+  expected_work_items_per_month: 8
+};
+var SAVINGS_PATH = ".kaddo/savings.yml";
+function loadAssumptions(dir) {
+  const p = join(dir, SAVINGS_PATH);
+  if (!exists(p)) return { assumptions: { ...DEFAULT_ASSUMPTIONS }, source: "default" };
+  try {
+    const raw = parseYaml6(readFile(p));
+    const a = raw?.assumptions ?? {};
+    const t = raw?.team ?? {};
+    const num = (v, d) => typeof v === "number" && Number.isFinite(v) ? v : d;
+    return {
+      source: "file",
+      assumptions: {
+        currency: raw?.currency ?? DEFAULT_ASSUMPTIONS.currency,
+        hourly_cost: num(raw?.hourly_cost, DEFAULT_ASSUMPTIONS.hourly_cost),
+        context_preparation_minutes_saved_per_work_item: num(a.context_preparation_minutes_saved_per_work_item, DEFAULT_ASSUMPTIONS.context_preparation_minutes_saved_per_work_item),
+        rework_hours_avoided_per_resolved_drift: num(a.rework_hours_avoided_per_resolved_drift, DEFAULT_ASSUMPTIONS.rework_hours_avoided_per_resolved_drift),
+        onboarding_hours_saved_per_new_contributor: num(a.onboarding_hours_saved_per_new_contributor, DEFAULT_ASSUMPTIONS.onboarding_hours_saved_per_new_contributor),
+        review_minutes_saved_per_work_item_with_ownership: num(a.review_minutes_saved_per_work_item_with_ownership, DEFAULT_ASSUMPTIONS.review_minutes_saved_per_work_item_with_ownership),
+        clarification_minutes_saved_per_ready_work_item: num(a.clarification_minutes_saved_per_ready_work_item, DEFAULT_ASSUMPTIONS.clarification_minutes_saved_per_ready_work_item),
+        architecture_discovery_hours_saved_when_graph_good: num(a.architecture_discovery_hours_saved_when_graph_good, DEFAULT_ASSUMPTIONS.architecture_discovery_hours_saved_when_graph_good),
+        expected_new_contributors_per_month: num(t.expected_new_contributors_per_month, DEFAULT_ASSUMPTIONS.expected_new_contributors_per_month),
+        expected_work_items_per_month: num(t.expected_work_items_per_month, DEFAULT_ASSUMPTIONS.expected_work_items_per_month)
+      }
+    };
+  } catch {
+    return { assumptions: { ...DEFAULT_ASSUMPTIONS }, source: "default" };
+  }
+}
+var READINESS_MULT = { Low: 0.25, Medium: 0.5, High: 0.75, "Very High": 1 };
+var GRAPH_MULT = { empty: 0, sparse: 0.25, partial: 0.6, good: 1, unknown: 0 };
+var round2 = (n) => Math.round(n * 100) / 100;
+function parseRatioNumerator(s) {
+  const m = s.match(/^(\d+)/);
+  return m ? Number(m[1]) : 0;
+}
+var SAVINGS_DISCLAIMER = "These are evidence-based estimates, not exact ROI. Adjust assumptions with real team data.";
+function buildSavingsReport(dir, opts = {}, now = /* @__PURE__ */ new Date()) {
+  const { assumptions: a, source } = loadAssumptions(dir);
+  const impact = buildImpactReport(dir, { scope: opts.scope, scopeSource: opts.scopeSource }, now);
+  const completed = impact.traceability.completed_work_items;
+  const wiWithOwnership = parseRatioNumerator(impact.traceability.work_items_connected_to_code);
+  const acceptanceCov = impact.knowledge_coverage.find((c) => c.label.toLowerCase().includes("acceptance"));
+  const wiWithAcceptance = acceptanceCov?.have ?? 0;
+  const graphQuality = impact.graph_quality.available ? impact.graph_quality.quality : "unknown";
+  const readiness = impact.context_readiness.level;
+  const ctxPrepH = round2(completed * a.context_preparation_minutes_saved_per_work_item / 60);
+  const reviewH = round2(wiWithOwnership * a.review_minutes_saved_per_work_item_with_ownership / 60);
+  const clarH = round2(wiWithAcceptance * a.clarification_minutes_saved_per_ready_work_item / 60);
+  const readinessMult = READINESS_MULT[readiness] ?? 0.5;
+  const onboardH = round2(a.expected_new_contributors_per_month * a.onboarding_hours_saved_per_new_contributor * readinessMult);
+  const graphMult = GRAPH_MULT[graphQuality] ?? 0;
+  const archH = round2(a.architecture_discovery_hours_saved_when_graph_good * graphMult);
+  const totalHours = round2(ctxPrepH + reviewH + clarH + onboardH + archH);
+  const totalValue = Math.round(totalHours * a.hourly_cost);
+  const reasons = [];
+  let level;
+  if (impact.score === null || impact.score < 60 || graphQuality === "empty") {
+    level = "Low";
+    reasons.push("Impact score is low or the knowledge graph is empty.");
+  } else {
+    level = "Medium";
+    reasons.push("Strong knowledge and graph evidence.");
+  }
+  reasons.push("Guard history is not persisted yet \u2014 avoided rework is not estimated.");
+  reasons.push(source === "file" ? "Assumptions come from `.kaddo/savings.yml`." : "Savings assumptions are defaults and should be calibrated.");
+  const actions = [];
+  if (source === "default") actions.push("Run `kaddo savings init` to customize assumptions.");
+  actions.push("Calibrate hourly cost and team assumptions with real team data.");
+  actions.push("Run `kaddo impact` to verify the underlying evidence quality.");
+  actions.push("Use this report as directional evidence, not accounting data.");
+  actions.push("Future: persist Guard history to estimate avoided rework.");
+  return {
+    generated_at: now.toISOString(),
+    project: impact.project,
+    scope: impact.scope,
+    currency: a.currency,
+    disclaimer: SAVINGS_DISCLAIMER,
+    assumptions_source: source,
+    assumptions: {
+      hourly_cost: a.hourly_cost,
+      context_preparation_minutes_saved_per_work_item: a.context_preparation_minutes_saved_per_work_item,
+      review_minutes_saved_per_work_item_with_ownership: a.review_minutes_saved_per_work_item_with_ownership,
+      clarification_minutes_saved_per_ready_work_item: a.clarification_minutes_saved_per_ready_work_item,
+      onboarding_hours_saved_per_new_contributor: a.onboarding_hours_saved_per_new_contributor,
+      expected_new_contributors_per_month: a.expected_new_contributors_per_month,
+      architecture_discovery_hours_saved_when_graph_good: a.architecture_discovery_hours_saved_when_graph_good
+    },
+    evidence: {
+      knowledge_impact_score: impact.score,
+      completed_work_items: completed,
+      ownership_coverage_percent: impact.ownership_coverage.coverage_percent,
+      work_items_with_acceptance_criteria: acceptanceCov ? `${acceptanceCov.have}/${acceptanceCov.total}` : "0/0",
+      graph_quality: graphQuality,
+      graph_nodes: impact.graph_quality.available ? impact.graph_quality.nodes : null,
+      graph_edges: impact.graph_quality.available ? impact.graph_quality.edges : null,
+      context_readiness: readiness,
+      guard_history_available: false
+    },
+    estimated_savings: {
+      context_preparation: { hours: ctxPrepH, formula: `${completed} Work Items \xD7 ${a.context_preparation_minutes_saved_per_work_item} min` },
+      review_effort: { hours: reviewH, formula: `${wiWithOwnership} Work Items with ownership \xD7 ${a.review_minutes_saved_per_work_item_with_ownership} min` },
+      clarification_reduction: { hours: clarH, formula: `${wiWithAcceptance} Work Items with Acceptance Criteria \xD7 ${a.clarification_minutes_saved_per_ready_work_item} min` },
+      onboarding: { hours: onboardH, formula: `${a.expected_new_contributors_per_month} contributor \xD7 ${a.onboarding_hours_saved_per_new_contributor} h \xD7 ${readinessMult.toFixed(2)} readiness multiplier` },
+      architecture_discovery: { hours: archH, formula: `${a.architecture_discovery_hours_saved_when_graph_good} h \xD7 ${graphMult.toFixed(2)} graph multiplier` },
+      drift_prevention: { available: false, hours: 0, reason: "Guard history is not persisted yet." }
+    },
+    total: { estimated_hours_saved: totalHours, estimated_value: totalValue, currency: a.currency },
+    confidence: { level, reasons },
+    suggested_actions: actions
+  };
+}
+function renderSavingsMarkdown(r) {
+  const L = [];
+  L.push("# Kaddo Estimated Savings Report", "");
+  L.push(`Generated at: ${r.generated_at}`);
+  L.push(`Project: ${r.project}`);
+  L.push(`Scope: ${r.scope}`);
+  L.push(`Currency: ${r.currency}`);
+  L.push("");
+  L.push("## Disclaimer", "");
+  L.push(r.disclaimer, "");
+  L.push("## Executive Summary", "");
+  L.push(`- Estimated time saved: ${r.total.estimated_hours_saved} hours`);
+  L.push(`- Estimated value: ${r.total.estimated_value} ${r.currency}`);
+  L.push(`- Confidence: ${r.confidence.level}`);
+  if (r.assumptions_source === "default") L.push("- Using default assumptions. Run `kaddo savings init` to customize them.");
+  L.push("");
+  L.push("## Assumptions", "");
+  L.push(`- Hourly cost: ${r.assumptions.hourly_cost} ${r.currency}`);
+  L.push(`- Context preparation saved per Work Item: ${r.assumptions.context_preparation_minutes_saved_per_work_item} min`);
+  L.push(`- Review saved per Work Item with ownership: ${r.assumptions.review_minutes_saved_per_work_item_with_ownership} min`);
+  L.push(`- Clarification saved per Work Item with acceptance criteria: ${r.assumptions.clarification_minutes_saved_per_ready_work_item} min`);
+  L.push(`- Onboarding saved per new contributor: ${r.assumptions.onboarding_hours_saved_per_new_contributor} h`);
+  L.push(`- Expected new contributors per month: ${r.assumptions.expected_new_contributors_per_month}`);
+  L.push(`- Architecture discovery saved when graph is good: ${r.assumptions.architecture_discovery_hours_saved_when_graph_good} h`);
+  L.push("");
+  L.push("## Evidence Used", "");
+  const e = r.evidence;
+  L.push(`- Knowledge Impact Score: ${e.knowledge_impact_score ?? "not available"}${e.knowledge_impact_score !== null ? "/100" : ""}`);
+  L.push(`- Completed Work Items: ${e.completed_work_items}`);
+  L.push(`- Ownership coverage: ${e.ownership_coverage_percent}%`);
+  L.push(`- Work Items with Acceptance Criteria: ${e.work_items_with_acceptance_criteria}`);
+  L.push(`- Graph quality: ${e.graph_quality}`);
+  if (e.graph_nodes !== null) L.push(`- Graph nodes: ${e.graph_nodes}`);
+  if (e.graph_edges !== null) L.push(`- Graph edges: ${e.graph_edges}`);
+  L.push(`- Context readiness: ${e.context_readiness}`);
+  L.push("- Guard history: not available");
+  L.push("");
+  L.push("## Estimated Savings", "");
+  const s = r.estimated_savings;
+  const line = (title, l) => {
+    L.push(`### ${title}`, "");
+    L.push(`- Formula: ${l.formula}`);
+    L.push(`- Estimated: ${l.hours} h`, "");
+  };
+  line("Context Preparation", s.context_preparation);
+  line("Review Effort", s.review_effort);
+  line("Clarification Reduction", s.clarification_reduction);
+  line("Onboarding", s.onboarding);
+  line("Architecture Discovery", s.architecture_discovery);
+  L.push("### Drift Prevention", "");
+  L.push("- Not available yet.");
+  L.push(`- Reason: ${s.drift_prevention.reason}`, "");
+  L.push("## Total", "");
+  L.push(`- Estimated time saved: ${r.total.estimated_hours_saved} h`);
+  L.push(`- Estimated value: ${r.total.estimated_value} ${r.currency}`);
+  L.push("");
+  L.push("## Confidence", "");
+  L.push(`Confidence: ${r.confidence.level}`, "", "Reason:");
+  for (const reason of r.confidence.reasons) L.push(`- ${reason}`);
+  L.push("");
+  L.push("## Suggested Actions", "");
+  r.suggested_actions.forEach((act, i) => L.push(`${i + 1}. ${act}`));
+  L.push("");
+  return L.join("\n");
+}
+function serializeSavingsJson(r) {
+  return JSON.stringify(r, null, 2) + "\n";
+}
+
 // src/workitems.ts
 import matter7 from "gray-matter";
 var ACTIVE_STATES2 = /* @__PURE__ */ new Set(["draft", "ready", "in-progress", "blocked"]);
@@ -2714,6 +2908,20 @@ var RESOURCES = [
       }
       return [{ uri: "kaddo://impact-report", text: renderImpactMarkdown(buildImpactReport(root, { scope: "all", scopeSource: "default" })), mimeType: "text/markdown" }];
     }
+  },
+  {
+    uri: "kaddo://savings-report",
+    name: "Kaddo savings report",
+    description: "Estimated Savings Report \u2014 the last written report, or generated in memory (read-only).",
+    mimeType: "text/markdown",
+    read: (root) => {
+      const saved = readText(root, ".kaddo/reports/savings-report.md");
+      if (saved) return [{ uri: "kaddo://savings-report", text: saved, mimeType: "text/markdown" }];
+      if (!hasKnowledge(root)) {
+        return text("kaddo://savings-report", "Knowledge repository not found. Run `kaddo bootstrap` first.", "text/plain");
+      }
+      return [{ uri: "kaddo://savings-report", text: renderSavingsMarkdown(buildSavingsReport(root, { scope: "all", scopeSource: "default" })), mimeType: "text/markdown" }];
+    }
   }
 ];
 
@@ -3492,6 +3700,22 @@ function generateImpactReport(root, opts = {}) {
     next_suggested_resources: ["kaddo://impact-report"]
   };
 }
+function generateSavingsReport(root, opts = {}) {
+  requireConfig(root);
+  requireKnowledge(root);
+  const format = opts.format ?? "markdown";
+  const report = buildSavingsReport(root, { scope: opts.scope ?? "all", scopeSource: opts.scope ? "explicit" : "default" });
+  const content = format === "json" ? serializeSavingsJson(report) : renderSavingsMarkdown(report);
+  const out = opts.output ?? `.kaddo/reports/savings-report.${format === "json" ? "json" : "md"}`;
+  writeDerived(root, out, content);
+  return {
+    status: "ok",
+    files_written: [out.replace(/\\/g, "/")],
+    summary: `Savings report generated (${format}, ${report.scope} scope, ~${report.total.estimated_hours_saved}h).`,
+    warnings: report.assumptions_source === "default" ? ["Using default assumptions \u2014 run `kaddo savings init` to calibrate."] : [],
+    next_suggested_resources: ["kaddo://savings-report"]
+  };
+}
 function generateCapsuleDraft(root) {
   const config = requireConfig(root);
   requireKnowledge(root);
@@ -3692,6 +3916,23 @@ function createServer(root) {
       () => generateImpactReport(root, { format: args.format, scope: args.scope, output: args.output })
     )
   );
+  server.registerTool(
+    "kaddo_generate_savings_report",
+    {
+      title: "Generate savings report",
+      description: `Write the Estimated Savings Report under .kaddo/reports/. format: markdown (default) or json; scope: active or all (default all). Evidence-based estimates, not exact ROI. ${DERIVED_NOTE}`,
+      inputSchema: {
+        format: z2.enum(["markdown", "json"]).optional(),
+        scope: z2.enum(["active", "all"]).optional(),
+        output: z2.string().optional()
+      }
+    },
+    async (args) => generated(
+      root,
+      "generate savings report",
+      () => generateSavingsReport(root, { format: args.format, scope: args.scope, output: args.output })
+    )
+  );
   server.registerTool(
     "kaddo_generate_capsule_draft",
     { title: "Generate capsule draft", description: `Write a capsule DRAFT under .kaddo/exports/ (never registers it). ${DERIVED_NOTE}`, inputSchema: {} },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kaddo/mcp",
-  "version": "3.23.2",
+  "version": "3.24.0",
   "description": "MCP server for Kaddo project knowledge: read-only resources/tools/prompts plus safe derived generation under .kaddo/.",
   "license": "MIT",
   "repository": {