HackMD MCP 服务器

这是一个用于与HackMD API交互的模型上下文协议 (MCP) 服务器。它允许 AI 助手执行以下操作：

• 获取用户信息

• 列出用户的注释

• 创建、阅读、更新和删除笔记

• 查看阅读历史记录

• 使用团队笔记

要求

• Node.js 18+

Related MCP server: Appwrite MCP Server

环境变量

• 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"
      }
    }
  }
}

2. 重启Claude桌面

3. 使用工具与您的 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

2. 编辑.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://127.0.0.1:6274 ）以访问 MCP 检查器界面。从那里，您可以：

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文件。