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+
Environment Variables
HACKMD_API_TOKEN: [Required] Your HackMD API token
HACKMD_API_URL: (Optional) HackMD API Endpoint URL. Default:https://api.hackmd.io/v1
You can get an API token from HackMD settings.
Install to Claude Desktop (or other MCP clients)
Installing via Smithery
To install HackMD MCP Server for Claude Desktop automatically via Smithery:
Installing via mcp-get
Manual Installation
- Add this server to your
claude_desktop_config.json:
- Restart Claude Desktop
- 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
Then use commands like:
Local Development
This project uses Bun as its package manager. You should install it if you haven't already.
Clone the repository and install dependencies:
Configuration
- Create a
.envfile by copying the example:
- Edit the
.envfile and add your HackMD API token:
Debugging with MCP Inspector
You can use the MCP Inspector to test and debug the HackMD MCP server:
Then open your browser to the provided URL (usually http://127.0.0.1:6274) to access the MCP Inspector interface. From there, you can:
- Connect to your running HackMD MCP server
- Browse available tools
- Run tools with custom parameters
- View the responses
This is particularly useful for testing your setup before connecting it to Claude or another AI assistant.
Docker
Pull from Docker Hub:
Docker build (Local Development):
Docker multi-platform build (Local Development):
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.
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+
Environment Variables
HACKMD_API_TOKEN: [Required] Your HackMD API token
HACKMD_API_URL: (Optional) HackMD API Endpoint URL. Default:https://api.hackmd.io/v1
You can get an API token from HackMD settings.
Install to Claude Desktop (or other MCP clients)
Installing via Smithery
To install HackMD MCP Server for Claude Desktop automatically via Smithery:
Installing via mcp-get
Manual Installation
- Add this server to your
claude_desktop_config.json:
- Restart Claude Desktop
- 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
Then use commands like:
Local Development
This project uses Bun as its package manager. You should install it if you haven't already.
Clone the repository and install dependencies:
Configuration
- Create a
.envfile by copying the example:
- Edit the
.envfile and add your HackMD API token:
Debugging with MCP Inspector
You can use the MCP Inspector to test and debug the HackMD MCP server:
Then open your browser to the provided URL (usually http://127.0.0.1:6274) to access the MCP Inspector interface. From there, you can:
- Connect to your running HackMD MCP server
- Browse available tools
- Run tools with custom parameters
- View the responses
This is particularly useful for testing your setup before connecting it to Claude or another AI assistant.
Docker
Pull from Docker Hub:
Docker build (Local Development):
Docker multi-platform build (Local Development):
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.