HackMD MCP Server

This is a Model Context Protocol (MCP) server for interacting with the HackMD API. It allows AI assistants to perform operations such as:

• Get user information
• List user's notes
• Create, read, update, and delete notes
• View read history
• Work with team notes

Requirements

• Node.js 18+
• HackMD API token

Installation

Clone the repository and install dependencies:

git clone https://github.com/yuna0x0/hackmd-mcp.git
cd hackmd-mcp
bun install  # or use npm, yarn, pnpm

Configuration

Option 1: Using a .env file

1. Create a .env file by copying the example:

   cp .env.example .env
   

2. Edit the .env file and add your HackMD API token:

   HACKMD_API_TOKEN=your_api_token
   

Option 2: Using environment variables inline

You can also provide the API token directly when running the server:

HACKMD_API_TOKEN=your_api_token bun start

You can get an API token from HackMD settings.

Usage

Start the MCP server

Local installation:

bun start  # or use npm, yarn, pnpm

Using bunx (without cloning):

HACKMD_API_TOKEN=your_api_token bunx hackmd-mcp

Debugging with MCP Inspector

You can use the MCP Inspector to test and debug the HackMD MCP server:

# Using the package.json script
bun run inspector  # or use npm, yarn, pnpm

# Alternative: Direct use with bunx (or npx)
bunx @modelcontextprotocol/inspector -e HACKMD_API_TOKEN=your_api_token bunx hackmd-mcp

Then open your browser to the provided URL (usually http://localhost:5173) to access the MCP Inspector interface. From there, you can:

1. Connect to your running HackMD MCP server
2. Browse available tools
3. Run tools with custom parameters
4. View the responses

This is particularly useful for testing your setup before connecting it to Claude or another AI assistant.

Using with Claude Desktop or other MCP clients

1. Add this server to your claude_desktop_config.json:

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

2. Restart Claude Desktop
3. Use the tools to interact with your HackMD account

Available Tools

User API

• get_user_info: Get information about the authenticated user

User Notes API

• list_user_notes: List all notes owned by the user
• get_note: Get a note by its ID
• create_note: Create a new note
• update_note: Update an existing note
• delete_note: Delete a note
• get_history: Get user's reading history

Teams API

• list_teams: List all teams accessible to the user

Team Notes API

• list_team_notes: List all notes in a team
• create_team_note: Create a new note in a team
• update_team_note: Update an existing note in a team
• delete_team_note: Delete a note in a team

Example Usage in Claude

Can you help me manage my HackMD notes?

Then use commands like:

Please list all my notes.

Security Notice

This MCP server requires your HackMD API token in the .env file or as an environment variable. Keep this information secure and never commit it to version control.

License

This project is licensed under the MIT License - see the LICENSE file for details.