Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Feature request: Expose HackMD comments through the API and MCP

Aperta
#105 0 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
typescript
Ambito
api, cli

Direzione di ricerca

Inizia dai percorsi del codice di hackmd-cli per l’API pubblica, la CLI e le integrazioni MCP, quindi confronta le funzionalità esistenti di note-update con il workflow dei commenti richiesto. Il lavoro è completo quando è possibile elencare e filtrare i commenti, recuperare il loro testo e i relativi ancoraggi, gestire le risposte, risolvere o riaprire i thread e preservare l’identità dei commenti tra gli aggiornamenti delle note.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
TypeScript
Stelle
176
Fork
13
Merge medio
1g 4h
PR unite (30g)
5

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di hackmdio/hackmd-cli

Tutte le issue di hackmdio/hackmd-cli

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.