Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Feature request: Expose HackMD comments through the API and MCP

Đang mở
  • Có gì không ổn?
#105 0 bình luận 1 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
typescript
Lĩnh vực
api, cli

Hướng nghiên cứu

Bắt đầu từ các đường dẫn mã của hackmd-cli cho API công khai, CLI và các tích hợp MCP, sau đó so sánh các khả năng note-update hiện có của chúng với quy trình bình luận được yêu cầu. Công việc hoàn tất khi có thể liệt kê và lọc các bình luận, lấy văn bản và anchor của chúng, quản lý các phản hồi, giải quyết hoặc mở lại các thread, đồng thời duy trì danh tính của bình luận qua các lần cập nhật ghi chú.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
TypeScript
Star
176
Fork
13
Merge trung bình
4 giờ 35 phút
Pull request đã merge (30 ngày)
4

Chuẩn bị môi trường

Chúng tôi chưa kiểm tra các tệp thiết lập môi trường của dự án này. Hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của hackmdio/hackmd-cli

Tất cả issue của hackmdio/hackmd-cli

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.