Skip to content

Add plugin entry: md-comments - #127

Open
yegor-korobeynikov wants to merge 1 commit into
get-bb:mainfrom
yegor-korobeynikov:submit-md-comments
Open

Add plugin entry: md-comments#127
yegor-korobeynikov wants to merge 1 commit into
get-bb:mainfrom
yegor-korobeynikov:submit-md-comments

Conversation

@yegor-korobeynikov

Copy link
Copy Markdown

What the plugin does

Adds inline commenting to markdown files opened in the BB side panel: select a
line, phrase, or word in the rendered document and leave a comment against
that exact passage. Comments are anchored to quoted text (not line numbers),
so they follow their passage across edits instead of drifting to the wrong
paragraph. A single button drops the whole unsent batch into the thread
composer as one structured message for the agent, and the agent can reply
inside each comment's own thread (md_comments_list / md_comments_reply /
md_comments_reanchor RPC tools).

Source release

Plugin checks

  • npm install — clean install, zero private dependencies
  • npx vitest run — 25/25 tests passing
  • npx tsc --noEmit — no type errors
  • bb plugin build — builds dist/ successfully

Marketplace checks

  • npm ci --ignore-scripts && npm run build — entry validates against the schema, dist/marketplace.json built with 83 entries
  • npm run check — release-source liveness check passes

Notes for reviewers

  • No external services, network calls, or elevated permissions beyond the plugin SDK's normal file/RPC surface.
  • Icon uses the host icon name MessageSquare (no vendored icon file) — the plugin has no bespoke artwork of its own.

@SawyerHood

Copy link
Copy Markdown
Contributor

Automated note from a Claude Code agent, posted on behalf of the marketplace maintainer.

Thanks for the submission — we really want to get this in. For the first run of the marketplace we are aiming for a small set of very polished plugins, and we will open it up more broadly soon. Here is what we found reviewing the source at the tag your entry resolves to and installing it from that entry into a dev build of BB 0.40:

Blocker: the plugin does not load on BB 0.40

Installing git:https://github.com/yegor-korobeynikov/bb-plugin-md-comments.git@^1.0.0 into a dev build succeeds, but the plugin immediately goes to error:

md-comments@1.0.0  error
  registerTool: "experimental_statusLabels" was folded into "presentation" (labels) in SDK 0.4.16 (tool "md_comments_reply")

The throw happens inside the plugin factory, so the whole plugin fails — the fileOpener, the panel, and all three agent tools never register.

Fix: switch to presentation: { label: { pending, completed } } (singular label) and re-tag. Your @get-bb/plugin-sdk pin is 0.4.6; the host is on 0.4.26.

Smaller things, worth doing in the same release

  • md_comments_list leaks across projects. With path omitted, server.ts:566-571 runs SELECT * FROM comments ORDER BY created_at DESC LIMIT 100 — the 100 most recent comments from all documents in all projects — and returns their full text to whichever agent called it. The tool is registered globally, so an agent in project A can read review comments you wrote on project B. Please scope it to the calling thread's project, or make path required.
  • Leftover debug RPC. reportLayout (server.ts:407-410) logs panel measurements. Numbers only, no user content, but it looks like instrumentation that did not need to ship.
  • Entry description. The plugin takes over rendering for every .md/.markdown/.mdx in the side panel, replacing BB's built-in preview (app.tsx:630-636). That is the point of the plugin, but the entry should say so.

What we liked

No network calls at all, no child_process, no dangerouslySetInnerHTML, fully parameterized SQL, and the document body renders through the host's own Markdown component rather than a hand-rolled renderer. Anchoring comments to quoted text instead of line numbers is a nice call. The Playwright layout-measurement harnesses in scripts/ are a good sign too.

@SawyerHood SawyerHood left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review (Claude Code agent on behalf of the maintainer): requesting changes per the feedback comment above. Ping here when a new version is published and we will re-check.

@SawyerHood SawyerHood added the blocked Waiting on plugin author changes before it can be listed label Aug 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

blocked Waiting on plugin author changes before it can be listed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants