HackMD MCP 服务器

这是一个用于与 HackMD API 交互的 Model Context Protocol (MCP) 服务器。它允许 AI 助手执行以下操作：

• 获取用户信息
• 列出用户的笔记
• 创建、读取、更新和删除笔记
• 查看阅读历史
• 处理团队笔记

要求

• Node.js 18+

环境变量

• HACKMD_API_TOKEN: [必需] 您的 HackMD API 令牌
• HACKMD_API_URL: （可选）HackMD API 端点 URL。默认：https://api.hackmd.io/v1

您可以从 HackMD 设置 中获取 API 令牌。

安装到 Claude Desktop（或其他 MCP 客户端）

通过 Smithery 安装

要通过 Smithery 自动为 Claude Desktop 安装 HackMD MCP 服务器：

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>

通过 mcp-get 安装

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

手动安装

1. 将此服务器添加到您的 claude_desktop_config.json 中：

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

1. 重启 Claude Desktop
2. 使用工具与您的 HackMD 账户进行交互

可用工具

用户 API

• get_user_info: 获取已验证用户的信息

用户笔记 API

• list_user_notes: 列出用户拥有的所有笔记
• get_note: 根据 ID 获取笔记
• create_note: 创建新笔记
• update_note: 更新现有笔记
• delete_note: 删除笔记
• get_history: 获取用户的阅读历史

团队 API

• list_teams: 列出用户可以访问的所有团队

团队笔记 API

• list_team_notes: 列出团队中的所有笔记
• create_team_note: 在团队中创建新笔记
• update_team_note: 更新团队中的现有笔记
• delete_team_note: 删除团队中的笔记

示例用法

Can you help me manage my HackMD notes?

然后使用如下命令：

Please list all my notes.

本地开发

此项目使用 Bun 作为其包管理器。如果您尚未安装，请先安装它。

克隆仓库并安装依赖项：

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

配置

1. 通过复制示例创建 .env 文件：

cp .env.example .env

1. 编辑 .env 文件并添加您的 HackMD API 令牌：

HACKMD_API_TOKEN=your_api_token

使用 MCP Inspector 进行调试

您可以使用 MCP Inspector 来测试和调试 HackMD MCP 服务器：

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

# Use this instead when Local Development
bun run inspector

然后在浏览器中打开提供的 URL（通常是 http://localhost:5173）以访问 MCP Inspector 界面。在那里，您可以：

1. 连接到正在运行的 HackMD MCP 服务器
2. 浏览可用工具
3. 使用自定义参数运行工具
4. 查看响应

这对于在连接到 Claude 或其他 AI 助手之前测试您的设置特别有用。

Docker

从 Docker Hub 拉取：

docker pull yuna0x0/hackmd-mcp

Docker 构建（本地开发）：

docker build -t yuna0x0/hackmd-mcp .

Docker 多平台构建（本地开发）：

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

安全通知

此MCP服务器需要在.env文件中或作为环境变量提供您的HackMD API令牌。请确保此信息的安全，切勿将其提交到版本控制系统。

许可证

本项目根据MIT许可证发布 - 详情请参阅LICENSE文件。