Feature request: Expose HackMD comments through the API and MCP

オープン
#105 コメント 0 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
静か
技術スタック
typescript
領域
api, cli

調査の方向性

public API、CLI、MCP 統合に対応する hackmd-cli のコードパスから始め、既存の note-update 機能と要求されたコメントワークフローを比較します。コメントの一覧表示とフィルタリング、テキストとアンカーの取得、返信の管理、スレッドの解決または再オープンが可能になり、ノートの更新をまたいでコメントの識別情報が保持されれば、作業は完了です。

索引モデルが issue の本文から書いたものです。

説明

I want to use HackMD as the review interface for content stored in Git.

Git is the single source of truth. An automated process updates the HackMD note from the repository, reviewers leave comments in HackMD, and an agent processes those comments into a GitHub pull request.

HackMD currently supports programmatic note updates, but comments are not available through the public API, CLI or MCP.

Desired workflow

  1. Content is pushed from Git to an existing HackMD note.

  2. Reviewers leave paragraph or text-selection comments.

  3. An agent retrieves open comments.

  4. The agent classifies comments as:

    • safe to action automatically;
    • requiring clarification;
    • requiring operator review;
    • not actionable.
  5. The agent applies appropriate changes on a Git branch and creates a pull request.

  6. The operator reviews and merges the pull request.

  7. The merged content is pushed back to HackMD.

  8. Actioned comments are resolved.

  9. Remaining comments stay open for later review.

Required capabilities

Please expose note comments through the public API and HackMD MCP.

The integration needs to:

  • list comments for a note;
  • filter open, resolved or recently updated comments;
  • retrieve comment text, replies, author and timestamps;
  • retrieve selected text and anchor context;
  • identify comments whose anchors are no longer valid;
  • reply to comments;
  • resolve and reopen comment threads.

Incremental retrieval through webhooks or an updatedSince filter would also be useful.

Suggested MCP tools

list_note_comments
get_note_comment
reply_to_note_comment
resolve_note_comment
reopen_note_comment

Key requirement

Updating an existing note must preserve comment identity.

When a comment can no longer be attached to the current text, the API should return it as detached while preserving the original selected text and surrounding context.

Why this matters

This would allow HackMD to remain the human-friendly review surface while Git remains authoritative.

HackMD would manage comments and review context. External systems would manage branches, pull requests, automated changes and approvals.

主要言語
TypeScript
スター
176
フォーク
13
平均マージ
1日 4時間
マージ済み PR(30日)
5

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

hackmdio/hackmd-cli のほかの issue

hackmdio/hackmd-cli の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。