HackMD MCP Server

by yuna0x0
Verified

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

Integrations

  • Provides access to the HackMD API, enabling note management capabilities including creating, reading, updating, and deleting notes, viewing read history, and working with team notes on the HackMD collaborative markdown platform.

Servidor MCP de HackMD

Este es un servidor de Protocolo de Contexto de Modelo (MCP) para interactuar con la API de HackMD . Permite a los asistentes de IA realizar operaciones como:

  • Obtener información del usuario
  • Lista de notas del usuario
  • Crear, leer, actualizar y eliminar notas
  • Ver historial de lectura
  • Trabajar con notas del equipo

Requisitos

  • Node.js 18+

Variables de entorno

  • HACKMD_API_TOKEN : [Obligatorio] Su token de API de HackMD
  • HACKMD_API_URL : (Opcional) URL del punto final de la API de HackMD. Predeterminado: https://api.hackmd.io/v1

Puede obtener un token API desde la configuración de HackMD .

Instalar en Claude Desktop (u otros clientes MCP)

Instalación mediante herrería

Para instalar HackMD MCP Server para Claude Desktop automáticamente a través de Smithery :

npx -y @smithery/cli install @yuna0x0/hackmd-mcp --client claude # For other MCP clients, use the following command: # List available clients npx -y @smithery/cli list clients # Install to other clients npx -y @smithery/cli install @yuna0x0/hackmd-mcp --client <client_name>

Instalación mediante mcp-get

npx @michaellatman/mcp-get@latest install hackmd-mcp

Instalación manual

  1. Agregue este servidor a su claude_desktop_config.json :
{ "mcpServers": { "hackmd": { "command": "npx", "args": ["-y", "hackmd-mcp"], "env": { "HACKMD_API_TOKEN": "your_api_token" } } } }
  1. Reiniciar Claude Desktop
  2. Utilice las herramientas para interactuar con su cuenta de HackMD

Herramientas disponibles

API de usuario

  • get_user_info : Obtener información sobre el usuario autenticado

API de notas de usuario

  • list_user_notes : Lista todas las notas propiedad del usuario
  • get_note : Obtener una nota por su ID
  • create_note : Crea una nueva nota
  • update_note : Actualizar una nota existente
  • delete_note : Eliminar una nota
  • get_history : Obtener el historial de lectura del usuario

API de equipos

  • list_teams : enumera todos los equipos accesibles para el usuario

API de notas del equipo

  • list_team_notes : enumera todas las notas de un equipo
  • create_team_note : Crea una nueva nota en un equipo
  • update_team_note : Actualizar una nota existente en un equipo
  • delete_team_note : Eliminar una nota en un equipo

Ejemplo de uso

Can you help me manage my HackMD notes?

Luego use comandos como:

Please list all my notes.

Desarrollo local

Este proyecto usa Bun como gestor de paquetes. Deberías instalarlo si aún no lo has hecho.

Clonar el repositorio e instalar las dependencias:

git clone https://github.com/yuna0x0/hackmd-mcp.git cd hackmd-mcp bun install

Configuración

  1. Cree un archivo .env copiando el ejemplo:
cp .env.example .env
  1. Edite el archivo .env y agregue su token de API HackMD:
HACKMD_API_TOKEN=your_api_token

Depuración con MCP Inspector

Puede utilizar el Inspector MCP para probar y depurar el servidor MCP de HackMD:

npx @modelcontextprotocol/inspector -e HACKMD_API_TOKEN=your_api_token npx hackmd-mcp # Use this instead when Local Development bun run inspector

A continuación, abra su navegador y acceda a la URL proporcionada (normalmente http://localhost:5173 ) para acceder a la interfaz del Inspector de MCP. Desde allí, podrá:

  1. Conéctese a su servidor HackMD MCP en ejecución
  2. Explorar las herramientas disponibles
  3. Ejecutar herramientas con parámetros personalizados
  4. Ver las respuestas

Esto es particularmente útil para probar su configuración antes de conectarla a Claude u otro asistente de IA.

Estibador

Extraer de Docker Hub:

docker pull yuna0x0/hackmd-mcp

Compilación de Docker (desarrollo local):

docker build -t yuna0x0/hackmd-mcp .

Compilación multiplataforma de Docker (desarrollo local):

docker buildx build --platform linux/amd64,linux/arm64 -t yuna0x0/hackmd-mcp .

Aviso de seguridad

Este servidor MCP requiere su token de API de HackMD en el archivo .env o como variable de entorno. Mantenga esta información segura y nunca la envíe al control de versiones.

Licencia

Este proyecto está licenciado bajo la licencia MIT: consulte el archivo de LICENCIA para obtener más detalles.

You must be authenticated.

A
security – no known vulnerabilities
A
license - permissive license
A
quality - confirmed to work

Un servidor de protocolo de contexto de modelo que permite a los asistentes de IA interactuar con la API de HackMD para administrar notas, incluida la creación, lectura, actualización y eliminación de notas.

  1. Requirements
    1. Environment Variables
      1. Install to Claude Desktop (or other MCP clients)
        1. Installing via Smithery
        2. Installing via mcp-get
        3. Manual Installation
      2. Available Tools
        1. User API
        2. User Notes API
        3. Teams API
        4. Team Notes API
      3. Example Usage
        1. Local Development
          1. Configuration
        2. Debugging with MCP Inspector
          1. Docker
            1. Security Notice
              1. License
                ID: 2lnhpu8zmr