Feature request: Expose HackMD comments through the API and MCP

Abierto
#105 0 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
typescript
Área
api, cli

Línea de trabajo

Comienza en las rutas de código de hackmd-cli para la API pública, la CLI y las integraciones de MCP; después, compara sus capacidades existentes de note-update con el flujo de trabajo de comentarios solicitado. El trabajo estará completo cuando se puedan listar y filtrar los comentarios, recuperar su texto y sus anclajes, gestionar las respuestas, resolver o reabrir los hilos y conservar la identidad de los comentarios entre actualizaciones de notas.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
TypeScript
Estrellas
176
Forks
13
Merge medio
1 d 4 h
PR fusionados (30 d)
5

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de hackmdio/hackmd-cli

Todos los issues de hackmdio/hackmd-cli

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.