HackMD MCP Server

Dies ist ein Model Context Protocol (MCP)-Server für die Interaktion mit der HackMD-API . Er ermöglicht KI-Assistenten die Durchführung von Operationen wie:

• Abrufen von Benutzerinformationen

• Notizen des Benutzers auflisten

• Notizen erstellen, lesen, aktualisieren und löschen

• Leseverlauf anzeigen

• Arbeiten mit Teamnotizen

Anforderungen

• Node.js 18+

Related MCP server: MCP Kibela

Umgebungsvariablen

• HACKMD_API_TOKEN : [Erforderlich] Ihr HackMD-API-Token

• HACKMD_API_URL : (Optional) HackMD API-Endpunkt-URL. Standard: https://api.hackmd.io/v1

Sie können ein API-Token aus den HackMD-Einstellungen erhalten.

Auf Claude Desktop (oder anderen MCP-Clients) installieren

Installation über Smithery

So installieren Sie den HackMD MCP-Server für Claude Desktop automatisch über 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>

Installation über mcp-get

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

Manuelle Installation

1. Fügen Sie diesen Server zu Ihrer claude_desktop_config.json hinzu:

{
  "mcpServers": {
    "hackmd": {
      "command": "npx",
      "args": ["-y", "hackmd-mcp"],
      "env": {
        "HACKMD_API_TOKEN": "your_api_token"
      }
    }
  }
}

2. Starten Sie Claude Desktop neu

3. Verwenden Sie die Tools, um mit Ihrem HackMD-Konto zu interagieren

Verfügbare Tools

Benutzer-API

• get_user_info : Informationen über den authentifizierten Benutzer abrufen

Benutzernotizen-API

• list_user_notes : Listet alle Notizen auf, die dem Benutzer gehören

• get_note : Ruft eine Notiz anhand ihrer ID ab

• create_note : Erstelle eine neue Notiz

• update_note : Eine vorhandene Notiz aktualisieren

• delete_note : Löscht eine Notiz

• get_history : Leseverlauf des Benutzers abrufen

Teams-API

• list_teams : Listet alle für den Benutzer zugänglichen Teams auf

Team Notes API

• list_team_notes : Listet alle Notizen in einem Team auf

• create_team_note : Eine neue Notiz in einem Team erstellen

• update_team_note : Aktualisieren Sie eine vorhandene Notiz in einem Team

• delete_team_note : Löscht eine Notiz in einem Team

Beispielverwendung

Can you help me manage my HackMD notes?

Verwenden Sie dann Befehle wie:

Please list all my notes.

Lokale Entwicklung

Dieses Projekt verwendet Bun als Paketmanager. Sie sollten es installieren, falls noch nicht geschehen.

Klonen Sie das Repository und installieren Sie Abhängigkeiten:

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

Konfiguration

1. Erstellen Sie eine .env -Datei, indem Sie das Beispiel kopieren:

cp .env.example .env

2. Bearbeiten Sie die .env Datei und fügen Sie Ihr HackMD-API-Token hinzu:

HACKMD_API_TOKEN=your_api_token

Debuggen mit MCP Inspector

Sie können den MCP Inspector zum Testen und Debuggen des HackMD MCP-Servers verwenden:

npx @modelcontextprotocol/inspector -e HACKMD_API_TOKEN=your_api_token npx hackmd-mcp

# Use this instead when Local Development
bun run inspector

Öffnen Sie anschließend Ihren Browser und öffnen Sie die angegebene URL (normalerweise http://127.0.0.1:6274 ), um auf die MCP Inspector-Oberfläche zuzugreifen. Von dort aus können Sie:

1. Stellen Sie eine Verbindung zu Ihrem laufenden HackMD MCP-Server her

2. Verfügbare Tools durchsuchen

3. Ausführen von Tools mit benutzerdefinierten Parametern

4. Antworten ansehen

Dies ist besonders nützlich, um Ihr Setup zu testen, bevor Sie es mit Claude oder einem anderen KI-Assistenten verbinden.

Docker

Vom Docker Hub abrufen:

docker pull yuna0x0/hackmd-mcp

Docker-Build (lokale Entwicklung):

docker build -t yuna0x0/hackmd-mcp .

Docker-Multiplattform-Build (lokale Entwicklung):

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

Sicherheitshinweis

Dieser MCP-Server benötigt Ihr HackMD-API-Token in der .env-Datei oder als Umgebungsvariable. Bewahren Sie diese Informationen sicher auf und übergeben Sie sie niemals der Versionskontrolle.

Lizenz

Dieses Projekt ist unter der MIT-Lizenz lizenziert – Einzelheiten finden Sie in der Datei LICENSE .