Interface: Finding
A single review finding. All three text fields (title, detail, recommendation) are required. Info-severity items whose recommendation is a no-op should still…
Defined in: packages/bitbadgesjs-sdk/src/core/review-types.ts:30
A single review finding. All three text fields (title, detail,
recommendation) are required. Info-severity items whose recommendation
is a no-op should still populate it with something like
"No action required — surfaced for visibility."
Properties
agentOnly?
optionalagentOnly?:boolean
Defined in: packages/bitbadgesjs-sdk/src/core/review-types.ts:50
Agent-only escape hatch. When true, the finding is hidden from
human consumers (frontend sidebar) but surfaced to agents
(CLI / indexer / MCP). Default is false / absent — everyone sees
the finding. Use sparingly for items that are genuinely
agent-internal (e.g. meta-level tool feedback).
category
category:
string
Defined in: packages/bitbadgesjs-sdk/src/core/review-types.ts:36
Free-form grouping label (e.g. approvals, metadata, diff).
code
code:
string
Defined in: packages/bitbadgesjs-sdk/src/core/review-types.ts:32
Stable machine identifier, e.g. review.ux.forceful_transfers_allowed.
detail
detail:
Localized
Defined in: packages/bitbadgesjs-sdk/src/core/review-types.ts:40
Full explanation — the "why it matters" paragraph.
recommendation
recommendation:
Localized
Defined in: packages/bitbadgesjs-sdk/src/core/review-types.ts:42
How to fix it. Always populated.
severity
severity:
Severity
Defined in: packages/bitbadgesjs-sdk/src/core/review-types.ts:33
source
source:
FindingSource
Defined in: packages/bitbadgesjs-sdk/src/core/review-types.ts:34
title
title:
Localized
Defined in: packages/bitbadgesjs-sdk/src/core/review-types.ts:38
Short label shown as the finding's headline.