Skip to content

Show tool authority summary in Markdown overview reports #211

@luoyuctl

Description

@luoyuctl

Background

#210 made exported HTML overview reports show the existing tool authority evidence from the overview payload. Markdown overview reports are another shareable/report artifact, especially for CI summaries and docs command output, but they still do not expose the same authority summary.

Evidence

Validated on master 57dd9d7 after #210:

  • agenttrace --demo --overview -f html -o /tmp/agenttrace-master-overview.html renders Tool authority, Highest category, Authority category counts, test_or_build, and High-authority tools.
  • agenttrace --demo --overview -f markdown renders metrics, Incident timeline, By agent, Recent sessions, and Recent anomalies, but no visible tool authority / authority category summary.
  • Existing JSON overview data already contains the authority fields, so this is a readable report-format gap rather than a classification gap.
  • check-docs-commands.sh writes Markdown and HTML docs artifacts; Markdown artifacts currently cannot carry the same authority evidence that HTML now carries.

User value

A user sharing or archiving Markdown reports should be able to answer whether a run touched higher-authority tools without switching to JSON or HTML. This matters for CI comments, issue handoffs, and text-first workflows where Markdown is the preferred artifact.

Adoption rationale

Report formats should tell a consistent product story: local session health, incident timeline, and tool authority are all readable from exported artifacts. Keeping Markdown behind HTML makes the feature feel uneven and weakens CI/documentation reuse.

Suggested scope

Add a concise Tool authority section to agenttrace --overview -f markdown, using the same existing authority summary data already used by HTML.

A minimal Markdown shape is enough:

  • highest authority category;
  • authority category counts;
  • high-authority tools, when present.

Add or extend a repeatable check so demo Markdown output cannot silently drop this summary again.

Non-goals

  • Do not change authority classification rules.
  • Do not change JSON field names or existing JSON contracts.
  • Do not add hosted telemetry, upload, or external sharing behavior.
  • Do not change release, package, npm, Homebrew, or public site surfaces.
  • Do not expand this into full text/TUI parity unless that falls out naturally with low risk.

Acceptance criteria

  • agenttrace --demo --overview -f markdown includes a visible tool authority summary when authority data exists.
  • Existing HTML authority output from [Impl] Show tool authority summary in HTML overview reports #210 remains intact.
  • JSON overview output remains compatible with existing authority fields.
  • A CI/script check covers the Markdown authority summary.
  • go test ./..., go build, scripts/ci/check-report-semantics.sh, and relevant output/docs checks pass if touched.
  • Copy remains local-first and does not imply uploaded logs or hosted tracing.

Suggested lane

lane/product, with Quality help for the regression check if useful.

Risk

Low to medium-low. The data already exists and HTML now renders it, but Markdown formatting should stay compact and not make CI/report artifacts noisy.

Source

Product dogfood after #210 on master 57dd9d7.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions