首页
学习
活动
专区
圈层
工具
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往
首页
学习
活动
专区
圈层
工具
MCP广场
MCP广场 >详情页
hackmd-mcp2025-05-300分享
github
一个模型上下文协议服务器,使人工智能助手能够与HackMD API交互以管理笔记,包括创建、读取、更新和删除笔记。
By yuna0x0
2025-05-300
github
详情内容

HackMD MCP 服务器

smithery 徽章

这是一个用于与 HackMD API 交互的模型上下文协议 (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

# 对于其他 MCP 客户端,使用以下命令:
# 列出可用的客户端
npx -y @smithery/cli list 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: 删除团队中的笔记

示例用法

你能帮我管理我的 HackMD 笔记吗?

然后使用如下命令:

请列出我所有的笔记。

本地开发

本项目使用 pnpm 作为包管理器。

克隆仓库并安装依赖:

git clone https://github.com/yuna0x0/hackmd-mcp.git
cd hackmd-mcp
pnpm 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

# 本地开发时使用此命令
pnpm run inspector

然后在浏览器中打开提供的 URL(通常是 http://127.0.0.1:6274)以访问 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 文件。

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档