Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Feature request: Expose HackMD comments through the API and MCP

未关闭
#105 0 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
冷清
技术栈
typescript
领域
api, cli

调研方向

从 hackmd-cli 中面向公共 API、CLI 和 MCP 集成的代码路径入手,然后将它们现有的 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
平均合并
4 小时 35 分钟
30 天内合并 PR
4

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

hackmdio/hackmd-cli 的其他 Issue

查看 hackmdio/hackmd-cli 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。