generate_report

Instructions

Implementation Reference

• tools/report.py:188-221 (handler)

  The main handler function 'generate_report' that accepts analysis_json (JSON string from analyze_code/analyze_file), optional output_path, and optional source_name. Parses the JSON, builds an HTML report via build_html(), optionally saves to disk, and returns JSON with 'html', 'saved_to', and 'length' fields.

  async def generate_report(
      analysis_json: str,
      output_path: str = "",
      source_name: str = "",
  ) -> str:
      """
      Generates a beautiful HTML report from analyze_code or analyze_file results.
  
      Args:
          analysis_json: JSON string from analyze_code or analyze_file.
          output_path:   Path to save the HTML file (optional).
          source_name:   File/fragment name for the report title.
  
      Returns:
          JSON with fields: html, saved_to, length.
      """
      try:
          data = json.loads(analysis_json)
      except json.JSONDecodeError as e:
          return error_response("Invalid JSON in analysis_json", str(e))
  
      html     = build_html(data, source_name=source_name)
      saved_to = ""
  
      if output_path:
          out = Path(output_path).expanduser().resolve()
          try:
              out.parent.mkdir(parents=True, exist_ok=True)
              out.write_text(html, encoding="utf-8")
              saved_to = str(out)
          except OSError as e:
              return error_response("Failed to save file", str(e))
  
      return json.dumps({"html": html, "saved_to": saved_to, "length": len(html)}, ensure_ascii=False)

• tools/report.py:188-192 (schema)

  Input schema for generate_report: analysis_json (str, required), output_path (str, optional), source_name (str, optional). The return type is str (JSON string with html, saved_to, length fields).

  async def generate_report(
      analysis_json: str,
      output_path: str = "",
      source_name: str = "",
  ) -> str:

• tools/report.py:126-185 (helper)

  build_html() is the core helper that constructs the full HTML report from the analysis data dictionary. It produces a styled document with a header (score ring, verdict, metadata), severity pill counters, and sections for issues, warnings, and suggestions.

  def build_html(data: dict, source_name: str = "") -> str:
      score       = data.get("score", 0)
      summary     = data.get("summary", "")
      issues      = data.get("issues", [])
      warnings    = data.get("warnings", [])
      suggestions = data.get("suggestions", [])
      stats       = data.get("stats", {})
      filename    = data.get("file", source_name)
      lang        = data.get("language", "")
      lines       = data.get("lines", "")
  
      meta = "".join([
          f'<span><b>{filename}</b></span>' if filename else "",
          f'<span>Language: <b>{lang}</b></span>' if lang else "",
          f'<span>Lines: <b>{lines}</b></span>' if lines else "",
      ])
  
      header = (
          f'<div class="header">'
          f'<h1>Code Sanitizer <span>Report</span></h1>'
          f'<div class="meta">{meta}</div>'
          f'<div class="score-row">'
          f'{_ring(score)}'
          f'<div class="verdict"><b>Verdict:</b> {summary}</div>'
          f'</div></div>'
      )
  
      pills = "".join(
          f'<div class="pill {s}"><div class="n">{stats.get(s, 0)}</div><div class="l">{s}</div></div>'
          for s in _SEVERITY_ORDER
      ) if stats else ""
  
      sorted_issues = sorted(issues, key=lambda x: _SEVERITY_ORDER.index(x.get("severity", "low")))
      issues_html   = "".join(_issue_card(i) for i in sorted_issues) or '<div class="empty">No issues found</div>'
      warns_html    = "".join(
          f'<div class="warn"><div class="warn-title">{w.get("title","")}</div>'
          f'<div class="warn-desc">{w.get("description","")}</div></div>'
          for w in warnings
      ) or '<div class="empty">No warnings</div>'
      sugs_html = "".join(
          f'<div class="sug"><div class="sug-text">{s}</div></div>'
          for s in suggestions
      ) or '<div class="empty">No suggestions</div>'
  
      body = (
          header
          + (f'<div class="pills">{pills}</div>' if pills else "")
          + _section("🔴", "Issues", issues_html, len(issues))
          + _section("⚠️", "Warnings", warns_html, len(warnings))
          + _section("💡", "Suggestions", sugs_html, len(suggestions))
          + '<div class="footer">Generated by <b>mcp-code-sanitizer</b> · Powered by Groq</div>'
      )
  
      return (
          f'<!DOCTYPE html><html lang="en"><head>'
          f'<meta charset="UTF-8"><meta name="viewport" content="width=device-width,initial-scale=1">'
          f'<title>Code Sanitizer — {filename or "Report"}</title>'
          f'<style>{_CSS}</style></head>'
          f'<body><div class="wrap">{body}</div></body></html>'
      )

• server.py:36-36 (registration)

  Registration of generate_report as an MCP tool via mcp.tool()(generate_report) on the FastMCP server instance 'code-sanitizer'.

  mcp.tool()(generate_report)

• tools/__init__.py:7-7 (registration)

  Export of generate_report from the tools package, imported from tools.report module.

  from .report    import generate_report