HackMD MCP Server

Name: HackMD MCP Server
Author: yuna0x0

@yuna0x0

代码仓库主页

关于 HackMD MCP Server

A Model Context Protocol server for integrating HackMD's note-taking platform with AI assistants.

#api #ai #mcp #hackmd #llm #mcp-server

基本信息

分类

其他

许可证

MIT

运行时

node

传输方式

stdio

发布者

yuna0x0

配置

使用下面的配置,将此服务器添加到你的 MCP 客户端。

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

工具

未检测到工具

工具是从 README 中自动提取的。维护者可以在 ## Tools 标题下列出工具,即可填充这部分内容。

概览

What is HackMD MCP Server?

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 reading history.

How to use HackMD MCP Server?

Install the server by adding it to your MCP client configuration (e.g., mcp.json or claude_desktop_config.json) with the command npx -y hackmd-mcp and setting the environment variable HACKMD_API_TOKEN. You may optionally set HACKMD_API_URL for a different API endpoint. For self‑hosted HTTP transport, run pnpm run start:http (default port 8081, configurable via PORT). Cloud deployment is supported via platforms like Smithery.

Key features of HackMD MCP Server

Retrieve authenticated user profile information
Create, read, update, and delete HackMD notes
Manage team notes and collaborate with team members
Access user reading history and list teams
Dual transport support: HTTP and STDIO
Cloud‑deployment ready (Smithery and others)

Use cases of HackMD MCP Server

Manage and organize personal HackMD notes via an AI assistant
Collaborate on team notes and list team‑accessible notes
Automate note creation from meeting summaries or daily logs
Query reading history to quickly revisit recently viewed notes

FAQ from HackMD MCP Server

How do I get a HackMD API token?

Go to HackMD settings, click “Create API Token”, then copy the generated token. Use it in the HACKMD_API_TOKEN environment variable or in an HTTP header.

What environment variables are required?

HACKMD_API_TOKEN is required for all operations. HACKMD_API_URL is optional (defaults to https://api.hackmd.io/v1). For HTTP transport servers, you may also set ALLOWED_HACKMD_API_URLS to restrict allowed API URLs.

What transports does the server support?

The server supports both STDIO transport (for local MCP clients) and HTTP transport (for self‑hosted or cloud deployments). The HTTP server listens on port 8081 by default.

What are the system requirements?

Node.js 18 or later is required. The server can also be run via Docker from ghcr.io/yuna0x0/hackmd-mcp.

How is the API token kept secure?

The token is accepted via environment variable, .env file, or HTTP header. The README warns not to commit it to version control and to protect the HTTP endpoint with authentication if hosting it publicly.