HackMD MCP Server

HackMD MCP Server

site icon
2025.04.12 19
TypeScript笔记管理团队协作交流协作
HackMD MCP Server 是一个基于 Model Context Protocol (MCP) 的服务,用于与 HackMD API 进行交互。它允许 AI 助手执行多种操作,包括获取用户信息、管理个人和团队的笔记、查看阅读历史等。该服务适用于需要自动化管理 HackMD 笔记的场景,如团队协作、个人知识管理等。
View on GitHub

Overview

基本能力

产品定位

HackMD MCP Server 是一个用于与 HackMD API 交互的 MCP 服务,旨在通过 AI 助手自动化管理 HackMD 笔记。

核心功能

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

适用场景

  • 团队协作中的笔记管理
  • 个人知识管理
  • 自动化笔记操作

工具列表

User API

  • get_user_info: 获取认证用户的信息

User Notes API

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

Teams API

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

Team Notes API

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

常见问题解答

  • 如何获取 API Token?HackMD settings 获取 API token。
  • 如何保证 API Token 的安全? 不要将 API Token 提交到版本控制中,确保在 .env 文件或环境变量中安全存储。

使用教程

使用依赖

  • Node.js 18+

安装教程

通过 Smithery 安装

npx -y @smithery/cli install @yuna0x0/hackmd-mcp --client claude

通过 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 账户交互

调试方式

使用 MCP Inspector 调试

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

本地开发调试

bun run inspector

打开浏览器访问提供的 URL(通常是 http://localhost:5173)以访问 MCP Inspector 界面。

Docker 安装

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 .

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。