yuna0x0/hackmd-mcp

A Model Context Protocol (MCP) server that interfaces with the HackMD API, allowing LLM clients to access and interact with HackMD notes, teams, user profiles, and history data.
Features
- Get user profile information
- Create, read, update, and delete notes
- Manage team notes and collaborate with team members
- Access reading history
- List and manage teams
- **Dual transport support**: Both HTTP and STDIO transports
- **Cloud deployment ready**: Support Smithery and other platforms
Requirements
- Node.js 18+
Local Installation (STDIO Transport)
1. Add this server to your mcp.json / claude_desktop_config.json:
You may also optionally set the HACKMD_API_URL environment variable if you need to use a different HackMD API endpoint.
2. Restart your MCP client (e.g., Claude Desktop)
3. Use the tools to interact with HackMD
Server Deployment (HTTP Transport)
Self-Hosting
Follow the Local Development instructions to set up the project locally, then run:
This will start the server on port 8081 by default. You can change the port by setting the PORT environment variable.
Cloud Deployment
You can deploy this MCP server to any cloud platform that supports Node.js server applications.
You can also deploy via MCP platforms like Smithery.
Configuration
Environment Variables (STDIO Transport and HTTP Transport server where host provides the config)
When using the STDIO transport or hosting the HTTP transport server, you can pass configuration via environment variables:
- HACKMD_API_TOKEN: HackMD API Token (Required for all operations)
- HACKMD_API_URL: (Optional) HackMD API URL (Defaults to https://api.hackmd.io/v1)
Environment variables applied only for the HTTP transport server:
- ALLOWED_HACKMD_API_URLS: (Optional) A comma-separated list of allowed HackMD API URLs. The server will reject requests if the provide HackMD API URL is not in this list. If not set, only the default URL (https://api.hackmd.io/v1) is allowed.
> [!CAUTION]
> If you are hosting the HTTP transport server with token pre-configured, you should protect your endpoint and implement authentication before allowing users to access it. Otherwise, anyone can access your MCP server while using your HackMD token.
HTTP Headers (HTTP Transport where user provides the config)
When using the HTTP transport, user can pass configuration via HTTP headers:
- Hackmd-Api-Token: HackMD API Token (Required for all operations)
- Hackmd-Api-Url: (Optional) HackMD API URL (Defaults to https://api.hackmd.io/v1)
If the user provides the token in the header, while the server also has HACKMD_API_TOKEN set, the header value will take precedence.
Get a HackMD API Token
To get an API token, follow these steps:
1. Go to HackMD settings.
2. Click on "Create API Token".
3. Copy the generated token and use it in your .env file or environment variables.
Available Tools
Profile Tools
- **get_user_info**: Get information about the authenticated user
Teams Tools
- **list_teams**: List all teams accessible to the user
History Tools